Struct sdl2::mixer::Group

source · [−]

pub struct Group(pub i32);

Expand description

Sound effect channel grouping.

Tuple Fields

0: i32

Implementations

source

impl Group

source

pub fn add_channels_range(self, from: i32, to: i32) -> i32

Add channels starting at from up through to to group tag, or reset it’s group to the default group tag (-1).

source

pub fn add_channel(self, Channel: Channel) -> bool

Add which channel to group tag, or reset it’s group to the default group tag

source

pub fn count(self) -> i32

Count the number of channels in group

source

pub fn find_available(self) -> Option<Channel>

Find the first available (not playing) channel in group

source

pub fn find_oldest(self) -> Option<Channel>

Find the oldest actively playing channel in group

source

pub fn find_newest(self) -> Option<Channel>

Find the newest, most recently started, actively playing channel in group.

source

pub fn fade_out(self, ms: i32) -> i32

Gradually fade out channels in group over some milliseconds starting from now. Returns the number of channels set to fade out.

source

pub fn halt(self)

Halt playback on all channels in group.

Trait Implementations

source

impl Clone for Group

source

fn clone(&self) -> Group

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Default for Group

source

fn default() -> Group

Returns the “default value” for a type. Read more

source

impl Copy for Group

Auto Trait Implementations

impl RefUnwindSafe for Group

impl Send for Group

impl Sync for Group

impl Unpin for Group

impl UnwindSafe for Group

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct sdl2::mixer::Group

Tuple Fields

Implementations

impl Group

pub fn add_channels_range(self, from: i32, to: i32) -> i32

pub fn add_channel(self, Channel: Channel) -> bool

pub fn count(self) -> i32

pub fn find_available(self) -> Option<Channel>

pub fn find_oldest(self) -> Option<Channel>

pub fn find_newest(self) -> Option<Channel>

pub fn fade_out(self, ms: i32) -> i32

pub fn halt(self)

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

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

impl Default for Group

fn default() -> Group

impl Copy for Group

Auto Trait Implementations

impl RefUnwindSafe for Group

impl Send for Group

impl Sync for Group

impl Unpin for Group

impl UnwindSafe for Group

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,