CeresEngine::AudioSourceComponent::Accessor Struct Reference

#include <CeresEngine/Audio/AudioSource.hpp>

Inheritance diagram for CeresEngine::AudioSourceComponent::Accessor:

Public Member Functions
double	getVolume () const
void	setVolume (double volume)
double	getMinimumVolume () const
void	setMinimumVolume (double minimumVolume)
double	getMaximumVolume () const
void	setMaximumVolume (double maximumVolume)
double	getPitch () const
void	setPitch (double pitch)
void	play (AudioAPIBufferPtr buffer)
Public Member Functions inherited from CeresEngine::Component< T >::Accessor
	Accessor (const Entity &entity)

Additional Inherited Members
Public Attributes inherited from CeresEngine::Component< T >::Accessor
const Entity &	entity
Protected Types inherited from CeresEngine::Component< T >::Accessor
using	C = TC
Protected Member Functions inherited from CeresEngine::Component< T >::Accessor
template<typename T >
auto	mutate (T C::*ptr)
	Accesses an element from an existing Component.
template<typename MutatorFunc , typename T > requires (CInvocable<MutatorFunc, T&>)
decltype(auto)	mutate (MutatorFunc &&func, T C::*ptr)
	Accesses an element from an existing Component.
template<typename T1 , typename T2 , typename... Ts>
Tuple< ComponentFieldMutator< T1, C >, ComponentFieldMutator< T2, C >, ComponentFieldMutator< Ts, C >... >	mutate (T1 C::*ptr1, T2 C::*ptr2, Ts C::*... ptrs)
	TODO Write docs.
template<typename MutatorFunc , typename T1 , typename T2 , typename... Ts>
Tuple< ComponentFieldMutator< T1, C >, ComponentFieldMutator< T2, C >, ComponentFieldMutator< Ts, C >... >	mutate (MutatorFunc &&func, T1 C::*ptr1, T2 C::*ptr2, Ts C::*... ptr)
template<typename T >
auto	get (T C::*ptr)
	Accesses an element from an existing Component.
template<typename T1 , typename T2 , typename... Ts>
Tuple< ComponentFieldMutator< T1, C >, ComponentFieldMutator< T2, C >, ComponentFieldMutator< Ts, C >... >	get (T1 C::*ptr1, T2 C::*ptr2, Ts C::*... ptrs)
	Accesses an element from an existing Component.
template<typename T >
const T &	read (const T C::*ptr) const
	Accesses an element from an existing Component.
template<typename T1 , typename T2 , typename... Ts>
Tuple< const T1 &, const T2 &, const Ts &... >	read (const T1 C::*ptr1, const T2 C::*ptr2, const Ts C::*... ptrs) const
	TODO Write docs.
template<typename T >
const T &	get (const T C::*ptr) const
	Accesses an element from an existing Component.
template<typename T1 , typename T2 , typename... Ts>
Tuple< const T1 &, const T2 &, const Ts &... >	get (const T1 C::*ptr1, const T2 C::*ptr2, const Ts C::*... ptrs) const
	Accesses an element from an existing Component.

Member Function Documentation

getMaximumVolume()

double CeresEngine::AudioSourceComponent::Accessor::getMaximumVolume

(

)

const

Returns

The source maximum volume

getMinimumVolume()

double CeresEngine::AudioSourceComponent::Accessor::getMinimumVolume

(

)

const

Returns

The source minimum volume

getPitch()

double CeresEngine::AudioSourceComponent::Accessor::getPitch

(

)

const

Returns

The pitch multiplier. Always positive.

getVolume()

double CeresEngine::AudioSourceComponent::Accessor::getVolume

(

)

const

Returns

The source volume. Value should be positive.

play()

void CeresEngine::AudioSourceComponent::Accessor::play

(

AudioAPIBufferPtr

buffer

)

setMaximumVolume()

void CeresEngine::AudioSourceComponent::Accessor::setMaximumVolume

(

double

maximumVolume

)

Parameters

maximumVolume

The source maximum volume

setMinimumVolume()

void CeresEngine::AudioSourceComponent::Accessor::setMinimumVolume

(

double

minimumVolume

)

Parameters

minimumVolume

The source minimum volume

setPitch()

void CeresEngine::AudioSourceComponent::Accessor::setPitch

(

double

pitch

)

Parameters

pitch

The pitch multiplier. Always positive.

setVolume()

void CeresEngine::AudioSourceComponent::Accessor::setVolume

(

double

volume

)

Parameters

volume

The source volume. Value should be positive.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Audio/AudioSource.hpp