Macros
#define	orxVIEWPORT_KU32_FLAG_ALIGN_BOTTOM 0x80000000
#define	orxVIEWPORT_KU32_FLAG_ALIGN_CENTER 0x00000000
#define	orxVIEWPORT_KU32_FLAG_ALIGN_LEFT 0x10000000
#define	orxVIEWPORT_KU32_FLAG_ALIGN_RIGHT 0x20000000
#define	orxVIEWPORT_KU32_FLAG_ALIGN_TOP 0x40000000
#define	orxVIEWPORT_KU32_FLAG_NO_DEBUG 0x01000000
#define	orxVIEWPORT_KU32_MAX_TEXTURE_NUMBER 8

Typedefs
typedef struct __orxVIEWPORT_t	orxVIEWPORT

Enumerations
enum	orxVIEWPORT_EVENT { orxVIEWPORT_EVENT_RESIZE = 0 , orxVIEWPORT_EVENT_NUMBER , orxVIEWPORT_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_ClearBackgroundColor (orxVIEWPORT *_pstViewport)
orxDLLAPI orxVIEWPORT *orxFASTCALL	orxViewport_Create ()
orxDLLAPI orxVIEWPORT *orxFASTCALL	orxViewport_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_Delete (orxVIEWPORT *_pstViewport)
orxDLLAPI void orxFASTCALL	orxViewport_Enable (orxVIEWPORT *_pstViewport, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxViewport_EnableShader (orxVIEWPORT *_pstViewport, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxViewport_Exit ()
orxDLLAPI orxVIEWPORT *orxFASTCALL	orxViewport_Get (const orxSTRING _zName)
orxDLLAPI orxCOLOR *orxFASTCALL	orxViewport_GetBackgroundColor (const orxVIEWPORT _pstViewport, orxCOLOR _pstColor)
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL	orxViewport_GetBlendMode (const orxVIEWPORT *_pstViewport)
orxDLLAPI orxAABOX *orxFASTCALL	orxViewport_GetBox (const orxVIEWPORT _pstViewport, orxAABOX _pstBox)
orxDLLAPI orxCAMERA *orxFASTCALL	orxViewport_GetCamera (const orxVIEWPORT *_pstViewport)
orxDLLAPI orxFLOAT orxFASTCALL	orxViewport_GetCorrectionRatio (const orxVIEWPORT *_pstViewport)
orxDLLAPI const orxSTRING orxFASTCALL	orxViewport_GetName (const orxVIEWPORT *_pstViewport)
orxDLLAPI void orxFASTCALL	orxViewport_GetPosition (const orxVIEWPORT _pstViewport, orxFLOAT _pfX, orxFLOAT *_pfY)
orxDLLAPI void orxFASTCALL	orxViewport_GetRelativeSize (const orxVIEWPORT _pstViewport, orxFLOAT _pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI const orxSHADER *orxFASTCALL	orxViewport_GetShader (const orxVIEWPORT *_pstViewport)
orxDLLAPI void orxFASTCALL	orxViewport_GetSize (const orxVIEWPORT _pstViewport, orxFLOAT _pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI orxU32 orxFASTCALL	orxViewport_GetTextureCount (const orxVIEWPORT *_pstViewport)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_GetTextureList (const orxVIEWPORT _pstViewport, orxU32 _u32TextureNumber, orxTEXTURE *_apstTextureList)
orxDLLAPI orxBOOL orxFASTCALL	orxViewport_HasBackgroundColor (const orxVIEWPORT *_pstViewport)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxViewport_IsEnabled (const orxVIEWPORT *_pstViewport)
orxDLLAPI orxBOOL orxFASTCALL	orxViewport_IsShaderEnabled (const orxVIEWPORT *_pstViewport)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetBackgroundColor (orxVIEWPORT _pstViewport, const orxCOLOR _pstColor)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetBlendMode (orxVIEWPORT *_pstViewport, orxDISPLAY_BLEND_MODE _eBlendMode)
orxDLLAPI void orxFASTCALL	orxViewport_SetCamera (orxVIEWPORT _pstViewport, orxCAMERA _pstCamera)
orxDLLAPI void orxFASTCALL	orxViewport_SetPosition (orxVIEWPORT *_pstViewport, orxFLOAT _fX, orxFLOAT _fY)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetRelativePosition (orxVIEWPORT *_pstViewport, orxU32 _u32AlignFlags)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetRelativeSize (orxVIEWPORT *_pstViewport, orxFLOAT _fWidth, orxFLOAT _fHeight)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetShader (orxVIEWPORT _pstViewport, orxSHADER _pstShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetShaderFromConfig (orxVIEWPORT *_pstViewport, const orxSTRING _zShaderID)
orxDLLAPI void orxFASTCALL	orxViewport_SetSize (orxVIEWPORT *_pstViewport, orxFLOAT _fWidth, orxFLOAT _fHeight)
orxDLLAPI void orxFASTCALL	orxViewport_SetTextureList (orxVIEWPORT _pstViewport, orxU32 _u32TextureNumber, orxTEXTURE *_apstTextureList)
orxDLLAPI void orxFASTCALL	orxViewport_Setup ()

Detailed Description

Viewport module Allows to creates and handle viewports. Viewports are structures associated to cameras and used for rendering.

Macro Definition Documentation

◆ orxVIEWPORT_KU32_FLAG_ALIGN_BOTTOM

#define orxVIEWPORT_KU32_FLAG_ALIGN_BOTTOM 0x80000000

Bottom vertical alignment

Definition at line 61 of file orxViewport.h.

◆ orxVIEWPORT_KU32_FLAG_ALIGN_CENTER

#define orxVIEWPORT_KU32_FLAG_ALIGN_CENTER 0x00000000

Viewport flags Center vertical / horizontal alignment

Definition at line 57 of file orxViewport.h.

◆ orxVIEWPORT_KU32_FLAG_ALIGN_LEFT

#define orxVIEWPORT_KU32_FLAG_ALIGN_LEFT 0x10000000

Left horizontal alignment

Definition at line 58 of file orxViewport.h.

◆ orxVIEWPORT_KU32_FLAG_ALIGN_RIGHT

#define orxVIEWPORT_KU32_FLAG_ALIGN_RIGHT 0x20000000

Right horizontal alignment

Definition at line 59 of file orxViewport.h.

◆ orxVIEWPORT_KU32_FLAG_ALIGN_TOP

#define orxVIEWPORT_KU32_FLAG_ALIGN_TOP 0x40000000

Top vertical alignment

Definition at line 60 of file orxViewport.h.

◆ orxVIEWPORT_KU32_FLAG_NO_DEBUG

#define orxVIEWPORT_KU32_FLAG_NO_DEBUG 0x01000000

No debug flag

Definition at line 62 of file orxViewport.h.

◆ orxVIEWPORT_KU32_MAX_TEXTURE_NUMBER

#define orxVIEWPORT_KU32_MAX_TEXTURE_NUMBER 8

Misc defined

Definition at line 67 of file orxViewport.h.

Typedef Documentation

◆ orxVIEWPORT

typedef struct __orxVIEWPORT_t orxVIEWPORT

Internal Viewport structure

Definition at line 71 of file orxViewport.h.

Enumeration Type Documentation

◆ orxVIEWPORT_EVENT

enum orxVIEWPORT_EVENT

Event enum

Enumerator
orxVIEWPORT_EVENT_RESIZE	Event sent when a viewport has been resized
orxVIEWPORT_EVENT_NUMBER
orxVIEWPORT_EVENT_NONE

Definition at line 76 of file orxViewport.h.

Function Documentation

◆ orxViewport_ClearBackgroundColor()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_ClearBackgroundColor ( orxVIEWPORT * _pstViewport )

extern

Clears viewport background color

Parameters

[in] _pstViewport Concerned viewport

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_Create()

orxDLLAPI orxVIEWPORT *orxFASTCALL orxViewport_Create ( )

extern

Creates a viewport

Returns: Created orxVIEWPORT / orxNULL

◆ orxViewport_CreateFromConfig()

orxDLLAPI orxVIEWPORT *orxFASTCALL orxViewport_CreateFromConfig ( const orxSTRING _zConfigID )

extern

Creates a viewport from config

Parameters

[in] _zConfigID Config ID @ return orxVIEWPORT / orxNULL

◆ orxViewport_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_Delete ( orxVIEWPORT * _pstViewport )

extern

Deletes a viewport

Parameters

[in] _pstViewport Viewport to delete

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_Enable()

orxDLLAPI void orxFASTCALL orxViewport_Enable	(	orxVIEWPORT *	_pstViewport,
		orxBOOL	_bEnable )

extern

Enables / disables a viewport

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_bEnable	Enable / disable

◆ orxViewport_EnableShader()

orxDLLAPI void orxFASTCALL orxViewport_EnableShader	(	orxVIEWPORT *	_pstViewport,
		orxBOOL	_bEnable )

extern

Enables a viewport's shader

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_bEnable	Enable / disable

◆ orxViewport_Exit()

orxDLLAPI void orxFASTCALL orxViewport_Exit ( )

extern

Exits from the viewport module

◆ orxViewport_Get()

orxDLLAPI orxVIEWPORT *orxFASTCALL orxViewport_Get ( const orxSTRING _zName )

extern

Gets viewport given its name

Parameters

[in] _zName Camera name

Returns: orxVIEWPORT / orxNULL

◆ orxViewport_GetBackgroundColor()

orxDLLAPI orxCOLOR *orxFASTCALL orxViewport_GetBackgroundColor	(	const orxVIEWPORT *	_pstViewport,
		orxCOLOR *	_pstColor )

extern

Gets a viewport background color

Parameters

[in]	_pstViewport	Concerned viewport
[out]	_pstColor	Viewport's color

Returns: Current background color

◆ orxViewport_GetBlendMode()

orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxViewport_GetBlendMode ( const orxVIEWPORT * _pstViewport )

extern

Gets a viewport blend mode

Parameters

[in] _pstViewport Concerned viewport

Returns: orxDISPLAY_BLEND_MODE

◆ orxViewport_GetBox()

orxDLLAPI orxAABOX *orxFASTCALL orxViewport_GetBox	(	const orxVIEWPORT *	_pstViewport,
		orxAABOX *	_pstBox )

extern

Gets an axis aligned box of viewport

Parameters

[in]	_pstViewport	Concerned viewport
[out]	_pstBox	Output box

Returns: orxAABOX / orxNULL

◆ orxViewport_GetCamera()

orxDLLAPI orxCAMERA *orxFASTCALL orxViewport_GetCamera ( const orxVIEWPORT * _pstViewport )

extern

Gets a viewport camera

Parameters

[in] _pstViewport Concerned viewport

Returns: Associated camera / orxNULL

◆ orxViewport_GetCorrectionRatio()

orxDLLAPI orxFLOAT orxFASTCALL orxViewport_GetCorrectionRatio ( const orxVIEWPORT * _pstViewport )

extern

Get viewport correction ratio

Parameters

[in] _pstViewport Concerned viewport

Returns: Correction ratio value

◆ orxViewport_GetName()

orxDLLAPI const orxSTRING orxFASTCALL orxViewport_GetName ( const orxVIEWPORT * _pstViewport )

extern

Gets viewport config name

Parameters

[in] _pstViewport Concerned viewport

Returns: orxSTRING / orxSTRING_EMPTY

◆ orxViewport_GetPosition()

orxDLLAPI void orxFASTCALL orxViewport_GetPosition	(	const orxVIEWPORT *	_pstViewport,
		orxFLOAT *	_pfX,
		orxFLOAT *	_pfY )

extern

Gets a viewport position

Parameters

[in]	_pstViewport	Concerned viewport
[out]	_pfX	X axis position (top left corner)
[out]	_pfY	Y axis position (top left corner)

◆ orxViewport_GetRelativeSize()

orxDLLAPI void orxFASTCALL orxViewport_GetRelativeSize	(	const orxVIEWPORT *	_pstViewport,
		orxFLOAT *	_pfWidth,
		orxFLOAT *	_pfHeight )

extern

Gets a viewport relative size

Parameters

[in]	_pstViewport	Concerned viewport
[out]	_pfWidth	Relative width
[out]	_pfHeight	Relative height

◆ orxViewport_GetShader()

orxDLLAPI const orxSHADER *orxFASTCALL orxViewport_GetShader ( const orxVIEWPORT * _pstViewport )

extern

Gets a viewport's shader

Parameters

[in] _pstViewport Concerned viewport

Returns: orxSHADER / orxNULL

◆ orxViewport_GetSize()

orxDLLAPI void orxFASTCALL orxViewport_GetSize	(	const orxVIEWPORT *	_pstViewport,
		orxFLOAT *	_pfWidth,
		orxFLOAT *	_pfHeight )

extern

Gets a viewport size

Parameters

[in]	_pstViewport	Concerned viewport
[out]	_pfWidth	Width
[out]	_pfHeight	Height

◆ orxViewport_GetTextureCount()

orxDLLAPI orxU32 orxFASTCALL orxViewport_GetTextureCount ( const orxVIEWPORT * _pstViewport )

extern

Gets a viewport texture count

Parameters

[in] _pstViewport Concerned viewport

Returns: Number of textures associated with the viewport

◆ orxViewport_GetTextureList()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_GetTextureList	(	const orxVIEWPORT *	_pstViewport,
		orxU32	_u32TextureNumber,
		orxTEXTURE **	_apstTextureList )

extern

Gets a viewport texture list

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_u32TextureNumber	Number of textures to be retrieved
[out]	_apstTextureList	List of textures associated with the viewport

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_HasBackgroundColor()

orxDLLAPI orxBOOL orxFASTCALL orxViewport_HasBackgroundColor ( const orxVIEWPORT * _pstViewport )

extern

Viewport has background color accessor

Parameters

[in] _pstViewport Concerned viewport

Returns: orxTRUE / orxFALSE

◆ orxViewport_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_Init ( )

extern

Inits the viewport module

◆ orxViewport_IsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxViewport_IsEnabled ( const orxVIEWPORT * _pstViewport )

extern

Is a viewport enabled?

Parameters

[in] _pstViewport Concerned viewport

Returns: orxTRUE / orxFALSE

◆ orxViewport_IsShaderEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxViewport_IsShaderEnabled ( const orxVIEWPORT * _pstViewport )

extern

Is a viewport's shader enabled?

Parameters

[in] _pstViewport Concerned viewport

Returns: orxTRUE if enabled, orxFALSE otherwise

◆ orxViewport_SetBackgroundColor()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_SetBackgroundColor	(	orxVIEWPORT *	_pstViewport,
		const orxCOLOR *	_pstColor )

extern

Sets a viewport background color

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_pstColor	Color to use for background

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_SetBlendMode()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_SetBlendMode	(	orxVIEWPORT *	_pstViewport,
		orxDISPLAY_BLEND_MODE	_eBlendMode )

extern

Sets a viewport blend mode (only used when has active shaders attached)

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_eBlendMode	Blend mode to set

◆ orxViewport_SetCamera()

orxDLLAPI void orxFASTCALL orxViewport_SetCamera	(	orxVIEWPORT *	_pstViewport,
		orxCAMERA *	_pstCamera )

extern

Sets a viewport camera

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_pstCamera	Associated camera

◆ orxViewport_SetPosition()

orxDLLAPI void orxFASTCALL orxViewport_SetPosition	(	orxVIEWPORT *	_pstViewport,
		orxFLOAT	_fX,
		orxFLOAT	_fY )

extern

Sets a viewport position

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_fX	X axis position (top left corner)
[in]	_fY	Y axis position (top left corner)

◆ orxViewport_SetRelativePosition()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_SetRelativePosition	(	orxVIEWPORT *	_pstViewport,
		orxU32	_u32AlignFlags )

extern

Sets a viewport relative position

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_u32AlignFlags	Alignment flags

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_SetRelativeSize()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_SetRelativeSize	(	orxVIEWPORT *	_pstViewport,
		orxFLOAT	_fWidth,
		orxFLOAT	_fHeight )

extern

Sets a viewport relative size

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_fWidth	Relative width (0.0f - 1.0f)
[in]	_fHeight	Relative height (0.0f - 1.0f)

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_SetShader()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_SetShader	(	orxVIEWPORT *	_pstViewport,
		orxSHADER *	_pstShader )

extern

Sets a viewport shader

Parameters

[in]	_pstViewport	Concerned Viewport
[in]	_pstShader	Shader to set, orxNULL to remove the current one

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_SetShaderFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_SetShaderFromConfig	(	orxVIEWPORT *	_pstViewport,
		const orxSTRING	_zShaderID )

extern

Sets a viewport shader using its config ID

Parameters

[in]	_pstViewport	Concerned Viewport
[in]	_zShaderID	Config ID of the shader to set, orxNULL to remove the current one

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxViewport_SetSize()

orxDLLAPI void orxFASTCALL orxViewport_SetSize	(	orxVIEWPORT *	_pstViewport,
		orxFLOAT	_fWidth,
		orxFLOAT	_fHeight )

extern

Sets a viewport size

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_fWidth	Width
[in]	_fHeight	Height

◆ orxViewport_SetTextureList()

orxDLLAPI void orxFASTCALL orxViewport_SetTextureList	(	orxVIEWPORT *	_pstViewport,
		orxU32	_u32TextureNumber,
		orxTEXTURE **	_apstTextureList )

extern

Sets a viewport texture list

Parameters

[in]	_pstViewport	Concerned viewport
[in]	_u32TextureNumber	Number of textures to associate with the viewport
[in]	_apstTextureList	List of textures to associate with the viewport

◆ orxViewport_Setup()

orxDLLAPI void orxFASTCALL orxViewport_Setup ( )

extern

Viewport module setup

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ orxVIEWPORT_KU32_FLAG_ALIGN_BOTTOM

◆ orxVIEWPORT_KU32_FLAG_ALIGN_CENTER

◆ orxVIEWPORT_KU32_FLAG_ALIGN_LEFT

◆ orxVIEWPORT_KU32_FLAG_ALIGN_RIGHT

◆ orxVIEWPORT_KU32_FLAG_ALIGN_TOP

◆ orxVIEWPORT_KU32_FLAG_NO_DEBUG

◆ orxVIEWPORT_KU32_MAX_TEXTURE_NUMBER

Typedef Documentation

◆ orxVIEWPORT

Enumeration Type Documentation

◆ orxVIEWPORT_EVENT

Function Documentation

◆ orxViewport_ClearBackgroundColor()

◆ orxViewport_Create()

◆ orxViewport_CreateFromConfig()

◆ orxViewport_Delete()

◆ orxViewport_Enable()

◆ orxViewport_EnableShader()

◆ orxViewport_Exit()

◆ orxViewport_Get()

◆ orxViewport_GetBackgroundColor()

◆ orxViewport_GetBlendMode()

◆ orxViewport_GetBox()

◆ orxViewport_GetCamera()

◆ orxViewport_GetCorrectionRatio()

◆ orxViewport_GetName()

◆ orxViewport_GetPosition()

◆ orxViewport_GetRelativeSize()

◆ orxViewport_GetShader()

◆ orxViewport_GetSize()

◆ orxViewport_GetTextureCount()

◆ orxViewport_GetTextureList()

◆ orxViewport_HasBackgroundColor()

◆ orxViewport_Init()

◆ orxViewport_IsEnabled()

◆ orxViewport_IsShaderEnabled()

◆ orxViewport_SetBackgroundColor()

◆ orxViewport_SetBlendMode()

◆ orxViewport_SetCamera()

◆ orxViewport_SetPosition()

◆ orxViewport_SetRelativePosition()

◆ orxViewport_SetRelativeSize()

◆ orxViewport_SetShader()

◆ orxViewport_SetShaderFromConfig()

◆ orxViewport_SetSize()

◆ orxViewport_SetTextureList()

◆ orxViewport_Setup()