fge::SoundBuffer Class Reference

This class is a wrapper for the audio manager to allow easy manipulation. More...

#include <C_soundBuffer.hpp>

Inheritance diagram for fge::SoundBuffer:

Public Types
using	SharedDataType
using	SharedType

Public Member Functions
virtual void	clear ()
	Clear the resource.
void	reload ()
	Reload the cached resource from the same name.
bool	valid () const
	Check if the font is valid (not unloaded)
SharedDataType const &	getSharedBlock () const
	Get the resource block data.
SharedType const &	getSharedData () const
	Get the shared resource data.
std::string const &	getName () const
	Get the name of the resource.
manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >::Manager::DataType *	retrieve ()
	Retrieve the raw shared pointer from the current resource.
manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >::Manager::DataType *	retrieveValid ()
	Retrieve the raw shared pointer from the current resource only if the resource is valid.

Detailed Description

This class is a wrapper for the audio manager to allow easy manipulation.

Member Function Documentation

clear()

void fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::clear ( )

virtualinherited

Clear the resource.

This method clear the resource by setting it to the default/bad "valid" resource.

getName()

std::string const & fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::getName ( ) const

nodiscardinherited

Get the name of the resource.

Returns

The name of the resource, or an empty string if the resource is not valid

getSharedBlock()

BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::SharedDataType const & fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::getSharedBlock ( ) const

nodiscardinherited

Get the resource block data.

Warning

If ALLOW_VARIANT_OF_DATAPOINTER_AND_BLOCKPOINTER is set, this method can a "bad" element.

Returns

The resource block data

getSharedData()

BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::SharedType const & fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::getSharedData ( ) const

nodiscardinherited

Get the shared resource data.

Returns

The shared resource data

reload()

void fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::reload ( )

inherited

Reload the cached resource from the same name.

retrieve()

manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >::Manager::DataType * fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::retrieve ( )

nodiscardinherited

Retrieve the raw shared pointer from the current resource.

Warning

Will never be nullptr if the manager was correctly initialized.

Returns

The raw resource pointer

retrieveValid()

manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >::Manager::DataType * fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::retrieveValid ( )

nodiscardinherited

Retrieve the raw shared pointer from the current resource only if the resource is valid.

Returns

The raw resource pointer, or nullptr if the resource is not valid

valid()

bool fge::manager::BaseDataAccessor< manager::GlobalDataAccessorManagerInfo< audio::AudioManager, &audio::gManager >, TOption >::valid ( ) const

nodiscardinherited

Check if the font is valid (not unloaded)

Returns

True if the font is valid, false otherwise

---

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

• C_soundBuffer.hpp