SDL::AudioFormat Class Reference

Audio format. More...

Public Member Functions
constexpr	AudioFormat (AudioFormatRaw audioFormat={}) noexcept
	Wraps AudioFormat.
constexpr	AudioFormat (bool sign, bool bigendian, bool flt, Uint16 size)
	Define an AudioFormat value.
constexpr	operator AudioFormatRaw () const noexcept
	Unwraps to the underlying AudioFormat.
constexpr Uint16	GetBitSize () const
	Retrieve the size, in bits, from an AudioFormat.
constexpr Uint16	GetByteSize () const
	Retrieve the size, in bytes, from an AudioFormat.
constexpr bool	IsFloat () const
	Determine if an AudioFormat represents floating point data.
constexpr bool	IsBigEndian () const
	Determine if an AudioFormat represents bigendian data.
constexpr bool	IsLittleEndian () const
	Determine if an AudioFormat represents littleendian data.
constexpr bool	IsSigned () const
	Determine if an AudioFormat represents signed data.
constexpr bool	IsInt () const
	Determine if an AudioFormat represents integer data.
constexpr bool	IsUnsigned () const
	Determine if an AudioFormat represents unsigned data.
const char *	GetName () const
	Get the human readable name of an audio format.
int	GetSilenceValue () const
	Get the appropriate memset value for silencing an audio format.

Detailed Description

Audio format.

Since

This enum is available since SDL 3.2.0.

See also

AudioFormat.GetBitSize

AudioFormat.GetByteSize

AudioFormat.IsInt

AudioFormat.IsFloat

AudioFormat.IsBigEndian

AudioFormat.IsLittleEndian

AudioFormat.IsSigned

AudioFormat.IsUnsigned

Constructor & Destructor Documentation

AudioFormat()

SDL::AudioFormat::AudioFormat ( AudioFormatRaw audioFormat = {} )

inlineconstexprnoexcept

Wraps AudioFormat.

Parameters

audioFormat

the value to be wrapped

Member Function Documentation

operator AudioFormatRaw()

SDL::AudioFormat::operator AudioFormatRaw ( ) const

inlineconstexprnoexcept

Unwraps to the underlying AudioFormat.

Returns

the underlying AudioFormatRaw.

---

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

• SDL3pp/SDL3pp_audio.h