Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

openalpp Namespace Reference


Classes

class  openalpp::AudioBase
class  openalpp::AudioConvert
struct  openalpp::_acAudioCVT
struct  openalpp::Chunk
struct  openalpp::MS_ADPCM_decodestate_FULL
struct  openalpp::WaveFMT
struct  openalpp::IMA_ADPCM_decodestate_s
struct  openalpp::IMA_ADPCM_decoder
class  openalpp::AudioEnvironment
class  openalpp::Error
class  openalpp::FatalError
class  openalpp::FileError
class  openalpp::MemoryError
class  openalpp::NameError
class  openalpp::ValueError
class  openalpp::InitError
class  openalpp::FileStream
class  openalpp::FileStreamUpdater
class  openalpp::GroupSource
class  openalpp::InputDevice
class  openalpp::Listener
class  openalpp::NetStream
class  openalpp::NetUpdater
class  openalpp::PositionedObject
class  openalpp::ref_ptr< T >
class  openalpp::Referenced
class  openalpp::DeleteHandler
class  openalpp::Sample
class  openalpp::SoundData
class  openalpp::SoundData::SoundBuffer
class  openalpp::Source
class  openalpp::SourceBase
class  openalpp::Stream
class  openalpp::StreamUpdater

Typedefs

typedef openalpp::_acAudioCVT acAudioCVT
typedef openalpp::Chunk Chunk
typedef openalpp::WaveFMT alWaveFMT_LOKI
typedef openalpp::IMA_ADPCM_decodestate_s alIMAADPCM_decodestate_LOKI
typedef openalpp::IMA_ADPCM_decoder alIMAADPCM_state_LOKI

Enumerations

enum  SampleFormat { Mono8, Stereo8, Mono16, Stereo16 }
enum  DistanceModel { None, InverseDistance, InverseDistanceClamped }
enum  SourceState { Initial, Playing, Paused, Stopped }

Functions

OPENALPP_API std::ostream & operator<< (std::ostream &stream, const Error &error)
unsigned int sampleSize (SampleFormat format)
unsigned int sampleSize (ALenum format)


Detailed Description

Namespace for OpenAL++.


Typedef Documentation

typedef struct openalpp::_acAudioCVT openalpp::acAudioCVT
 

typedef struct openalpp::IMA_ADPCM_decodestate_s openalpp::alIMAADPCM_decodestate_LOKI
 

typedef struct openalpp::IMA_ADPCM_decoder openalpp::alIMAADPCM_state_LOKI
 

typedef struct openalpp::WaveFMT openalpp::alWaveFMT_LOKI
 

typedef struct openalpp::Chunk openalpp::Chunk
 


Enumeration Type Documentation

enum DistanceModel
 

Enum for setting/getting the current distance model. None means no model is in use, i.e. no attenuation.
InverseDistance:

  • $G=GAIN-20*log_{10}*(1+ROLLOFF*\frac{dist-REFERENCE\_DISTANCE}{REFERENCE\_DISTANCE})$
  • $G=min (G,MAX\_GAIN)$
  • $G=max (G,MIN\_GAIN)$

InverseDistanceClamped:

  • $dist=max (dist,REFERENCE\_DISTANCE)$
  • $dist=min (dist,MAX\_DISTANCE)$
  • And then the calculations in InverseDistance... This is equivalent to the <a href="http://www.iasig.org>IASIG I3DL2 distance model.

In the above calculations, the variables have the following meanings:

  • dist is the distance from the listener to the source.
  • REFERENCE_DISTANCE are the distance at which the listener will experience GAIN. Both are set per source.
  • ROLLOFF is a source specific factor of attenuation. If it's set to one, the InverseDistance model will describe a "physically correct" inverse square behaviour.
  • MIN_GAIN, MAX_GAIN and MAX_DISTANCE are values used for clamping gain and distance, respectively.
Enumeration values:
None 
InverseDistance 
InverseDistanceClamped 

enum SampleFormat
 

Format for sound data. Mono/Stereo, 8 or 16 bits.

Enumeration values:
Mono8 
Stereo8 
Mono16 
Stereo16 

enum SourceState
 

Enum for the different states of a source. When a source is created, it is in the Initial state. Rewind will return a source to this state. The other states should be obvious.

Enumeration values:
Initial 
Playing 
Paused 
Stopped 


Function Documentation

OPENALPP_API std::ostream& operator<< std::ostream &  stream,
const Error &  error
 

Out stream operator. Used to print error messages to a stream (i.e. "cerr << error;").

Parameters:
stream is the stream to print to.
error is the error to print.
Returns:
the stream.

unsigned int sampleSize ALenum  format  ) 
 

unsigned int sampleSize SampleFormat  format  ) 
 

Check how large a sample is in the given format.


Generated on Thu Dec 9 14:08:13 2004 for openalpp by  doxygen 1.3.9.1