orx  stable
Portable Game Engine
OrxSoundPointer

Macros

#define orxSOUNDPOINTER_KU32_SOUND_NUMBER   4
 

Typedefs

typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER
 

Functions

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound (orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)
 
orxDLLAPI orxSOUNDPOINTER *orxFASTCALL orxSoundPointer_Create ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete (orxSOUNDPOINTER *_pstSoundPointer)
 
orxDLLAPI void orxFASTCALL orxSoundPointer_Enable (orxSOUNDPOINTER *_pstSoundPointer, orxBOOL _bEnable)
 
orxDLLAPI void orxFASTCALL orxSoundPointer_Exit ()
 
orxDLLAPI orxSOUND *orxFASTCALL orxSoundPointer_GetLastAddedSound (const orxSOUNDPOINTER *_pstSoundPointer)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Init ()
 
orxDLLAPI orxBOOL orxFASTCALL orxSoundPointer_IsEnabled (const orxSOUNDPOINTER *_pstSoundPointer)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause (orxSOUNDPOINTER *_pstSoundPointer)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play (orxSOUNDPOINTER *_pstSoundPointer)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds (orxSOUNDPOINTER *_pstSoundPointer)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound (orxSOUNDPOINTER *_pstSoundPointer, orxSOUND *_pstSound)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zSoundConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPitch (orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fPitch)
 
orxDLLAPI void orxFASTCALL orxSoundPointer_Setup ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetVolume (orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fVolume)
 
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop (orxSOUNDPOINTER *_pstSoundPointer)
 

Detailed Description

Sound pointer module Allows to creates sound containers for objects.

Macro Definition Documentation

#define orxSOUNDPOINTER_KU32_SOUND_NUMBER   4

Misc defines

Definition at line 54 of file orxSoundPointer.h.

Typedef Documentation

typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER

Internal SoundPointer structure

Definition at line 58 of file orxSoundPointer.h.

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound ( orxSOUNDPOINTER _pstSoundPointer,
orxSOUND _pstSound 
)

Adds a sound

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstSoundSound to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig ( orxSOUNDPOINTER _pstSoundPointer,
const orxSTRING  _zSoundConfigID 
)

Adds a sound using its config ID

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_zSoundConfigIDConfig ID of the sound to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSOUNDPOINTER* orxFASTCALL orxSoundPointer_Create ( )

Creates an empty SoundPointer

Returns
orxSOUNDPOINTER / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete ( orxSOUNDPOINTER _pstSoundPointer)

Deletes a SoundPointer

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxSoundPointer_Enable ( orxSOUNDPOINTER _pstSoundPointer,
orxBOOL  _bEnable 
)

Enables/disables a SoundPointer

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxSoundPointer_Exit ( )

Exits from the SoundPointer module

orxDLLAPI orxSOUND* orxFASTCALL orxSoundPointer_GetLastAddedSound ( const orxSOUNDPOINTER _pstSoundPointer)

Gets last added sound (Do NOT destroy it directly before removing it!!!)

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSOUND / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Init ( )

Inits the SoundPointer module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBOOL orxFASTCALL orxSoundPointer_IsEnabled ( const orxSOUNDPOINTER _pstSoundPointer)

Is SoundPointer enabled?

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause ( orxSOUNDPOINTER _pstSoundPointer)

Pauses all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play ( orxSOUNDPOINTER _pstSoundPointer)

Plays all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds ( orxSOUNDPOINTER _pstSoundPointer)

Removes all sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound ( orxSOUNDPOINTER _pstSoundPointer,
orxSOUND _pstSound 
)

Removes a sound

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstSoundSound to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig ( orxSOUNDPOINTER _pstSoundPointer,
const orxSTRING  _zSoundConfigID 
)

Removes a sound using its config ID

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_zSoundConfigIDConfig ID of the sound to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPitch ( orxSOUNDPOINTER _pstSoundPointer,
orxFLOAT  _fPitch 
)

Sets pitch of all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_fPitchDesired pitch
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxSoundPointer_Setup ( )

SoundPointer module setup

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetVolume ( orxSOUNDPOINTER _pstSoundPointer,
orxFLOAT  _fVolume 
)

Sets volume of all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_fVolumeDesired volume (0.0 - 1.0)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop ( orxSOUNDPOINTER _pstSoundPointer)

Stops all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Generated for orx by doxygen 1.5.6