Data Structures
struct	orxFX_EVENT_PAYLOAD
Defines
#define	orxFX_SLOT_KU32_FLAG_ABSOLUTE 0x00000100
#define	orxFX_SLOT_KU32_FLAG_USE_ROTATION 0x00000200
#define	orxFX_SLOT_KU32_FLAG_USE_SCALE 0x00000400
Typedefs
typedef struct __orxFX_t	orxFX
Enumerations
enum	orxFX_CURVE { orxFX_CURVE_LINEAR = 0, orxFX_CURVE_SMOOTH, orxFX_CURVE_TRIANGLE, orxFX_CURVE_SINE, orxFX_CURVE_SQUARE, orxFX_CURVE_NUMBER, orxFX_CURVE_NONE = orxENUM_NONE }
enum	orxFX_EVENT { orxFX_EVENT_START = 0, orxFX_EVENT_STOP, orxFX_EVENT_ADD, orxFX_EVENT_REMOVE, orxFX_EVENT_LOOP, orxFX_EVENT_NUMBER, orxFX_EVENT_NONE = orxENUM_NONE }
Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddAlpha (orxFX *_pstFX, orxFLOAT _fStartTime, orxFLOAT _fEndTime, orxFLOAT _fCyclePeriod, orxFLOAT _fCyclePhase, orxFLOAT _fAmplification, orxFLOAT _fAcceleration, orxFLOAT _fStartAlpha, orxFLOAT _fEndAlpha, orxFX_CURVE _eCurve, orxFLOAT _fPow, orxU32 _u32Flags)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddColor (orxFX _pstFX, orxFLOAT _fStartTime, orxFLOAT _fEndTime, orxFLOAT _fCyclePeriod, orxFLOAT _fCyclePhase, orxFLOAT _fAmplification, orxFLOAT _fAcceleration, orxVECTOR _pvStartColor, orxVECTOR *_pvEndColor, orxFX_CURVE _eCurve, orxFLOAT _fPow, orxU32 _u32Flags)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddPosition (orxFX _pstFX, orxFLOAT _fStartTime, orxFLOAT _fEndTime, orxFLOAT _fCyclePeriod, orxFLOAT _fCyclePhase, orxFLOAT _fAmplification, orxFLOAT _fAcceleration, const orxVECTOR _pvStartTranslation, const orxVECTOR *_pvEndTranslation, orxFX_CURVE _eCurve, orxFLOAT _fPow, orxU32 _u32Flags)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddRotation (orxFX *_pstFX, orxFLOAT _fStartTime, orxFLOAT _fEndTime, orxFLOAT _fCyclePeriod, orxFLOAT _fCyclePhase, orxFLOAT _fAmplification, orxFLOAT _fAcceleration, orxFLOAT _fStartRotation, orxFLOAT _fEndRotation, orxFX_CURVE _eCurve, orxFLOAT _fPow, orxU32 _u32Flags)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddScale (orxFX _pstFX, orxFLOAT _fStartTime, orxFLOAT _fEndTime, orxFLOAT _fCyclePeriod, orxFLOAT _fCyclePhase, orxFLOAT _fAmplification, orxFLOAT _fAcceleration, const orxVECTOR _pvStartScale, const orxVECTOR *_pvEndScale, orxFX_CURVE _eCurve, orxFLOAT _fPow, orxU32 _u32Flags)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddSlotFromConfig (orxFX *_pstFX, const orxSTRING _zSlotID)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_AddSpeed (orxFX _pstFX, orxFLOAT _fStartTime, orxFLOAT _fEndTime, orxFLOAT _fCyclePeriod, orxFLOAT _fCyclePhase, orxFLOAT _fAmplification, orxFLOAT _fAcceleration, const orxVECTOR _pvStartSpeed, const orxVECTOR *_pvEndSpeed, orxFX_CURVE _eCurve, orxFLOAT _fPow, orxU32 _u32Flags)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_Apply (const orxFX _pstFX, orxOBJECT _pstObject, orxFLOAT _fStartTime, orxFLOAT _fEndTime)
orxDLLAPI orxFX *orxFASTCALL	orxFX_Create ()
orxDLLAPI orxFX *orxFASTCALL	orxFX_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_Delete (orxFX *_pstFX)
orxDLLAPI void orxFASTCALL	orxFX_Enable (orxFX *_pstFX, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxFX_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL	orxFX_GetDuration (const orxFX *_pstFX)
orxDLLAPI const orxSTRING orxFASTCALL	orxFX_GetName (const orxFX *_pstFX)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxFX_IsEnabled (const orxFX *_pstFX)
orxDLLAPI orxBOOL orxFASTCALL	orxFX_IsLooping (const orxFX *_pstFX)
orxDLLAPI orxSTATUS orxFASTCALL	orxFX_Loop (orxFX *_pstFX, orxBOOL _bLoop)
orxDLLAPI void orxFASTCALL	orxFX_Setup ()

Detailed Description

FX module Allows to creates rendering special effects affecting color, scale, rotation and position of visuals.

Define Documentation

#define orxFX_SLOT_KU32_FLAG_ABSOLUTE 0x00000100

Slot flags Absolute flag

Definition at line 54 of file orxFX.h.

#define orxFX_SLOT_KU32_FLAG_USE_ROTATION 0x00000200

Use rotation flag

Definition at line 55 of file orxFX.h.

#define orxFX_SLOT_KU32_FLAG_USE_SCALE 0x00000400

Use scale flag

Definition at line 56 of file orxFX.h.

Typedef Documentation

typedef struct __orxFX_t orxFX

Internal FX structure

Definition at line 78 of file orxFX.h.

Enumeration Type Documentation

enum orxFX_CURVE

FX curve enum

Enumerator:

orxFX_CURVE_LINEAR
orxFX_CURVE_SMOOTH
orxFX_CURVE_TRIANGLE
orxFX_CURVE_SINE
orxFX_CURVE_SQUARE
orxFX_CURVE_NUMBER
orxFX_CURVE_NONE

Definition at line 61 of file orxFX.h.

enum orxFX_EVENT

Event enum

Enumerator:

orxFX_EVENT_START	Event sent when a FX starts
orxFX_EVENT_STOP	Event sent when a FX stops
orxFX_EVENT_ADD	Event sent when a FX is added
orxFX_EVENT_REMOVE	Event sent when a FX is removed
orxFX_EVENT_LOOP	Event sent when a FX is looping
orxFX_EVENT_NUMBER
orxFX_EVENT_NONE

Definition at line 83 of file orxFX.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddAlpha	(	orxFX *	_pstFX,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime,
		orxFLOAT	_fCyclePeriod,
		orxFLOAT	_fCyclePhase,
		orxFLOAT	_fAmplification,
		orxFLOAT	_fAcceleration,
		orxFLOAT	_fStartAlpha,
		orxFLOAT	_fEndAlpha,
		orxFX_CURVE	_eCurve,
		orxFLOAT	_fPow,
		orxU32	_u32Flags
	)

Adds alpha to an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_fStartTime	Time start
[in]	_fEndTime	Time end
[in]	_fCyclePeriod	Cycle period
[in]	_fCyclePhase	Cycle phase (at start)
[in]	_fAmplification	Curve linear amplification over time (1.0 for none)
[in]	_fAcceleration	Curve linear acceleration over time (1.0 for none)
[in]	_fStartAlpha	Starting alpha value
[in]	_fEndAlpha	Ending alpha value
[in]	_eCurve	Blending curve type
[in]	_fPow	Blending curve exponent
[in]	_u32Flags	Param flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddColor	(	orxFX *	_pstFX,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime,
		orxFLOAT	_fCyclePeriod,
		orxFLOAT	_fCyclePhase,
		orxFLOAT	_fAmplification,
		orxFLOAT	_fAcceleration,
		orxVECTOR *	_pvStartColor,
		orxVECTOR *	_pvEndColor,
		orxFX_CURVE	_eCurve,
		orxFLOAT	_fPow,
		orxU32	_u32Flags
	)

Adds color to an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_fStartTime	Time start
[in]	_fEndTime	Time end
[in]	_fCyclePeriod	Cycle period
[in]	_fCyclePhase	Cycle phase (at start)
[in]	_fAmplification	Curve linear amplification over time (1.0 for none)
[in]	_fAcceleration	Curve linear acceleration over time (1.0 for none)
[in]	_pvStartColor	Starting color value
[in]	_pvEndColor	Ending color value
[in]	_eCurve	Blending curve type
[in]	_fPow	Blending curve exponent
[in]	_u32Flags	Param flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddPosition	(	orxFX *	_pstFX,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime,
		orxFLOAT	_fCyclePeriod,
		orxFLOAT	_fCyclePhase,
		orxFLOAT	_fAmplification,
		orxFLOAT	_fAcceleration,
		const orxVECTOR *	_pvStartTranslation,
		const orxVECTOR *	_pvEndTranslation,
		orxFX_CURVE	_eCurve,
		orxFLOAT	_fPow,
		orxU32	_u32Flags
	)

Adds position to an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_fStartTime	Time start
[in]	_fEndTime	Time end
[in]	_fCyclePeriod	Cycle period
[in]	_fCyclePhase	Cycle phase (at start)
[in]	_fAmplification	Curve linear amplification over time (1.0 for none)
[in]	_fAcceleration	Curve linear acceleration over time (1.0 for none)
[in]	_pvStartTranslation	Starting position value
[in]	_pvEndTranslation	Ending position value
[in]	_eCurve	Blending curve type
[in]	_fPow	Blending curve exponent
[in]	_u32Flags	Param flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddRotation	(	orxFX *	_pstFX,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime,
		orxFLOAT	_fCyclePeriod,
		orxFLOAT	_fCyclePhase,
		orxFLOAT	_fAmplification,
		orxFLOAT	_fAcceleration,
		orxFLOAT	_fStartRotation,
		orxFLOAT	_fEndRotation,
		orxFX_CURVE	_eCurve,
		orxFLOAT	_fPow,
		orxU32	_u32Flags
	)

Adds rotation to an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_fStartTime	Time start
[in]	_fEndTime	Time end
[in]	_fCyclePeriod	Cycle period
[in]	_fCyclePhase	Cycle phase (at start)
[in]	_fAmplification	Curve linear amplification over time (1.0 for none)
[in]	_fAcceleration	Curve linear acceleration over time (1.0 for none)
[in]	_fStartRotation	Starting rotation value (radians)
[in]	_fEndRotation	Ending rotation value (radians)
[in]	_eCurve	Blending curve type
[in]	_fPow	Blending curve exponent
[in]	_u32Flags	Param flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddScale	(	orxFX *	_pstFX,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime,
		orxFLOAT	_fCyclePeriod,
		orxFLOAT	_fCyclePhase,
		orxFLOAT	_fAmplification,
		orxFLOAT	_fAcceleration,
		const orxVECTOR *	_pvStartScale,
		const orxVECTOR *	_pvEndScale,
		orxFX_CURVE	_eCurve,
		orxFLOAT	_fPow,
		orxU32	_u32Flags
	)

Adds scale to an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_fStartTime	Time start
[in]	_fEndTime	Time end
[in]	_fCyclePeriod	Cycle period
[in]	_fCyclePhase	Cycle phase (at start)
[in]	_fAmplification	Curve linear amplification over time (1.0 for none)
[in]	_fAcceleration	Curve linear acceleration over time (1.0 for none)
[in]	_pvStartScale	Starting scale value
[in]	_pvEndScale	Ending scale value
[in]	_eCurve	Blending curve type
[in]	_fPow	Blending curve exponent
[in]	_u32Flags	Param flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddSlotFromConfig	(	orxFX *	_pstFX,
		const orxSTRING	_zSlotID
	)

Adds a slot to an FX from config

Parameters:

[in]	_pstFX	Concerned FX
[in]	_zSlotID	Config ID return orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_AddSpeed	(	orxFX *	_pstFX,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime,
		orxFLOAT	_fCyclePeriod,
		orxFLOAT	_fCyclePhase,
		orxFLOAT	_fAmplification,
		orxFLOAT	_fAcceleration,
		const orxVECTOR *	_pvStartSpeed,
		const orxVECTOR *	_pvEndSpeed,
		orxFX_CURVE	_eCurve,
		orxFLOAT	_fPow,
		orxU32	_u32Flags
	)

Adds speed to an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_fStartTime	Time start
[in]	_fEndTime	Time end
[in]	_fCyclePeriod	Cycle period
[in]	_fCyclePhase	Cycle phase (at start)
[in]	_fAmplification	Curve linear amplification over time (1.0 for none)
[in]	_fAcceleration	Curve linear acceleration over time (1.0 for none)
[in]	_pvStartSpeed	Starting speed value
[in]	_pvEndSpeed	Ending speed value
[in]	_eCurve	Blending curve type
[in]	_fPow	Blending curve exponent
[in]	_u32Flags	Param flags

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxFX_Apply	(	const orxFX *	_pstFX,
		orxOBJECT *	_pstObject,
		orxFLOAT	_fStartTime,
		orxFLOAT	_fEndTime
	)

Applies FX on object

Parameters:

[in]	_pstFX	FX to apply
[in]	_pstObject	Object on which to apply the FX
[in]	_fStartTime	FX local application start time
[in]	_fEndTime	FX local application end time

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxFX* orxFASTCALL orxFX_Create ( )

Creates an empty FX

Returns:: orxFX / orxNULL

orxDLLAPI orxFX* orxFASTCALL orxFX_CreateFromConfig ( const orxSTRING _zConfigID )

Creates an FX from config

Parameters:

[in] _zConfigID Config ID @ return orxFX / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxFX_Delete ( orxFX * _pstFX )

Deletes an FX

Parameters:

[in] _pstFX Concerned FX

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxFX_Enable	(	orxFX *	_pstFX,
		orxBOOL	_bEnable
	)

Enables/disables an FX

Parameters:

[in]	_pstFX	Concerned FX
[in]	_bEnable	Enable / disable

orxDLLAPI void orxFASTCALL orxFX_Exit ( )

Exits from the FX module

orxDLLAPI orxFLOAT orxFASTCALL orxFX_GetDuration ( const orxFX * _pstFX )

Gets FX duration

Parameters:

[in] _pstFX Concerned FX

Returns:: orxFLOAT

orxDLLAPI const orxSTRING orxFASTCALL orxFX_GetName ( const orxFX * _pstFX )

Gets FX name

Parameters:

[in] _pstFX Concerned FX

Returns:: orxSTRING / orxSTRING_EMPTY

orxDLLAPI orxSTATUS orxFASTCALL orxFX_Init ( )

Inits the FX module

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxFX_IsEnabled ( const orxFX * _pstFX )

Is FX enabled?

Parameters:

[in] _pstFX Concerned FX

Returns:: orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxFX_IsLooping ( const orxFX * _pstFX )

Is FX looping

Parameters:

[in] _pstFX Concerned FX

Returns:: orxTRUE if looping, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxFX_Loop	(	orxFX *	_pstFX,
		orxBOOL	_bLoop
	)

Set FX loop property

Parameters:

[in]	_pstFX	Concerned FX
[in]	_bLoop	Loop / don't loop

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxFX_Setup ( )

FX module setup

OrxFX

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation