OrxShaderPointer

Defines
#define	orxSHADERPOINTER_KU32_SHADER_NUMBER   4
Typedefs
typedef struct __orxSHADERPOINTER_t	orxSHADERPOINTER
Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_AddShader (orxSHADERPOINTER *_pstShaderPointer, orxSHADER *_pstShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_AddShaderFromConfig (orxSHADERPOINTER *_pstShaderPointer, const orxSTRING _zShaderConfigID)
orxDLLAPI orxSHADERPOINTER *orxFASTCALL	orxShaderPointer_Create (const orxSTRUCTURE *_pstOwner)
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_Delete (orxSHADERPOINTER *_pstShaderPointer)
orxDLLAPI void orxFASTCALL	orxShaderPointer_Enable (orxSHADERPOINTER *_pstShaderPointer, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxShaderPointer_Exit ()
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxShaderPointer_GetOwner (const orxSHADERPOINTER *_pstShaderPointer)
orxDLLAPI const orxSHADER *orxFASTCALL	orxShaderPointer_GetShader (const orxSHADERPOINTER *_pstShaderPointer, orxU32 _u32Index)
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxShaderPointer_IsEnabled (const orxSHADERPOINTER *_pstShaderPointer)
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_RemoveShader (orxSHADERPOINTER *_pstShaderPointer, orxSHADER *_pstShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_RemoveShaderFromConfig (orxSHADERPOINTER *_pstShaderPointer, const orxSTRING _zShaderConfigID)
orxDLLAPI void orxFASTCALL	orxShaderPointer_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_Start (const orxSHADERPOINTER *_pstShaderPointer)
orxDLLAPI orxSTATUS orxFASTCALL	orxShaderPointer_Stop (const orxSHADERPOINTER *_pstShaderPointer)

---

Detailed Description

ShaderPointer module Allows to creates shaders (rendering post effects) containers for objects.

---

Define Documentation

#define orxSHADERPOINTER_KU32_SHADER_NUMBER   4

Misc defines

Definition at line 54 of file orxShaderPointer.h.

---

Typedef Documentation

typedef struct __orxSHADERPOINTER_t orxSHADERPOINTER

Internal ShaderPointer structure

Definition at line 58 of file orxShaderPointer.h.

---

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_AddShader	(	orxSHADERPOINTER *	_pstShaderPointer,
		orxSHADER *	_pstShader
	)

Adds a shader

Parameters:

[in]	_pstShaderPointer	Concerned ShaderPointer
[in]	_pstShader	Shader to add

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_AddShaderFromConfig	(	orxSHADERPOINTER *	_pstShaderPointer,
		const orxSTRING	_zShaderConfigID
	)

Adds a shader using its config ID

Parameters:

[in]	_pstShaderPointer	Concerned ShaderPointer
[in]	_zShaderConfigID	Config ID of the shader to add

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSHADERPOINTER* orxFASTCALL orxShaderPointer_Create

(

const orxSTRUCTURE *

_pstOwner )

Creates an empty ShaderPointer

Parameters:

[in]

_pstOwner

ShaderPointer's owner used for rendering (usually an orxOBJECT)

Returns:

orxSHADERPOINTER / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_Delete

(

orxSHADERPOINTER *

_pstShaderPointer )

Deletes an ShaderPointer

Parameters:

[in]

_pstShaderPointer

Concerned ShaderPointer

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxShaderPointer_Enable	(	orxSHADERPOINTER *	_pstShaderPointer,
		orxBOOL	_bEnable
	)

Enables/disables an ShaderPointer

Parameters:

[in]	_pstShaderPointer	Concerned ShaderPointer
[in]	_bEnable	Enable / disable

orxDLLAPI void orxFASTCALL orxShaderPointer_Exit

(

)

Exits from the ShaderPointer module

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxShaderPointer_GetOwner

(

const orxSHADERPOINTER *

_pstShaderPointer )

Gets an ShaderPointer owner

Parameters:

[in]

_pstShaderPointer

Concerned ShaderPointer

Returns:

orxSTRUCTURE / orxNULL

orxDLLAPI const orxSHADER* orxFASTCALL orxShaderPointer_GetShader	(	const orxSHADERPOINTER *	_pstShaderPointer,
		orxU32	_u32Index
	)

Gets a shader

Parameters:

[in]	_pstShaderPointer	Concerned ShaderPointer
[in]	_u32Index	Index of shader to get

Returns:

orxSJADER / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_Init

(

)

Inits the ShaderPointer module

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxShaderPointer_IsEnabled

(

const orxSHADERPOINTER *

_pstShaderPointer )

Is ShaderPointer enabled?

Parameters:

[in]

_pstShaderPointer

Concerned ShaderPointer

Returns:

orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_RemoveShader	(	orxSHADERPOINTER *	_pstShaderPointer,
		orxSHADER *	_pstShader
	)

Removes a shader

Parameters:

[in]	_pstShaderPointer	Concerned ShaderPointer
[in]	_pstShader	Shader to remove

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_RemoveShaderFromConfig	(	orxSHADERPOINTER *	_pstShaderPointer,
		const orxSTRING	_zShaderConfigID
	)

Removes a shader using using its config ID

Parameters:

[in]	_pstShaderPointer	Concerned ShaderPointer
[in]	_zShaderConfigID	Config ID of the shader to remove

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxShaderPointer_Setup

(

)

ShaderPointer module setup

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_Start

(

const orxSHADERPOINTER *

_pstShaderPointer )

Starts a ShaderPointer

Parameters:

[in]

_pstShaderPointer

Concerned ShaderPointer

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxShaderPointer_Stop

(

const orxSHADERPOINTER *

_pstShaderPointer )

Stops a ShaderPointer

Parameters:

[in]

_pstShaderPointer

Concerned ShaderPointer

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE