oalplus::ALUtilityToolkit Class Reference

Wrapper for the ALUT library. More...

#include </home/chochlik/devel/oglplus/include/oalplus/alut.hpp>

Public Member Functions
	ALUtilityToolkit (bool with_context, int argc, char **argv)
	Initializes the alut library, optionally with a context. More...
	ALUtilityToolkit (bool with_context)
	Initializes the alut library, optionally with a context. More...
	ALUtilityToolkit (ALUtilityToolkit &&tmp)
	Move construction.
	~ALUtilityToolkit (void)
	Cleans up the ALUT library. More...
Buffer	CreateBufferHelloWorld (void) const
	Create a buffer containing the samples of a 'Hello World' sound. More...
Buffer	CreateBufferFromFile (const ALchar *file_path) const
	Create a buffer containing the samples from a specified sound file. More...
std::vector< ALfloat >	LoadMemoryHelloWorldNormalized (DataFormat *data_format, ALfloat *frequency) const
	Loads samples of a 'Hello World' sound into a buffer. More...
std::vector< ALfloat >	LoadMemoryFromFileNormalized (const ALchar *file_path, DataFormat *data_format, ALfloat *frequency) const
	Loads samples from a sound file into a buffer. More...
std::vector< ALubyte >	LoadMemoryFromFile (const ALchar *file_path, DataFormat *data_format, ALfloat *frequency) const
	Loads samples from a sound file into a buffer. More...
void	LoadMemoryFromFile (std::vector< ALubyte > &raw, std::vector< ALfloat > &norm, const ALchar *file_path, DataFormat *data_format, ALfloat *frequency) const
	Loads samples from a sound file into a buffer. More...

Detailed Description

Wrapper for the ALUT library.

Examples:

oalplus/001_hello.cpp, and oalplus/002_hello_path.cpp.

Constructor & Destructor Documentation

oalplus::ALUtilityToolkit::ALUtilityToolkit	(	bool	with_context,
		int	argc,
		char **	argv
	)

Initializes the alut library, optionally with a context.

Related OpenAL symbols:

alutInit alutInitWithoutContext

oalplus::ALUtilityToolkit::ALUtilityToolkit

(

bool

with_context

)

Initializes the alut library, optionally with a context.

Related OpenAL symbols:

alutInit alutInitWithoutContext

oalplus::ALUtilityToolkit::~ALUtilityToolkit

(

void

)

Cleans up the ALUT library.

Related OpenAL symbols:

alutExit

Member Function Documentation

Buffer oalplus::ALUtilityToolkit::CreateBufferFromFile

(

const ALchar *

file_path

)

const

Create a buffer containing the samples from a specified sound file.

See Also

CreateBufferHelloWorld

Related OpenAL symbols:

alutCreateBufferFromFile

Buffer oalplus::ALUtilityToolkit::CreateBufferHelloWorld

(

void

)

const

Create a buffer containing the samples of a 'Hello World' sound.

See Also

CreateBufferFromFile

Related OpenAL symbols:

alutCreateBufferHelloWorld

Examples:

oalplus/001_hello.cpp, and oalplus/002_hello_path.cpp.

std::vector<ALubyte> oalplus::ALUtilityToolkit::LoadMemoryFromFile	(	const ALchar *	file_path,
		DataFormat *	data_format,
		ALfloat *	frequency
	)		const

Loads samples from a sound file into a buffer.

See Also

LoadMemoryFromFileNormalized

LoadMemoryHelloWorldNormalized

Related OpenAL symbols:

alutLoadMemoryFromFile

Referenced by LoadMemoryFromFile(), and LoadMemoryFromFileNormalized().

void oalplus::ALUtilityToolkit::LoadMemoryFromFile	(	std::vector< ALubyte > &	raw,
		std::vector< ALfloat > &	norm,
		const ALchar *	file_path,
		DataFormat *	data_format,
		ALfloat *	frequency
	)		const

Loads samples from a sound file into a buffer.

This version loads both the raw data and the normalized samples into two buffers and also returns the format and the sampling frequency.

See Also

LoadMemoryFromFileNormalized

LoadMemoryHelloWorldNormalized

Related OpenAL symbols:

alutLoadMemoryFromFile

References LoadMemoryFromFile().

std::vector<ALfloat> oalplus::ALUtilityToolkit::LoadMemoryFromFileNormalized	(	const ALchar *	file_path,
		DataFormat *	data_format,
		ALfloat *	frequency
	)		const

Loads samples from a sound file into a buffer.

This version normalizes the sound samples.

See Also

LoadMemoryHelloWorldNormalized

LoadMemoryFromFile

Related OpenAL symbols:

alutLoadMemoryFromFile

References LoadMemoryFromFile().

std::vector<ALfloat> oalplus::ALUtilityToolkit::LoadMemoryHelloWorldNormalized	(	DataFormat *	data_format,
		ALfloat *	frequency
	)		const

Loads samples of a 'Hello World' sound into a buffer.

This version normalizes the sound samples.

See Also

LoadMemoryFromFileNormalized

Related OpenAL symbols:

alutLoadMemoryHelloWorld

---

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

• /home/chochlik/devel/oglplus/include/oalplus/alut.hpp