Game Audio Module
A C++ audio system using miniaudio with Python bindings
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
audio::TrackHandle Struct Reference

Opaque handle types for audio objects. More...

#include <audio_manager.h>

Public Member Functions

constexpr bool IsValid () const
 
constexpr operator bool () const
 
constexpr uint32_t Value () const
 

Static Public Member Functions

static constexpr TrackHandle Invalid ()
 

Public Attributes

uint32_t value {0}
 

Friends

constexpr bool operator== (const TrackHandle &, const TrackHandle &)=default
 

Detailed Description

Opaque handle types for audio objects.

These typedefs define opaque handles that are used to reference audio objects. The actual implementation details are hidden from the user.

Strongly typed handle for audio tracks.

Member Function Documentation

◆ Invalid()

static constexpr TrackHandle audio::TrackHandle::Invalid ( )
inlinestaticconstexpr

◆ IsValid()

constexpr bool audio::TrackHandle::IsValid ( ) const
inlineconstexpr

◆ operator bool()

constexpr audio::TrackHandle::operator bool ( ) const
inlineexplicitconstexpr

◆ Value()

constexpr uint32_t audio::TrackHandle::Value ( ) const
inlineconstexpr

Friends And Related Symbol Documentation

◆ operator==

constexpr bool operator== ( const TrackHandle ,
const TrackHandle  
)
friend

Member Data Documentation

◆ value

uint32_t audio::TrackHandle::value {0}

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