Divide::OpenAL_API Class Reference

#include <ALWrapper.h>

Inheritance diagram for Divide::OpenAL_API:

Public Member Functions
	OpenAL_API (PlatformContext &context)
ErrorCode	initAudioAPI () noexcept override
void	closeAudioAPI () noexcept override
void	playSound (const Handle< AudioDescriptor > sound) noexcept override
void	playMusic (const Handle< AudioDescriptor > music) noexcept override
void	pauseMusic () noexcept override
void	stopMusic () noexcept override
void	stopAllSounds () noexcept override
void	setMusicVolume (I8 value) noexcept override
void	setSoundVolume (I8 value) noexcept override
Public Member Functions inherited from Divide::AudioAPIWrapper
	AudioAPIWrapper (const Str< 64 > &name, PlatformContext &context)
Public Member Functions inherited from Divide::PlatformContextComponent
	PlatformContextComponent (PlatformContext &context) noexcept
virtual	~PlatformContextComponent ()=default
PlatformContext &	context () noexcept
const PlatformContext &	context () const noexcept
Public Member Functions inherited from Divide::NonCopyable
	NonCopyable (const NonCopyable &)=delete
NonCopyable &	operator= (const NonCopyable &)=delete
	NonCopyable (NonCopyable &&)=default
NonCopyable &	operator= (NonCopyable &&)=default
Public Member Functions inherited from Divide::FrameListener
	FrameListener (const Str< 64 > &name, FrameListenerManager &parent, U32 callOrder)
	Either give it a name.
virtual	~FrameListener () override
bool	operator< (FrameListener &that) const noexcept
Public Member Functions inherited from Divide::GUIDWrapper
	GUIDWrapper () noexcept
	GUIDWrapper (const GUIDWrapper &old) noexcept
	GUIDWrapper (GUIDWrapper &&old) noexcept
virtual	~GUIDWrapper ()=default
FORCE_INLINE I64	getGUID () const noexcept
GUIDWrapper &	operator= (const GUIDWrapper &old)=delete
GUIDWrapper &	operator= (GUIDWrapper &&other)=delete

Protected Member Functions
void	musicFinished () noexcept override
Protected Member Functions inherited from Divide::AudioAPIWrapper
virtual bool	frameStarted (const FrameEvent &evt) override
virtual bool	frameEnded (const FrameEvent &evt) noexcept override
	frameEnded is called after the buffers have been swapped
virtual ErrorCode	initAudioAPI ()=0
virtual void	closeAudioAPI ()=0
virtual void	playSound (Handle< AudioDescriptor > sound)=0
virtual void	playMusic (Handle< AudioDescriptor > music)=0
virtual void	pauseMusic ()=0
virtual void	stopMusic ()=0
virtual void	stopAllSounds ()=0
virtual void	setMusicVolume (I8 value)=0
virtual void	setSoundVolume (I8 value)=0
virtual void	musicFinished ()=0
Protected Member Functions inherited from Divide::NonCopyable
	NonCopyable ()=default
	~NonCopyable ()=default
Protected Member Functions inherited from Divide::FrameListener
void	setCallOrder (const U32 order) noexcept
virtual bool	frameStarted (const FrameEvent &evt)
virtual bool	framePreRender (const FrameEvent &evt)
	framePreRenderStarted is called when we need to start processing the visual aspect of a scene
virtual bool	frameSceneRenderStarted (const FrameEvent &evt)
	frameSceneRenderStarted is called right before rendering the scene for the current player starts
virtual bool	frameSceneRenderEnded (const FrameEvent &evt)
	frameSceneRenderEnded is called immediately after scene rendering for the current player has ended but before any blitting operations
virtual bool	frameRenderingQueued (const FrameEvent &evt)
virtual bool	framePostRender (const FrameEvent &evt)
virtual bool	frameEnded (const FrameEvent &evt)
	frameEnded is called after the buffers have been swapped
	PROPERTY_R_IW (bool, enabled, false)
	PROPERTY_RW (Str< 64 >, name)

Private Attributes
U32	buffers [MAX_SOUND_BUFFERS] = {}

Additional Inherited Members
Public Types inherited from Divide::AudioAPIWrapper
using	MusicPlaylist = std::pair< U32, vector< Handle< AudioDescriptor > > >
using	MusicPlaylists = hashMap< U32, MusicPlaylist >
Static Public Member Functions inherited from Divide::GUIDWrapper
static I64	generateGUID () noexcept
Protected Attributes inherited from Divide::PlatformContextComponent
PlatformContext &	_context
Protected Attributes inherited from Divide::GUIDWrapper
const I64	_guid

Detailed Description

Definition at line 40 of file ALWrapper.h.

Constructor & Destructor Documentation

OpenAL_API()

Divide::OpenAL_API::OpenAL_API ( PlatformContext &  context )

explicit

Definition at line 10 of file ALWrapper.cpp.

Member Function Documentation

closeAudioAPI()

void Divide::OpenAL_API::closeAudioAPI ( )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 36 of file ALWrapper.cpp.

initAudioAPI()

ErrorCode Divide::OpenAL_API::initAudioAPI ( )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 15 of file ALWrapper.cpp.

musicFinished()

void Divide::OpenAL_API::musicFinished ( )

overrideprotectedvirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 52 of file ALWrapper.cpp.

pauseMusic()

void Divide::OpenAL_API::pauseMusic ( )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 42 of file ALWrapper.cpp.

playMusic()

void Divide::OpenAL_API::playMusic ( const Handle< AudioDescriptor >  music )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 40 of file ALWrapper.cpp.

playSound()

void Divide::OpenAL_API::playSound ( const Handle< AudioDescriptor >  sound )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 38 of file ALWrapper.cpp.

setMusicVolume()

void Divide::OpenAL_API::setMusicVolume ( I8  value )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 48 of file ALWrapper.cpp.

setSoundVolume()

void Divide::OpenAL_API::setSoundVolume ( I8  value )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 50 of file ALWrapper.cpp.

stopAllSounds()

void Divide::OpenAL_API::stopAllSounds ( )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 46 of file ALWrapper.cpp.

stopMusic()

void Divide::OpenAL_API::stopMusic ( )

overridevirtualnoexcept

Implements Divide::AudioAPIWrapper.

Definition at line 44 of file ALWrapper.cpp.

Member Data Documentation

buffers

U32 Divide::OpenAL_API::buffers[MAX_SOUND_BUFFERS] = {}

private

Definition at line 61 of file ALWrapper.h.

---

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

• G:/Divide-Framework/Source/Platform/Audio/openAl/Headers/ALWrapper.h
• G:/Divide-Framework/Source/Platform/Audio/openAl/ALWrapper.cpp