Macros
#define	orxCAMERA_KU32_FLAG_2D 0x00000001
#define	orxCAMERA_KU32_FLAG_NONE 0x00000000
#define	orxCAMERA_KU32_GROUP_ID_NUMBER 32
#define	orxCAMERA_KU32_MASK_USER_ALL 0x000000FF

Typedefs
typedef struct __orxCAMERA_t	orxCAMERA

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_AddGroupID (orxCAMERA *_pstCamera, orxSTRINGID _stGroupID, orxBOOL _bAddFirst)
orxDLLAPI orxCAMERA *orxFASTCALL	orxCamera_Create (orxU32 _u32Flags)
orxDLLAPI orxCAMERA *orxFASTCALL	orxCamera_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_Delete (orxCAMERA *_pstCamera)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_EnableGroupIDSorting (orxCAMERA *_pstCamera, orxU32 _u32Index, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxCamera_Exit ()
orxDLLAPI orxCAMERA *orxFASTCALL	orxCamera_Get (const orxSTRING _zName)
orxDLLAPI orxFRAME *orxFASTCALL	orxCamera_GetFrame (const orxCAMERA *_pstCamera)
orxDLLAPI orxAABOX *orxFASTCALL	orxCamera_GetFrustum (const orxCAMERA _pstCamera, orxAABOX _pstFrustum)
orxDLLAPI orxSTRINGID orxFASTCALL	orxCamera_GetGroupID (const orxCAMERA *_pstCamera, orxU32 _u32Index)
orxDLLAPI orxU32 orxFASTCALL	orxCamera_GetGroupIDCount (const orxCAMERA *_pstCamera)
orxDLLAPI const orxSTRING orxFASTCALL	orxCamera_GetName (const orxCAMERA *_pstCamera)
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxCamera_GetParent (const orxCAMERA *_pstCamera)
orxDLLAPI orxVECTOR *orxFASTCALL	orxCamera_GetPosition (const orxCAMERA _pstCamera, orxVECTOR _pvPosition)
orxDLLAPI orxFLOAT orxFASTCALL	orxCamera_GetRotation (const orxCAMERA *_pstCamera)
orxDLLAPI orxFLOAT orxFASTCALL	orxCamera_GetZoom (const orxCAMERA *_pstCamera)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxCamera_IsGroupIDSortingEnabled (const orxCAMERA *_pstCamera, orxU32 _u32Index)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_RemoveGroupID (orxCAMERA *_pstCamera, orxSTRINGID _stGroupID)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_SetFrustum (orxCAMERA *_pstCamera, orxFLOAT _fWidth, orxFLOAT _fHeight, orxFLOAT _fNear, orxFLOAT _fFar)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_SetParent (orxCAMERA _pstCamera, void _pParent)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_SetPosition (orxCAMERA _pstCamera, const orxVECTOR _pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_SetRotation (orxCAMERA *_pstCamera, orxFLOAT _fRotation)
orxDLLAPI void orxFASTCALL	orxCamera_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxCamera_SetZoom (orxCAMERA *_pstCamera, orxFLOAT _fZoom)

Detailed Description

Camera Module Allows to creates and handle cameras Camera are structures used to render graphic (2D/3D) objects They thus can be referenced by other structures

Macro Definition Documentation

◆ orxCAMERA_KU32_FLAG_2D

#define orxCAMERA_KU32_FLAG_2D 0x00000001

2D flag

Definition at line 60 of file orxCamera.h.

◆ orxCAMERA_KU32_FLAG_NONE

#define orxCAMERA_KU32_FLAG_NONE 0x00000000

Anim flags No flags

Definition at line 58 of file orxCamera.h.

◆ orxCAMERA_KU32_GROUP_ID_NUMBER

#define orxCAMERA_KU32_GROUP_ID_NUMBER 32

Misc

Definition at line 67 of file orxCamera.h.

◆ orxCAMERA_KU32_MASK_USER_ALL

#define orxCAMERA_KU32_MASK_USER_ALL 0x000000FF

User all mask

Definition at line 62 of file orxCamera.h.

Typedef Documentation

◆ orxCAMERA

typedef struct __orxCAMERA_t orxCAMERA

Internal camera structure

Definition at line 72 of file orxCamera.h.

Function Documentation

◆ orxCamera_AddGroupID()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_AddGroupID	(	orxCAMERA *	_pstCamera,
		orxSTRINGID	_stGroupID,
		orxBOOL	_bAddFirst )

extern

Adds a group ID to a camera

Parameters

[in]	_pstCamera	Concerned camera
[in]	_stGroupID	ID of the group to add
[in]	_bAddFirst	If true this group will be used before any already added ones, otherwise it'll be used after all of them

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_Create()

orxDLLAPI orxCAMERA *orxFASTCALL orxCamera_Create ( orxU32 _u32Flags )

extern

Creates a camera

Parameters

[in] _u32Flags Camera flags (2D / ...)

Returns: Created orxCAMERA / orxNULL

◆ orxCamera_CreateFromConfig()

orxDLLAPI orxCAMERA *orxFASTCALL orxCamera_CreateFromConfig ( const orxSTRING _zConfigID )

extern

Creates a camera from config

Parameters

[in] _zConfigID Config ID @ return orxCAMERA / orxNULL

◆ orxCamera_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_Delete ( orxCAMERA * _pstCamera )

extern

Deletes a camera

Parameters

[in] _pstCamera Camera to delete

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_EnableGroupIDSorting()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_EnableGroupIDSorting	(	orxCAMERA *	_pstCamera,
		orxU32	_u32Index,
		orxBOOL	_bEnable )

extern

Enables/disables sorting for a group ID.

Parameters

[in]	_pstCamera	Concerned camera
[in]	_u32Index	Index of group ID to update
[in]	_bEnable	Enable / disable sorting

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_Exit()

orxDLLAPI void orxFASTCALL orxCamera_Exit ( )

extern

Exits from the Camera module

◆ orxCamera_Get()

orxDLLAPI orxCAMERA *orxFASTCALL orxCamera_Get ( const orxSTRING _zName )

extern

Gets camera given its name

Parameters

[in] _zName Camera name

Returns: orxCAMERA / orxNULL

◆ orxCamera_GetFrame()

orxDLLAPI orxFRAME *orxFASTCALL orxCamera_GetFrame ( const orxCAMERA * _pstCamera )

extern

Gets camera frame

Parameters

[in] _pstCamera Concerned camera

Returns: orxFRAME

◆ orxCamera_GetFrustum()

orxDLLAPI orxAABOX *orxFASTCALL orxCamera_GetFrustum	(	const orxCAMERA *	_pstCamera,
		orxAABOX *	_pstFrustum )

extern

Gets camera frustum (3D box for 2D camera)

Parameters

[in]	_pstCamera	Concerned camera
[out]	_pstFrustum	Frustum box

Returns: Frustum orxAABOX

◆ orxCamera_GetGroupID()

orxDLLAPI orxSTRINGID orxFASTCALL orxCamera_GetGroupID	(	const orxCAMERA *	_pstCamera,
		orxU32	_u32Index )

extern

Gets the group ID of a camera at the given index

Parameters

[in]	_pstCamera	Concerned camera
[in]	_u32Index	Index of group ID

Returns: Group ID if index is valid, orxSTRINGID_UNDEFINED otherwise

◆ orxCamera_GetGroupIDCount()

orxDLLAPI orxU32 orxFASTCALL orxCamera_GetGroupIDCount ( const orxCAMERA * _pstCamera )

extern

Gets number of group IDs of camera

Parameters

[in] _pstCamera Concerned camera

Returns: Number of group IDs of this camera

◆ orxCamera_GetName()

orxDLLAPI const orxSTRING orxFASTCALL orxCamera_GetName ( const orxCAMERA * _pstCamera )

extern

Gets camera config name

Parameters

[in] _pstCamera Concerned camera

Returns: orxSTRING / orxSTRING_EMPTY

◆ orxCamera_GetParent()

orxDLLAPI orxSTRUCTURE *orxFASTCALL orxCamera_GetParent ( const orxCAMERA * _pstCamera )

extern

Gets camera parent

Parameters

[in] _pstCamera Concerned camera

Returns: Parent (object, spawner, camera or frame) / orxNULL

◆ orxCamera_GetPosition()

orxDLLAPI orxVECTOR *orxFASTCALL orxCamera_GetPosition	(	const orxCAMERA *	_pstCamera,
		orxVECTOR *	_pvPosition )

extern

Get camera position

Parameters

[in]	_pstCamera	Concerned camera
[out]	_pvPosition	Camera position

Returns: orxVECTOR

◆ orxCamera_GetRotation()

orxDLLAPI orxFLOAT orxFASTCALL orxCamera_GetRotation ( const orxCAMERA * _pstCamera )

extern

Get camera rotation

Parameters

[in] _pstCamera Concerned camera

Returns: Rotation value (radians)

◆ orxCamera_GetZoom()

orxDLLAPI orxFLOAT orxFASTCALL orxCamera_GetZoom ( const orxCAMERA * _pstCamera )

extern

Get camera zoom

Parameters

[in] _pstCamera Concerned camera

Returns: Zoom value

◆ orxCamera_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_Init ( )

extern

Inits the Camera module

◆ orxCamera_IsGroupIDSortingEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxCamera_IsGroupIDSortingEnabled	(	const orxCAMERA *	_pstCamera,
		orxU32	_u32Index )

extern

Is sorting enabled for a group ID?

Parameters

[in]	_pstCamera	Concerned camera
[in]	_u32Index	Index of group ID to update

Returns: orxTRUE / orxFALSE

◆ orxCamera_RemoveGroupID()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_RemoveGroupID	(	orxCAMERA *	_pstCamera,
		orxSTRINGID	_stGroupID )

extern

Removes a group ID from a camera

Parameters

[in]	_pstCamera	Concerned camera
[in]	_stGroupID	ID of the group to remove

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_SetFrustum()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_SetFrustum	(	orxCAMERA *	_pstCamera,
		orxFLOAT	_fWidth,
		orxFLOAT	_fHeight,
		orxFLOAT	_fNear,
		orxFLOAT	_fFar )

extern

Sets camera frustum

Parameters

[in]	_pstCamera	Concerned camera
[in]	_fWidth	Width of frustum
[in]	_fHeight	Height of frustum
[in]	_fNear	Near distance of frustum
[in]	_fFar	Far distance of frustum

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_SetParent()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_SetParent	(	orxCAMERA *	_pstCamera,
		void *	_pParent )

extern

Sets camera parent

Parameters

[in]	_pstCamera	Concerned camera
[in]	_pParent	Parent structure to set (object, spawner, camera or frame) / orxNULL

Returns: orsSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_SetPosition()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_SetPosition	(	orxCAMERA *	_pstCamera,
		const orxVECTOR *	_pvPosition )

extern

Sets camera position

Parameters

[in]	_pstCamera	Concerned camera
[in]	_pvPosition	Camera position

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_SetRotation()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_SetRotation	(	orxCAMERA *	_pstCamera,
		orxFLOAT	_fRotation )

extern

Sets camera rotation

Parameters

[in]	_pstCamera	Concerned camera
[in]	_fRotation	Camera rotation (radians)

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxCamera_Setup()

orxDLLAPI void orxFASTCALL orxCamera_Setup ( )

extern

Camera module setup

◆ orxCamera_SetZoom()

orxDLLAPI orxSTATUS orxFASTCALL orxCamera_SetZoom	(	orxCAMERA *	_pstCamera,
		orxFLOAT	_fZoom )

extern

Sets camera zoom

Parameters

[in]	_pstCamera	Concerned camera
[in]	_fZoom	Camera zoom

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ orxCAMERA_KU32_FLAG_2D

◆ orxCAMERA_KU32_FLAG_NONE

◆ orxCAMERA_KU32_GROUP_ID_NUMBER

◆ orxCAMERA_KU32_MASK_USER_ALL

Typedef Documentation

◆ orxCAMERA

Function Documentation

◆ orxCamera_AddGroupID()

◆ orxCamera_Create()

◆ orxCamera_CreateFromConfig()

◆ orxCamera_Delete()

◆ orxCamera_EnableGroupIDSorting()

◆ orxCamera_Exit()

◆ orxCamera_Get()

◆ orxCamera_GetFrame()

◆ orxCamera_GetFrustum()

◆ orxCamera_GetGroupID()

◆ orxCamera_GetGroupIDCount()

◆ orxCamera_GetName()

◆ orxCamera_GetParent()

◆ orxCamera_GetPosition()

◆ orxCamera_GetRotation()

◆ orxCamera_GetZoom()

◆ orxCamera_Init()

◆ orxCamera_IsGroupIDSortingEnabled()

◆ orxCamera_RemoveGroupID()

◆ orxCamera_SetFrustum()

◆ orxCamera_SetParent()

◆ orxCamera_SetPosition()

◆ orxCamera_SetRotation()

◆ orxCamera_Setup()

◆ orxCamera_SetZoom()