Torque3D Documentation / _generateds / SFXDSVoice

SFXDSVoice

Engine/source/sfx/dsound/sfxDSVoice.h

More...

Private Types

SFXVoice

Parent

Protected Attributes

SFXDSDevice *

mDevice

The device used to commit deferred settings.

IDirectSoundBuffer8 *

mDSBuffer 

IDirectSound3DBuffer8 *

mDSBuffer3D 

bool

mIsLooping

Protected Functions

SFXDSVoice(SFXDSDevice * device, SFXDSBuffer * buffer, IDirectSoundBuffer8 * dsBuffer, IDirectSound3DBuffer8 * dsBuffer3d)

SFXDSBuffer *

_getBuffer()

void

_pause()

Pause playback on the device.
void

_play()

Start playback on the device.
void

_seek(U32 sample)

Set the playback cursor on the device.
SFXStatus

_status()

Return the current playback status (playing, paused, or stopped).
void

_stop()

Stop playback on the device.
U32

_tell()

Get the playback cursor on the device.
Protected Static Functions
LONG

_linearToLogVolume(F32 linVolume)

Helper for converting floating point linear volume to a logrithmic integer volume for dsound.
Public Static Functions
SFXDSVoice *

create(SFXDSDevice * device, SFXDSBuffer * buffer)

Public Functions
~SFXDSVoice()

void

play(bool looping)

Starts playback from the current position.
void

setCone(F32 innerAngle, F32 outerAngle, F32 outerVolume)

Set sound cone of a 3D sound.
void

setMinMaxDistance(F32 min, F32 max)

Sets the minimum and maximum distances for 3d falloff.
void

setPitch(F32 pitch)

Sets the pitch scale.
void

setTransform(const MatrixF & transform)

Sets the position and orientation for a 3d voice.
void

setVelocity(const VectorF & velocity)

Sets the velocity for a 3d voice.
void

setVolume(F32 volume)

Sets the volume.
Detailed Description
Private Types
typedef SFXVoice Parent 

Protected Attributes
SFXDSDevice * mDevice 

The device used to commit deferred settings.
IDirectSoundBuffer8 * mDSBuffer 

IDirectSound3DBuffer8 * mDSBuffer3D 

bool mIsLooping 

Protected Functions
SFXDSVoice(SFXDSDevice * device, SFXDSBuffer * buffer, IDirectSoundBuffer8 * dsBuffer, IDirectSound3DBuffer8 * dsBuffer3d)

_getBuffer()

_pause()

Reimplemented from: SFXVoice
_play()

Reimplemented from: SFXVoice
_seek(U32 sample)

Reimplemented from: SFXVoice
_status()

Reimplemented from: SFXVoice
_stop()

Reimplemented from: SFXVoice
_tell()

Reimplemented from: SFXVoice
Protected Static Functions
_linearToLogVolume(F32 linVolume)

Helper for converting floating point linear volume to a logrithmic integer volume for dsound.
Public Static Functions
create(SFXDSDevice * device, SFXDSBuffer * buffer)

Public Functions
~SFXDSVoice()

play(bool looping)

Reimplemented from: SFXVoice
setCone(F32 innerAngle, F32 outerAngle, F32 outerVolume)

Reimplemented from: SFXVoice
setMinMaxDistance(F32 min, F32 max)

Reimplemented from: SFXVoice
setPitch(F32 pitch)

Reimplemented from: SFXVoice
setTransform(const MatrixF & transform)

Reimplemented from: SFXVoice
setVelocity(const VectorF & velocity)

Reimplemented from: SFXVoice
setVolume(F32 volume)

Reimplemented from: SFXVoice