Struct SDL_AudioFormat 

#[repr(transparent)]
pub struct SDL_AudioFormat(pub c_uint);

Audio format.

Availability

This enum is available since SDL 3.2.0.

See also

• SDL_AUDIO_BITSIZE
• SDL_AUDIO_BYTESIZE
• SDL_AUDIO_ISINT
• SDL_AUDIO_ISFLOAT
• SDL_AUDIO_ISBIGENDIAN
• SDL_AUDIO_ISLITTLEENDIAN
• SDL_AUDIO_ISSIGNED
• SDL_AUDIO_ISUNSIGNED

Known values (sdl3-sys)

Associated constant	Global constant	Description
UNKNOWN	SDL_AUDIO_UNKNOWN	Unspecified audio format
U8	SDL_AUDIO_U8	Unsigned 8-bit samples
S8	SDL_AUDIO_S8	Signed 8-bit samples
S16LE	SDL_AUDIO_S16LE	Signed 16-bit samples
S16BE	SDL_AUDIO_S16BE	As above, but big-endian byte order
S32LE	SDL_AUDIO_S32LE	32-bit integer samples
S32BE	SDL_AUDIO_S32BE	As above, but big-endian byte order
F32LE	SDL_AUDIO_F32LE	32-bit floating point samples
F32BE	SDL_AUDIO_F32BE	As above, but big-endian byte order
S16	SDL_AUDIO_S16	(target dependent)
S32	SDL_AUDIO_S32	(target dependent)
F32	SDL_AUDIO_F32	(target dependent)

Tuple Fields

0: c_uint

Implementations

impl SDL_AudioFormat

pub const UNKNOWN: Self

Unspecified audio format

pub const U8: Self

Unsigned 8-bit samples

pub const S8: Self

Signed 8-bit samples

pub const S16LE: Self

Signed 16-bit samples

pub const S16BE: Self

As above, but big-endian byte order

pub const S32LE: Self

32-bit integer samples

pub const S32BE: Self

As above, but big-endian byte order

pub const F32LE: Self

32-bit floating point samples

pub const F32BE: Self

As above, but big-endian byte order

pub const S16: Self = SDL_AUDIO_S16LE

pub const S32: Self = SDL_AUDIO_S32LE

pub const F32: Self = SDL_AUDIO_F32LE

Trait Implementations

impl Clone for SDL_AudioFormat

fn clone(&self) -> SDL_AudioFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SDL_AudioFormat

Available on crate feature debug-impls only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SDL_AudioFormat

fn default() -> SDL_AudioFormat

Returns the “default value” for a type.

impl From<SDL_AudioFormat> for c_uint

fn from(value: SDL_AudioFormat) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_AudioFormat

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_AudioFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SDL_AudioFormat

fn cmp(&self, other: &SDL_AudioFormat) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<SDL_AudioFormat> for c_uint

fn eq(&self, other: &SDL_AudioFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<u32> for SDL_AudioFormat

fn eq(&self, other: &c_uint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for SDL_AudioFormat

fn eq(&self, other: &SDL_AudioFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SDL_AudioFormat

fn partial_cmp(&self, other: &SDL_AudioFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SDL_AudioFormat

impl Eq for SDL_AudioFormat

impl StructuralPartialEq for SDL_AudioFormat