Struct dalia::EffectHandle

ClassList > dalia > EffectHandle

Handle used to manage effect instances. This handle expires once the effect it is referencing has been destroyed.

• #include <EffectControl.h>

Public Functions

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

Public Functions Documentation

function EffectHandle [1/2]

dalia::EffectHandle::EffectHandle () = default

---

function EffectHandle [2/2]

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

---

function GetRawId

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

Returns:

The underlying raw id of the handle.

---

function GetType

inline EffectType dalia::EffectHandle::GetType () const

Returns:

The type of effect the handle is referencing.

---

function IsValid

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

Returns:

true if the handle has referenced an effect at some point. Otherwise, false.

---

function operator!=

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

---

function operator==

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

---

---

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