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

Macros

#define orxSOUNDPOINTER_KU32_SOUND_NUMBER   4

Typedefs

typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER

Functions

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddFilter (orxSOUNDPOINTER *_pstSoundPointer, const orxSOUND_FILTER_DATA *_pstFilterData, orxBOOL _bUseCustomParam)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddFilterFromConfig (orxSOUNDPOINTER *_pstSoundPointer, const orxSTRING _zFilterConfigID)
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 orxU32 orxFASTCALL orxSoundPointer_GetCount (const orxSOUNDPOINTER *_pstSoundPointer)
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_RemoveAllFilters (orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds (orxSOUNDPOINTER *_pstSoundPointer)
orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveLastFilter (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_SetPanning (orxSOUNDPOINTER *_pstSoundPointer, orxFLOAT _fPanning, orxBOOL _bMix)
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

◆ orxSOUNDPOINTER_KU32_SOUND_NUMBER

#define orxSOUNDPOINTER_KU32_SOUND_NUMBER   4

Misc defines

Definition at line 54 of file orxSoundPointer.h.

Typedef Documentation

◆ orxSOUNDPOINTER

typedef struct __orxSOUNDPOINTER_t orxSOUNDPOINTER

Internal SoundPointer structure

Definition at line 58 of file orxSoundPointer.h.

Function Documentation

◆ orxSoundPointer_AddFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddFilter ( orxSOUNDPOINTER * _pstSoundPointer,
const orxSOUND_FILTER_DATA * _pstFilterData,
orxBOOL _bUseCustomParam )
extern

Adds a filter to all related sounds (cascading)

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstFilterDataConcerned filter data
[in]_bUseCustomParamFilter uses custom parameters
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_AddFilterFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddFilterFromConfig ( orxSOUNDPOINTER * _pstSoundPointer,
const orxSTRING _zFilterConfigID )
extern

Adds a filter to all related sounds from config (cascading)

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_zFilterConfigIDConfig ID of the filter to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_AddSound()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSound ( orxSOUNDPOINTER * _pstSoundPointer,
orxSOUND * _pstSound )
extern

Adds a sound

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstSoundSound to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_AddSoundFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_AddSoundFromConfig ( orxSOUNDPOINTER * _pstSoundPointer,
const orxSTRING _zSoundConfigID )
extern

Adds a sound using its config ID

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_zSoundConfigIDConfig ID of the sound to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_Create()

orxDLLAPI orxSOUNDPOINTER *orxFASTCALL orxSoundPointer_Create ( )
extern

Creates an empty SoundPointer

Returns
orxSOUNDPOINTER / orxNULL

◆ orxSoundPointer_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Delete ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Deletes a SoundPointer

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_Enable()

orxDLLAPI void orxFASTCALL orxSoundPointer_Enable ( orxSOUNDPOINTER * _pstSoundPointer,
orxBOOL _bEnable )
extern

Enables/disables a SoundPointer

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_bEnableEnable / disable

◆ orxSoundPointer_Exit()

orxDLLAPI void orxFASTCALL orxSoundPointer_Exit ( )
extern

Exits from the SoundPointer module

◆ orxSoundPointer_GetCount()

orxDLLAPI orxU32 orxFASTCALL orxSoundPointer_GetCount ( const orxSOUNDPOINTER * _pstSoundPointer)
extern

Gets how many sounds are currently in use

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxU32

◆ orxSoundPointer_GetLastAddedSound()

orxDLLAPI orxSOUND *orxFASTCALL orxSoundPointer_GetLastAddedSound ( const orxSOUNDPOINTER * _pstSoundPointer)
extern

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

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSOUND / orxNULL

◆ orxSoundPointer_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Init ( )
extern

Inits the SoundPointer module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_IsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxSoundPointer_IsEnabled ( const orxSOUNDPOINTER * _pstSoundPointer)
extern

Is SoundPointer enabled?

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxTRUE if enabled, orxFALSE otherwise

◆ orxSoundPointer_Pause()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Pause ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Pauses all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_Play()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Play ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Plays all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_RemoveAllFilters()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllFilters ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Removes all filters from all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_RemoveAllSounds()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveAllSounds ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Removes all sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_RemoveLastFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveLastFilter ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Removes last added filter from all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_RemoveSound()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSound ( orxSOUNDPOINTER * _pstSoundPointer,
orxSOUND * _pstSound )
extern

Removes a sound

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_pstSoundSound to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_RemoveSoundFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_RemoveSoundFromConfig ( orxSOUNDPOINTER * _pstSoundPointer,
const orxSTRING _zSoundConfigID )
extern

Removes a sound using its config ID

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_zSoundConfigIDConfig ID of the sound to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_SetPanning()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPanning ( orxSOUNDPOINTER * _pstSoundPointer,
orxFLOAT _fPanning,
orxBOOL _bMix )
extern

Sets panning of all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_fPanningSound panning, -1.0f for full left, 0.0f for center, 1.0f for full right
[in]_bMixLeft/Right channels will be mixed if orxTRUE or act like a balance otherwise
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_SetPitch()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetPitch ( orxSOUNDPOINTER * _pstSoundPointer,
orxFLOAT _fPitch )
extern

Sets pitch of all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_fPitchDesired pitch (< 1.0 => lower pitch, = 1.0 => original pitch, > 1.0 => higher pitch). 0.0 is ignored.
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_Setup()

orxDLLAPI void orxFASTCALL orxSoundPointer_Setup ( )
extern

SoundPointer module setup

◆ orxSoundPointer_SetVolume()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_SetVolume ( orxSOUNDPOINTER * _pstSoundPointer,
orxFLOAT _fVolume )
extern

Sets volume of all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
[in]_fVolumeDesired volume (0.0 - 1.0)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSoundPointer_Stop()

orxDLLAPI orxSTATUS orxFASTCALL orxSoundPointer_Stop ( orxSOUNDPOINTER * _pstSoundPointer)
extern

Stops all related sounds

Parameters
[in]_pstSoundPointerConcerned SoundPointer
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Generated for orx by doxygen 1.8.11