Cori::Audio::Sound::Descriptor Class Reference

Sound Descriptor meant to be used with AssetManager only. More...

#include <Sound.hpp>

Classes
struct	Hasher

Public Types
using	AssetType = Sound

Public Member Functions
constexpr	Descriptor (std::string name, std::filesystem::path path, const bool preDecode=true) noexcept
	Constructs a descriptor.
uint32_t	GetRuntimeID () const
constexpr bool	operator== (const Descriptor &other) const noexcept

Public Attributes
const std::filesystem::path	m_Path
const std::string	m_Name
const bool	m_PreDecode

Detailed Description

Sound Descriptor meant to be used with AssetManager only.

Definition at line 17 of file Sound.hpp.

Member Typedef Documentation

AssetType

using Cori::Audio::Sound::Descriptor::AssetType = Sound

Definition at line 32 of file Sound.hpp.

Constructor & Destructor Documentation

Descriptor()

Cori::Audio::Sound::Descriptor::Descriptor ( std::string name, std::filesystem::path path, const bool preDecode = true )

inlineconstexprnoexcept

Constructs a descriptor.

Parameters

name	Name to be assigned to the Sound.
path	Path to the audio asset.
preDecode	Whether to precede the audio or no. Generally you want to leave it at default.

Definition at line 25 of file Sound.hpp.

Member Function Documentation

GetRuntimeID()

uint32_t Cori::Audio::Sound::Descriptor::GetRuntimeID ( ) const

inlinenodiscard

Definition at line 34 of file Sound.hpp.

operator==()

bool Cori::Audio::Sound::Descriptor::operator== ( const Descriptor & other ) const

inlineconstexprnoexcept

Definition at line 36 of file Sound.hpp.

Here is the call graph for this function:

Member Data Documentation

m_Name

const std::string Cori::Audio::Sound::Descriptor::m_Name

Definition at line 47 of file Sound.hpp.

m_Path

const std::filesystem::path Cori::Audio::Sound::Descriptor::m_Path

Definition at line 46 of file Sound.hpp.

m_PreDecode

const bool Cori::Audio::Sound::Descriptor::m_PreDecode

Definition at line 48 of file Sound.hpp.

---

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

• Sound.hpp