Doxybook2 Example
Classes | Typedefs | Functions
Engine::Audio Namespace Reference

Classes

class  AudioBuffer
 A simple audio buffer to hold PCM samples More...
 
class  AudioManager
 An audio manager that accepts multiple Audio::AudioBuffer instances. More...
 

Typedefs

typedef int(* Callback) (AudioBuffer &buffer, size_t offset)
 Some callback function pointer type definition. More...
 
using Callback2 = int(*)(AudioBuffer &buffer, size_t offset, void *user)
 Some callback function pointer type definition. More...
 

Functions

void doSomething (AudioBuffer &buffer)
 Do something with the buffer. More...
 

Typedef Documentation

◆ Callback

typedef int(* Engine::Audio::Callback) (AudioBuffer &buffer, size_t offset)

Some callback function pointer type definition.

Parameters
bufferThe buffer this callback is called from
offsetThe offset of the buffer currently playing
Deprecated:
Use the Audio::Callback2 instead

◆ Callback2

using Engine::Audio::Callback2 = typedef int (*)(AudioBuffer& buffer, size_t offset, void* user)

Some callback function pointer type definition.

Parameters
bufferThe buffer this callback is called from
offsetThe offset of the buffer currently playing
userUser specific data

Function Documentation

◆ doSomething()

void Engine::Audio::doSomething ( AudioBuffer buffer)

Do something with the buffer.