Struct SDL_AudioDeviceID 

#[repr(transparent)]
pub struct SDL_AudioDeviceID(pub Uint32);

SDL Audio Device instance IDs.

Zero is used to signify an invalid/null device.

Availability

This datatype is available since SDL 3.2.0.

Known values (sdl3-sys)

Associated constant	Global constant	Description
DEFAULT_PLAYBACK	SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK	A value used to request a default playback audio device. Several functions that require an SDL_AudioDeviceID will accept this value to signify the app just wants the system to choose a default device instead of the app providing a specific one. \since This macro is available since SDL 3.2.0.
DEFAULT_RECORDING	SDL_AUDIO_DEVICE_DEFAULT_RECORDING	A value used to request a default recording audio device. Several functions that require an SDL_AudioDeviceID will accept this value to signify the app just wants the system to choose a default device instead of the app providing a specific one. \since This macro is available since SDL 3.2.0.

Tuple Fields

0: Uint32

Implementations

impl SDL_AudioDeviceID

pub const DEFAULT_PLAYBACK: Self

A value used to request a default playback audio device.

Several functions that require an SDL_AudioDeviceID will accept this value to signify the app just wants the system to choose a default device instead of the app providing a specific one.

Availability

This macro is available since SDL 3.2.0.

pub const DEFAULT_RECORDING: Self

A value used to request a default recording audio device.

Several functions that require an SDL_AudioDeviceID will accept this value to signify the app just wants the system to choose a default device instead of the app providing a specific one.

Availability

This macro is available since SDL 3.2.0.

Trait Implementations

impl Clone for SDL_AudioDeviceID

fn clone(&self) -> SDL_AudioDeviceID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_AudioDeviceID

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_AudioDeviceID

fn default() -> SDL_AudioDeviceID

Returns the “default value” for a type.

impl From<SDL_AudioDeviceID> for Uint32

fn from(value: SDL_AudioDeviceID) -> Self

Converts to this type from the input type.

impl GroupMetadata for SDL_AudioDeviceID

Available on crate feature metadata only.

const GROUP_METADATA: &'static Group

Metadata for this group

impl Hash for SDL_AudioDeviceID

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_AudioDeviceID

fn cmp(&self, other: &SDL_AudioDeviceID) -> 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_AudioDeviceID> for Uint32

fn eq(&self, other: &SDL_AudioDeviceID) -> 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_AudioDeviceID

fn eq(&self, other: &Uint32) -> 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_AudioDeviceID

fn eq(&self, other: &SDL_AudioDeviceID) -> 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_AudioDeviceID

fn partial_cmp(&self, other: &SDL_AudioDeviceID) -> 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_AudioDeviceID

impl Eq for SDL_AudioDeviceID

impl StructuralPartialEq for SDL_AudioDeviceID