orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
OrxFXPointer

Macros

#define orxFXPOINTER_KU32_FX_NUMBER   8

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 ()
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Delete (orxFXPOINTER *_pstFXPointer)
orxDLLAPI void orxFASTCALL orxFXPointer_Enable (orxFXPOINTER *_pstFXPointer, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL orxFXPointer_Exit ()
orxDLLAPI orxU32 orxFASTCALL orxFXPointer_GetCount (const orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxFLOAT orxFASTCALL orxFXPointer_GetFrequency (const orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxFLOAT orxFASTCALL orxFXPointer_GetTime (const orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Init ()
orxDLLAPI orxBOOL orxFASTCALL orxFXPointer_IsEnabled (const orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveAllFXs (orxFXPOINTER *_pstFXPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFX (orxFXPOINTER *_pstFXPointer, orxFX *_pstFX)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFXFromConfig (orxFXPOINTER *_pstFXPointer, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_SetFrequency (orxFXPOINTER *_pstFXPointer, orxFLOAT _fFrequency)
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_SetTime (orxFXPOINTER *_pstFXPointer, orxFLOAT _fTime)
orxDLLAPI void orxFASTCALL orxFXPointer_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Synchronize (orxFXPOINTER *_pstFXPointer, const orxFXPOINTER *_pstModel)

Detailed Description

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

Macro Definition Documentation

◆ orxFXPOINTER_KU32_FX_NUMBER

#define orxFXPOINTER_KU32_FX_NUMBER   8

Misc defines

Definition at line 54 of file orxFXPointer.h.

Typedef Documentation

◆ orxFXPOINTER

typedef struct __orxFXPOINTER_t orxFXPOINTER

Internal FXPointer structure

Definition at line 58 of file orxFXPointer.h.

Function Documentation

◆ orxFXPointer_AddDelayedFX()

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

Adds a delayed FX

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_pstFXFX to add
[in]_fDelayDelay time, ignored if the FX is staggered and other FXs are already present
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_AddDelayedFXFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddDelayedFXFromConfig ( orxFXPOINTER * _pstFXPointer,
const orxSTRING _zFXConfigID,
orxFLOAT _fDelay )
extern

Adds a delayed FX using its config ID

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
[in]_fDelayDelay time, ignored if the FX is staggered and other FXs are already present
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_AddFX()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFX ( orxFXPOINTER * _pstFXPointer,
orxFX * _pstFX )
extern

Adds an FX

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_pstFXFX to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_AddFXFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddFXFromConfig ( orxFXPOINTER * _pstFXPointer,
const orxSTRING _zFXConfigID )
extern

Adds an FX using its config ID

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_AddUniqueDelayedFXFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueDelayedFXFromConfig ( orxFXPOINTER * _pstFXPointer,
const orxSTRING _zFXConfigID,
orxFLOAT _fDelay )
extern

Adds a unique delayed FX using its config ID

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to add
[in]_fDelayDelay time, ignored if the FX is staggered and other FXs are already present
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_AddUniqueFXFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_AddUniqueFXFromConfig ( orxFXPOINTER * _pstFXPointer,
const orxSTRING _zFXConfigID )
extern

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

◆ orxFXPointer_Create()

orxDLLAPI orxFXPOINTER *orxFASTCALL orxFXPointer_Create ( )
extern

Creates an empty FXPointer

Returns
orxFXPOINTER / orxNULL

◆ orxFXPointer_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Delete ( orxFXPOINTER * _pstFXPointer)
extern

Deletes an FXPointer

Parameters
[in]_pstFXPointerConcerned FXPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_Enable()

orxDLLAPI void orxFASTCALL orxFXPointer_Enable ( orxFXPOINTER * _pstFXPointer,
orxBOOL _bEnable )
extern

Enables/disables an FXPointer

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_bEnableEnable / disable

◆ orxFXPointer_Exit()

orxDLLAPI void orxFASTCALL orxFXPointer_Exit ( )
extern

Exits from the FXPointer module

◆ orxFXPointer_GetCount()

orxDLLAPI orxU32 orxFASTCALL orxFXPointer_GetCount ( const orxFXPOINTER * _pstFXPointer)
extern

Gets how many FXs are currently in use

Parameters
[in]_pstFXPointerConcerned FXPointer
Returns
orxU32

◆ orxFXPointer_GetFrequency()

orxDLLAPI orxFLOAT orxFASTCALL orxFXPointer_GetFrequency ( const orxFXPOINTER * _pstFXPointer)
extern

FXPointer frequency get accessor

Parameters
[in]_pstFXPointerConcerned FXPointer
Returns
FXPointer frequency

◆ orxFXPointer_GetTime()

orxDLLAPI orxFLOAT orxFASTCALL orxFXPointer_GetTime ( const orxFXPOINTER * _pstFXPointer)
extern

FXPointer time get accessor

Parameters
[in]_pstFXPointerConcerned FXPointer
Returns
orxFLOAT

◆ orxFXPointer_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Init ( )
extern

Inits the FXPointer module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_IsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxFXPointer_IsEnabled ( const orxFXPOINTER * _pstFXPointer)
extern

Is FXPointer enabled?

Parameters
[in]_pstFXPointerConcerned FXPointer
Returns
orxTRUE if enabled, orxFALSE otherwise

◆ orxFXPointer_RemoveAllFXs()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveAllFXs ( orxFXPOINTER * _pstFXPointer)
extern

Removes all FXs

Parameters
[in]_pstFXPointerConcerned FXPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_RemoveFX()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFX ( orxFXPOINTER * _pstFXPointer,
orxFX * _pstFX )
extern

Removes an FX

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_pstFXFX to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_RemoveFXFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_RemoveFXFromConfig ( orxFXPOINTER * _pstFXPointer,
const orxSTRING _zFXConfigID )
extern

Removes an FX using its config ID

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_zFXConfigIDConfig ID of the FX to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_SetFrequency()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_SetFrequency ( orxFXPOINTER * _pstFXPointer,
orxFLOAT _fFrequency )
extern

FXPointer frequency set accessor

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_fFrequencyFrequency to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_SetTime()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_SetTime ( orxFXPOINTER * _pstFXPointer,
orxFLOAT _fTime )
extern

FXPointer time set accessor

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_fTimeTime to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxFXPointer_Setup()

orxDLLAPI void orxFASTCALL orxFXPointer_Setup ( )
extern

FXPointer module setup

◆ orxFXPointer_Synchronize()

orxDLLAPI orxSTATUS orxFASTCALL orxFXPointer_Synchronize ( orxFXPOINTER * _pstFXPointer,
const orxFXPOINTER * _pstModel )
extern

Synchronizes FX times with an other orxFXPointer if they share common FXs

Parameters
[in]_pstFXPointerConcerned FXPointer
[in]_pstModelModel FX pointer to use for synchronization
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Generated for orx by doxygen 1.8.11