game_hw_rendering_properties Struct Reference

Hardware rendering properties More...

#include <game.h>

Public Attributes
GAME_HW_CONTEXT_TYPE	context_type
	The API to use.
bool	depth
	Set to true if render buffers should have a depth component attached.
bool	stencil
	Set to true if stencil buffers should be attached.
bool	bottom_left_origin
	Use the conventional bottom-left origin.
unsigned int	version_major
	Major version number for the core GL context or GLES 3.1+.
unsigned int	version_minor
	Minor version number for the core GL context or GLES 3.1+.
bool	cache_context
	If true, the frontend will go to great lengths to avoid resetting the context in scenarios like toggling fullscreen, etc.
bool	debug_context
	Creates a debug context.

Detailed Description

Hardware rendering properties

These properties are needed early on, so instead of passing them when the stream is opened, they are passed in EnableHardwareRendering(). As a result, the struct passed to OpenStream() is empty.

Member Data Documentation

bottom_left_origin

bool game_hw_rendering_properties::bottom_left_origin

Use the conventional bottom-left origin.

If false, standard top-left origin semantics are used.

Todo:

: Move to GL specific interface

cache_context

bool game_hw_rendering_properties::cache_context

If true, the frontend will go to great lengths to avoid resetting the context in scenarios like toggling fullscreen, etc.

Todo:

: Obsolete? Maybe frontend should just always assume this...

The reset callback might still be called in extreme situations such as if the context is lost beyond recovery.

For optimal stability, set this to false, and allow context to be reset at any time.

context_type

GAME_HW_CONTEXT_TYPE game_hw_rendering_properties::context_type

The API to use.

debug_context

bool game_hw_rendering_properties::debug_context

Creates a debug context.

depth

bool game_hw_rendering_properties::depth

Set to true if render buffers should have a depth component attached.

Todo:

: Obsolete

stencil

bool game_hw_rendering_properties::stencil

Set to true if stencil buffers should be attached.

If depth and stencil are true, a packed 24/8 buffer will be added. Only attaching stencil is invalid and will be ignored.

Todo:

: Obsolete

version_major

unsigned int game_hw_rendering_properties::version_major

Major version number for the core GL context or GLES 3.1+.

version_minor

unsigned int game_hw_rendering_properties::version_minor

Minor version number for the core GL context or GLES 3.1+.

---

The documentation for this struct was generated from the following file:

• c-api/addon-instance/Game.h