SFXDevice Class Reference

#include <sfxDevice.h>

Inheritance diagram for SFXDevice:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~SFXDevice ()
SFXProvidergetProvider () const
 Returns the provider which created this device.
bool getUseHardware () const
 Is the device set to use hardware processing.
S32 getMaxBuffers () const
 The maximum number of playback buffers this device will use.
virtual const char * getName () const =0
 Returns the name of this device.
virtual SFXBuffercreateBuffer (SFXProfile *profile)=0
 Tries to create a new sound buffer.
virtual SFXVoicecreateVoice (bool is3D, SFXBuffer *buffer)=0
virtual void deleteVoice (SFXVoice *buffer)=0
virtual U32 getVoiceCount () const =0
virtual void update (const SFXListener &listener)=0
 Called from SFXSystem to do any updates the device may need to make.

Static Public Member Functions

static SFXDeviceEventSignalgetEventSignal ()

Protected Member Functions

 SFXDevice (SFXProvider *provider, bool useHardware, S32 maxBuffers)

Protected Attributes

SFXProvidermProvider
 The provider which created this device.
bool mUseHardware
 Should the device try to use hardware processing.
S32 mMaxBuffers
 The maximum playback buffers this device will use.

Static Protected Attributes

static SFXDeviceEventSignal smEventSignal

Constructor & Destructor Documentation

SFXDevice::SFXDevice ( SFXProvider provider,
bool  useHardware,
S32  maxBuffers 
) [protected]

virtual SFXDevice::~SFXDevice (  )  [inline, virtual]


Member Function Documentation

static SFXDeviceEventSignal& SFXDevice::getEventSignal (  )  [inline, static]

SFXProvider* SFXDevice::getProvider (  )  const [inline]

Returns the provider which created this device.

bool SFXDevice::getUseHardware (  )  const [inline]

Is the device set to use hardware processing.

S32 SFXDevice::getMaxBuffers (  )  const [inline]

The maximum number of playback buffers this device will use.

virtual const char* SFXDevice::getName (  )  const [pure virtual]

Returns the name of this device.

Implemented in SFXDSDevice, SFXFMODDevice, SFXNullDevice, SFXALDevice, and SFXXAudioDevice.

virtual SFXBuffer* SFXDevice::createBuffer ( SFXProfile profile  )  [pure virtual]

Tries to create a new sound buffer.

If creation fails freeing another buffer will usually allow a new one to be created.

Parameters:
is3d True if a 3D sound buffer is desired.
channels The number of sound channels... typically 1 or 2.
frequency The number of samples per second ( a sample includes all channels ).
bitsPerSample The number of bits per sample ( a sample includes all channels ).
dataSize The total size of the buffer in bytes.
Returns:
Returns a new buffer or NULL if one cannot be created.

Implemented in SFXDSDevice, SFXFMODDevice, SFXNullDevice, SFXALDevice, and SFXXAudioDevice.

virtual SFXVoice* SFXDevice::createVoice ( bool  is3D,
SFXBuffer buffer 
) [pure virtual]

virtual void SFXDevice::deleteVoice ( SFXVoice buffer  )  [pure virtual]

virtual U32 SFXDevice::getVoiceCount (  )  const [pure virtual]

virtual void SFXDevice::update ( const SFXListener listener  )  [pure virtual]

Called from SFXSystem to do any updates the device may need to make.

Implemented in SFXDSDevice, SFXFMODDevice, SFXNullDevice, SFXALDevice, and SFXXAudioDevice.


Member Data Documentation

The provider which created this device.

Should the device try to use hardware processing.

The maximum playback buffers this device will use.