hx3d  1
2D/3D Simple Game Framework
Public Member Functions | Protected Attributes | List of all members
hx3d::audio::Effect Class Reference

Audio effect manipulation. More...

#include <effect.hpp>

Public Member Functions

virtual void onFunction (const int channel, const void *stream, const int length)
 Audio effect function. More...
 
virtual void onDone (const int channel)
 Audio effect done function. More...
 
int getChannel ()
 Get the audio channel related to the effect. More...
 
void * getStream ()
 Get the audio stream. More...
 
int getSampleSize ()
 Get the sample size. More...
 
bool hasProcessed ()
 Test if the effect has started.
 

Protected Attributes

bool _processed
 Has the effect started ?
 
int _channel
 Audio channel.
 
void * _stream
 Sound stream.
 
int _length
 Sound length.
 

Detailed Description

Audio effect manipulation.

You can inherit the effect to use a custom function/filter on a channel.

Definition at line 32 of file effect.hpp.

Member Function Documentation

int hx3d::audio::Effect::getChannel ( )

Get the audio channel related to the effect.

Returns
Audio channel

Definition at line 32 of file effect.cpp.

int hx3d::audio::Effect::getSampleSize ( )

Get the sample size.

Returns
Sample size

Definition at line 38 of file effect.cpp.

void * hx3d::audio::Effect::getStream ( )

Get the audio stream.

Returns
Audio stream

Definition at line 35 of file effect.cpp.

void hx3d::audio::Effect::onDone ( const int  channel)
virtual

Audio effect done function.

See also
AudioDevice::registerEffect
Parameters
channelAudio channel

Reimplemented in hx3d::audio::S16Converter.

Definition at line 30 of file effect.cpp.

void hx3d::audio::Effect::onFunction ( const int  channel,
const void *  stream,
const int  length 
)
virtual

Audio effect function.

See also
AudioDevice::registerEffect
Parameters
channelAudio channel
streamAudio stream
lengthSample length

Reimplemented in hx3d::audio::S16Converter.

Definition at line 29 of file effect.cpp.


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