Defines
#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
Typedefs
typedef struct __orxVIEWPORT_t	orxVIEWPORT
Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_AddShader (orxVIEWPORT *_pstViewport, const orxSTRING _zShaderConfigID)
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 orxCOLOR *orxFASTCALL	orxViewport_GetBackgroundColor (const orxVIEWPORT _pstViewport, orxCOLOR _pstColor)
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 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 orxSHADERPOINTER *orxFASTCALL	orxViewport_GetShaderPointer (const orxVIEWPORT *_pstViewport)
orxDLLAPI void orxFASTCALL	orxViewport_GetSize (const orxVIEWPORT _pstViewport, orxFLOAT _pfWidth, orxFLOAT *_pfHeight)
orxDLLAPI orxTEXTURE *orxFASTCALL	orxViewport_GetTexture (const orxVIEWPORT *_pstViewport)
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_RemoveShader (orxVIEWPORT *_pstViewport, const orxSTRING _zShaderConfigID)
orxDLLAPI void orxFASTCALL	orxViewport_SetAlignment (orxVIEWPORT *_pstViewport, orxU32 _u32AlignFlags)
orxDLLAPI orxSTATUS orxFASTCALL	orxViewport_SetBackgroundColor (orxVIEWPORT _pstViewport, const orxCOLOR _pstColor)
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 void orxFASTCALL	orxViewport_SetSize (orxVIEWPORT *_pstViewport, orxFLOAT _fWidth, orxFLOAT _fHeight)
orxDLLAPI void orxFASTCALL	orxViewport_SetTexture (orxVIEWPORT _pstViewport, orxTEXTURE _pstTexture)
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.

Define Documentation

#define orxVIEWPORT_KU32_FLAG_ALIGN_BOTTOM 0x80000000

Bottom vertical alignment

Definition at line 60 of file orxViewport.h.

#define orxVIEWPORT_KU32_FLAG_ALIGN_CENTER 0x00000000

Viewport flags Center vertical / horizontal alignment

Definition at line 56 of file orxViewport.h.

#define orxVIEWPORT_KU32_FLAG_ALIGN_LEFT 0x10000000

Left horizontal alignment

Definition at line 57 of file orxViewport.h.

#define orxVIEWPORT_KU32_FLAG_ALIGN_RIGHT 0x20000000

Right horizontal alignment

Definition at line 58 of file orxViewport.h.

#define orxVIEWPORT_KU32_FLAG_ALIGN_TOP 0x40000000

Top vertical alignment

Definition at line 59 of file orxViewport.h.

Typedef Documentation

typedef struct __orxVIEWPORT_t orxVIEWPORT

Internal Viewport structure

Definition at line 64 of file orxViewport.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_AddShader	(	orxVIEWPORT *	_pstViewport,
		const orxSTRING	_zShaderConfigID
	)

Adds a shader to a viewport using its config ID

Parameters:

[in]	_pstViewport	Concerned viewport
[in]	_zShaderConfigID	Config ID of the shader to add

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_ClearBackgroundColor ( orxVIEWPORT * _pstViewport )

Clears viewport background color

Parameters:

[in] _pstViewport Concerned viewport

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxVIEWPORT* orxFASTCALL orxViewport_Create ( )

Creates a viewport

Returns:: Created orxVIEWPORT / orxNULL

orxDLLAPI orxVIEWPORT* orxFASTCALL orxViewport_CreateFromConfig ( const orxSTRING _zConfigID )

Creates a viewport from config

Parameters:

[in] _zConfigID Config ID @ return orxVIEWPORT / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_Delete ( orxVIEWPORT * _pstViewport )

Deletes a viewport

Parameters:

[in] _pstViewport Viewport to delete

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Enables / disables a viewport

Parameters:

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

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

Enables a viewport's shader

Parameters:

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

orxDLLAPI void orxFASTCALL orxViewport_Exit ( )

Exits from the viewport module

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

Gets a viewport background color

Parameters:

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

Returns:: Current background color

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

Gets an axis aligned box of viewport

Parameters:

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

Returns:: orxAABOX / orxNULL

orxDLLAPI orxCAMERA* orxFASTCALL orxViewport_GetCamera ( const orxVIEWPORT * _pstViewport )

Gets a viewport camera

Parameters:

[in] _pstViewport Concerned viewport

Returns:: Associated camera / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxViewport_GetCorrectionRatio ( const orxVIEWPORT * _pstViewport )

Get viewport correction ratio

Parameters:

[in] _pstViewport Concerned viewport

Returns:: Correction ratio value

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

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)

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

Gets a viewport relative size

Parameters:

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

orxDLLAPI const orxSHADERPOINTER* orxFASTCALL orxViewport_GetShaderPointer ( const orxVIEWPORT * _pstViewport )

Gets a viewport's shader pointer

Parameters:

[in] _pstViewport Concerned viewport

Returns:: orxSHADERPOINTER / orxNULL

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

Gets a viewport size

Parameters:

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

orxDLLAPI orxTEXTURE* orxFASTCALL orxViewport_GetTexture ( const orxVIEWPORT * _pstViewport )

Gets a viewport texture

Parameters:

[in] _pstViewport Concerned viewport

Returns:: Associated orxTEXTURE / orxNULL

orxDLLAPI orxBOOL orxFASTCALL orxViewport_HasBackgroundColor ( const orxVIEWPORT * _pstViewport )

Viewport has background color accessor

Parameters:

[in] _pstViewport Concerned viewport

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_Init ( )

Inits the viewport module

orxDLLAPI orxBOOL orxFASTCALL orxViewport_IsEnabled ( const orxVIEWPORT * _pstViewport )

Is a viewport enabled?

Parameters:

[in] _pstViewport Concerned viewport

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxViewport_IsShaderEnabled ( const orxVIEWPORT * _pstViewport )

Is a viewport's shader enabled?

Parameters:

[in] _pstViewport Concerned viewport

Returns:: orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxViewport_RemoveShader	(	orxVIEWPORT *	_pstViewport,
		const orxSTRING	_zShaderConfigID
	)

Removes a shader using using its config ID

Parameters:

[in]	_pstViewport	Concerned viewport
[in]	_zShaderConfigID	Config ID of the shader to remove

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxViewport_SetAlignment	(	orxVIEWPORT *	_pstViewport,
		orxU32	_u32AlignFlags
	)

Sets a viewport alignment

Parameters:

[in]	_pstViewport	Concerned viewport
[in]	_u32AlignFlags	Alignment flags (must be OR'ed)

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

Sets a viewport background color

Parameters:

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

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets a viewport camera

Parameters:

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

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

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)

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

Sets a viewport relative position

Parameters:

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

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Sets a viewport size

Parameters:

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

orxDLLAPI void orxFASTCALL orxViewport_SetTexture	(	orxVIEWPORT *	_pstViewport,
		orxTEXTURE *	_pstTexture
	)

Sets a viewport texture

Parameters:

[in]	_pstViewport	Concerned viewport
[in]	_pstTexture	Texture to associate with the viewport

orxDLLAPI void orxFASTCALL orxViewport_Setup ( )

Viewport module setup

OrxViewport

Defines

Typedefs

Functions

Detailed Description

Define Documentation

Typedef Documentation

Function Documentation