VRS::SOUND::WaveFormBufferAL Class Reference

#include <vrs/openal/waveformbufferal.h>

Inheritance diagram for VRS::SOUND::WaveFormBufferAL:

List of all members.

Public Types
enum	WaveShape {   WAVEFORM_UNKNOWN = 0, WAVEFORM_SINE = ALUT_WAVEFORM_SINE, WAVEFORM_SQUARE = ALUT_WAVEFORM_SQUARE, WAVEFORM_SAWTOOTH = ALUT_WAVEFORM_SAWTOOTH,   WAVEFORM_WHITENOISE = ALUT_WAVEFORM_WHITENOISE, WAVEFORM_IMPULSE = ALUT_WAVEFORM_IMPULSE }
Public Member Functions
	VRS_SERIALIZABLE_CLASS_ENUM (WaveShape)
	WaveFormBufferAL (WaveShape waveShape, float waveFrequency, float phase, float duration)
void	setWaveShape (WaveShape waveShape)
WaveShape	getWaveShape (void) const
void	setWaveFrequency (float waveFrequency)
float	getWaveFrequency (void) const
void	setPhase (float phase)
float	getPhase (void) const
void	setDuration (float duration)
float	getDuration (void) const
virtual unsigned int	getName (void)
	VRS_TYPEINFO (WaveFormBufferAL, BufferAL)
	VRS_SERIALIZABLE (WaveFormBufferAL)
Protected Member Functions
	WaveFormBufferAL (void)

---

Member Enumeration Documentation

enum VRS::SOUND::WaveFormBufferAL::WaveShape

Enumerator:

WAVEFORM_UNKNOWN
WAVEFORM_SINE
WAVEFORM_SQUARE
WAVEFORM_SAWTOOTH
WAVEFORM_WHITENOISE
WAVEFORM_IMPULSE

---

Constructor & Destructor Documentation

VRS::SOUND::WaveFormBufferAL::WaveFormBufferAL	(	WaveShape	waveShape,
		float	waveFrequency,
		float	phase,
		float	duration
	)

VRS::SOUND::WaveFormBufferAL::WaveFormBufferAL

(

void

)

[protected]

---

Member Function Documentation

VRS::SOUND::WaveFormBufferAL::VRS_SERIALIZABLE_CLASS_ENUM

(

WaveShape

)

void VRS::SOUND::WaveFormBufferAL::setWaveShape

(

WaveShape

waveShape

)

Set/get the type of wave form of the buffer.

WaveShape VRS::SOUND::WaveFormBufferAL::getWaveShape

(

void

)

const [inline]

void VRS::SOUND::WaveFormBufferAL::setWaveFrequency

(

float

waveFrequency

)

Set the wave frequency in hertz.

float VRS::SOUND::WaveFormBufferAL::getWaveFrequency

(

void

)

const [inline]

void VRS::SOUND::WaveFormBufferAL::setPhase

(

float

phase

)

Set/get the phase in [-180.0, +180.0] of the buffer.

float VRS::SOUND::WaveFormBufferAL::getPhase

(

void

)

const [inline]

void VRS::SOUND::WaveFormBufferAL::setDuration

(

float

duration

)

Set/get the duration in seconds.

float VRS::SOUND::WaveFormBufferAL::getDuration

(

void

)

const [inline]

virtual unsigned int VRS::SOUND::WaveFormBufferAL::getName

(

void

)

[virtual]

Return the name of the buffer.

Reimplemented from VRS::SOUND::BufferAL.

VRS::SOUND::WaveFormBufferAL::VRS_TYPEINFO	(	WaveFormBufferAL	,
		BufferAL
	)

VRS::SOUND::WaveFormBufferAL::VRS_SERIALIZABLE

(

WaveFormBufferAL

)

---

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

• waveformbufferal.h