[go: up one dir, main page]

Group

sdl2::mixer

Struct 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 duplicate 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 Freeze for Group

§

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§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.