version 3.3

VRS::SOUND::BufferDataAL Class Reference

#include <vrs/openal/bufferdataal.h>

Inheritance diagram for VRS::SOUND::BufferDataAL:

VRS::SharedObj VRS::Visitable VRS::SOUND::FileDataAL VRS::SOUND::HelloWorldDataAL VRS::SOUND::MemoryDataAL VRS::SOUND::WaveFormDataAL

List of all members.

Public Types

enum  DataFormat {
  UNKNOWN = 0, MONO_8BIT = AL_FORMAT_MONO8, MONO_16BIT = AL_FORMAT_MONO16, STEREO_8BIT = AL_FORMAT_STEREO8,
  STEREO_16BIT = AL_FORMAT_STEREO16
}

Public Member Functions

 VRS_SERIALIZABLE_CLASS_ENUM (DataFormat)
virtual void * getPointer (void)
float getFrequency (void) const
unsigned int getSize (void) const
DataFormat getDataFormat (void) const
bool getModified (void) const
virtual void modified (void)
 VRS_TYPEINFO (BufferDataAL, SharedObj)
 VRS_SERIALIZABLE_ABSTRACT_CLASS (BufferDataAL)

Protected Member Functions

 BufferDataAL (void)
void setPointer (void *pointer)
void setFrequency (float frequency)
void setSize (unsigned int size)
void setDataFormat (DataFormat dataFormat)
void setModified (bool modified)


Member Enumeration Documentation

Enumerator:
UNKNOWN 
MONO_8BIT 
MONO_16BIT 
STEREO_8BIT 
STEREO_16BIT 


Constructor & Destructor Documentation

VRS::SOUND::BufferDataAL::BufferDataAL ( void   )  [protected]


Member Function Documentation

VRS::SOUND::BufferDataAL::VRS_SERIALIZABLE_CLASS_ENUM ( DataFormat   ) 

virtual void* VRS::SOUND::BufferDataAL::getPointer ( void   )  [inline, virtual]

Returns pointer to data. Pointer is NULL if data creation fails.

Reimplemented in VRS::SOUND::FileDataAL, VRS::SOUND::MemoryDataAL, and VRS::SOUND::WaveFormDataAL.

float VRS::SOUND::BufferDataAL::getFrequency ( void   )  const [inline]

Returns the sample frequency of the audio data.

unsigned int VRS::SOUND::BufferDataAL::getSize ( void   )  const [inline]

Returns the size of the buffer.

DataFormat VRS::SOUND::BufferDataAL::getDataFormat ( void   )  const [inline]

Returns the dataformat of the buffer.

bool VRS::SOUND::BufferDataAL::getModified ( void   )  const [inline]

Returns whether a buffer data property was modified.

virtual void VRS::SOUND::BufferDataAL::modified ( void   )  [virtual]

Reimplemented from VRS::SharedObj.

VRS::SOUND::BufferDataAL::VRS_TYPEINFO ( BufferDataAL  ,
SharedObj   
)

VRS::SOUND::BufferDataAL::VRS_SERIALIZABLE_ABSTRACT_CLASS ( BufferDataAL   ) 

void VRS::SOUND::BufferDataAL::setPointer ( void *  pointer  )  [protected]

void VRS::SOUND::BufferDataAL::setFrequency ( float  frequency  )  [protected]

void VRS::SOUND::BufferDataAL::setSize ( unsigned int  size  )  [protected]

void VRS::SOUND::BufferDataAL::setDataFormat ( DataFormat  dataFormat  )  [protected]

void VRS::SOUND::BufferDataAL::setModified ( bool  modified  )  [protected]


The documentation for this class was generated from the following file:

Generated on Wed May 22 06:00:38 2013 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact