SDL3pp
A slim C++ wrapper for SDL3
Loading...
Searching...
No Matches
SDL::AudioBase Struct Reference

Base class to Audio. More...

Inheritance diagram for SDL::AudioBase:
[legend]

Public Member Functions

void Destroy ()
 Destroy the specified audio.
PropertiesRef GetProperties ()
 Get the properties associated with a Audio.
Sint64 GetDuration ()
 Get the length of a Audio's playback in sample frames.
void GetFormat (AudioSpec *spec)
 Query the initial audio format of a Audio.
Sint64 MSToFrames (Milliseconds ms)
 Convert milliseconds to sample frames for a Audio's format.
Milliseconds FramesToMS (Sint64 frames)
 Convert sample frames for a Audio's format to milliseconds.
constexpr ResourceBaseT ()=default
 Default constructor, creates null/invalid resource.
constexpr ResourceBaseT (RawPointer resource)
 Constructs from resource pointer.
constexpr ResourceBaseT (std::nullptr_t)
 Constructs null/invalid.
constexpr ResourceBaseT (const ResourceBaseT &)=default
 Copy constructor.
constexpr ResourceBaseT (ResourceBaseT &&) noexcept=default
 Move constructor.
Public Member Functions inherited from SDL::ResourceBaseT< AudioRaw >
constexpr ResourceBaseT ()=default
 Default constructor, creates null/invalid resource.
constexpr operator bool () const
 Converts to bool.
constexpr auto operator<=> (const ResourceBaseT &other) const=default
 Comparison.
constexpr RawConstPointer operator-> () const noexcept
 member access to underlying resource pointer.
constexpr RawPointer get () const noexcept
 Retrieves underlying resource pointer.
constexpr RawPointer release () noexcept
 Retrieves underlying resource pointer and clear this.

Additional Inherited Members

Public Types inherited from SDL::ResourceBaseT< AudioRaw >
using RawPointer
 The underlying raw pointer type.
using RawConstPointer
 The underlying const raw pointer type.
Protected Member Functions inherited from SDL::ResourceBaseT< AudioRaw >
constexpr ~ResourceBaseT ()=default
 Destructor.
constexpr ResourceBaseToperator= (const ResourceBaseT &)=default
 Assignment operator.

Detailed Description

Base class to Audio.

See also
Audio

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