Struct dalia::SoundHandle

ClassList > dalia > SoundHandle

Handle used to manage loaded sounds. This handle expires once the sound it is referencing is unloaded.

• #include <SoundControl.h>

Public Functions

Type	Name
uint64_t	GetRawId () const
SoundType	GetType () const
bool	IsValid () const
	SoundHandle () = default
	SoundHandle (uint64_t rawId)
bool	operator!= (const SoundHandle & other) const
bool	operator== (const SoundHandle & other) const

Public Functions Documentation

function GetRawId

inline uint64_t dalia::SoundHandle::GetRawId () const

Returns:

The underlying raw id of the handle.

---

function GetType

inline SoundType dalia::SoundHandle::GetType () const

Returns:

The type of sound (stream or resident) that this handle references.

---

function IsValid

inline bool dalia::SoundHandle::IsValid () const

Returns:

true if the handle has referenced a loaded sound at some point. Otherwise, false.

---

function SoundHandle [1/2]

dalia::SoundHandle::SoundHandle () = default

---

function SoundHandle [2/2]

inline explicit dalia::SoundHandle::SoundHandle (
    uint64_t rawId
) 

---

function operator!=

inline bool dalia::SoundHandle::operator!= (
    const SoundHandle & other
) const

---

function operator==

inline bool dalia::SoundHandle::operator== (
    const SoundHandle & other
) const

---

---

The documentation for this class was generated from the following file engine/include/dalia/audio/SoundControl.h