CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::ALSource Class Referencefinal

#include <CeresEngine/Audio/API/OpenAL/ALSource.hpp>

Inheritance diagram for CeresEngine::ALSource:
CeresEngine::AudioAPISource CeresEngine::RefCounted< AudioAPISource >

Public Member Functions

 ALSource (ALDevice &device, const AudioAPISourceDescriptor &descriptor)
 
 ~ALSource () final
 
void play () final
 
bool isPlaying () const final
 
void stop () final
 
bool isStopped () const final
 
void pause () final
 
bool isPaused () const final
 
void resume () final
 
void update (const AudioAPISourceDescriptor &descriptor) final
 
- Public Member Functions inherited from CeresEngine::AudioAPISource
 AudioAPISource ()=default
 The default constructor.
 
 AudioAPISource (const AudioAPISource &)=delete
 Deleted copy constructor.
 
AudioAPISourceoperator= (const AudioAPISource &)=delete
 Deleted copy assignment operator.
 
virtual ~AudioAPISource ()=default
 Destroys the audio source.
 
- Public Member Functions inherited from CeresEngine::RefCounted< AudioAPISource >
 RefCounted (Args &&... args)
 Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
 
void retain () noexcept
 Retains the object by increment it's reference count by one.
 
bool release () noexcept
 Relases the object by decrementing it's reference count by one.
 

Private Attributes

ALuint sourceID
 The OpenAL source ID.
 

Constructor & Destructor Documentation

◆ ALSource()

CeresEngine::ALSource::ALSource ( ALDevice device,
const AudioAPISourceDescriptor descriptor 
)
explicit

◆ ~ALSource()

CeresEngine::ALSource::~ALSource ( )
final

Member Function Documentation

◆ isPaused()

bool CeresEngine::ALSource::isPaused ( ) const
finalvirtual

◆ isPlaying()

bool CeresEngine::ALSource::isPlaying ( ) const
finalvirtual

◆ isStopped()

bool CeresEngine::ALSource::isStopped ( ) const
finalvirtual

◆ pause()

void CeresEngine::ALSource::pause ( )
finalvirtual

◆ play()

void CeresEngine::ALSource::play ( )
finalvirtual

◆ resume()

void CeresEngine::ALSource::resume ( )
finalvirtual

◆ stop()

void CeresEngine::ALSource::stop ( )
finalvirtual

◆ update()

void CeresEngine::ALSource::update ( const AudioAPISourceDescriptor descriptor)
finalvirtual

Member Data Documentation

◆ sourceID

ALuint CeresEngine::ALSource::sourceID
private

The OpenAL source ID.


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