Defines | Typedefs | Functions

OrxFXPointer

Defines

#define orxFXPOINTER_KU32_FX_NUMBER   4

Typedefs

typedef struct __orxFXPOINTER_t orxFXPOINTER

Functions

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFX (orxFXPOINTER *_pstFXPointer, orxFX *_pstFX, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFXFromConfig (orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFX (orxFXPOINTER *_pstFXPointer, orxFX *_pstFX)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFXFromConfig (orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueDelayedFXFromConfig (orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueFXFromConfig (orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)
orxDLLAPI orxFXPOINTER *orxFASTCALL orxFXPointer_Create (const orxSTRUCTURE *_pstOwner)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Delete (orxFXPOINTER *_pstFXPointer)
orxDLLAPI void orxFASTCALL orxFXPointer_Enable (orxFXPOINTER *_pstFXPointer, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL orxFXPointer_Exit ()
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxFXPointer_GetOwner (const orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Init ()
orxDLLAPI orxBOOL orxFASTCALL orxFXPointer_IsEnabled (const orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFX (orxFXPOINTER *_pstFXPointer, orxFX *_pstFX)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFXFromConfig (orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)
orxDLLAPI void orxFASTCALL orxFXPointer_Setup ()

Detailed Description

FXPointer module Allows to creates rendering special effects containers for objects.

Define Documentation

#define orxFXPOINTER_KU32_FX_NUMBER   4

Misc defines

Definition at line 54 of file orxFXPointer.h.

Typedef Documentation

typedef struct __orxFXPOINTER_t orxFXPOINTER

Internal FXPointer structure

Definition at line 58 of file orxFXPointer.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFX ( orxFXPOINTER *  _pstFXPointer,
orxFX *  _pstFX,
orxFLOAT  _fDelay 
)

Adds a delayed FX

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_pstFXFX to add
[in]_fDelayDelay time
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFXFromConfig ( orxFXPOINTER *  _pstFXPointer,
const orxSTRING  _zFXConfigID,
orxFLOAT  _fDelay 
)

Adds a delayed FX using its config ID

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
[in]_fDelayDelay time
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFX ( orxFXPOINTER *  _pstFXPointer,
orxFX *  _pstFX 
)

Adds an FX

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_pstFXFX to add
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFXFromConfig ( orxFXPOINTER *  _pstFXPointer,
const orxSTRING  _zFXConfigID 
)

Adds an FX using its config ID

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueDelayedFXFromConfig ( orxFXPOINTER *  _pstFXPointer,
const orxSTRING  _zFXConfigID,
orxFLOAT  _fDelay 
)

Adds a unique delayed FX using its config ID

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
[in]_fDelayDelay time
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueFXFromConfig ( orxFXPOINTER *  _pstFXPointer,
const orxSTRING  _zFXConfigID 
)

Adds a unique FX using its config ID

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxFXPOINTER* orxFASTCALL orxFXPointer_Create ( const orxSTRUCTURE *  _pstOwner )

Creates an empty FXPointer

Parameters:
[in]_pstOwnerFXPointer's owner used for event callbacks (usually an orxOBJECT)
Returns:
orxFXPOINTER / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Delete ( orxFXPOINTER *  _pstFXPointer )

Deletes an FXPointer

Parameters:
[in]_pstFXPointerConcerned FXPointer
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxFXPointer_Enable ( orxFXPOINTER *  _pstFXPointer,
orxBOOL  _bEnable 
)

Enables/disables an FXPointer

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxFXPointer_Exit (  )

Exits from the FXPointer module

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxFXPointer_GetOwner ( const orxFXPOINTER *  _pstFXPointer )

Gets an FXPointer owner

Parameters:
[in]_pstFXPointerConcerned FXPointer
Returns:
orxSTRUCTURE / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Init (  )

Inits the FXPointer module

Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBOOL orxFASTCALL orxFXPointer_IsEnabled ( const orxFXPOINTER *  _pstFXPointer )

Is FXPointer enabled?

Parameters:
[in]_pstFXPointerConcerned FXPointer
Returns:
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFX ( orxFXPOINTER *  _pstFXPointer,
orxFX *  _pstFX 
)

Removes an FX

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_pstFXFX to remove
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFXFromConfig ( orxFXPOINTER *  _pstFXPointer,
const orxSTRING  _zFXConfigID 
)

Removes an FX using using its config ID

Parameters:
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to remove
Returns:
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxFXPointer_Setup (  )

FXPointer module setup

Generated for orx by doxygen 1.5.6