mirror of
https://github.com/encounter/rust-sdl2.git
synced 2026-07-10 21:18:41 -07:00
48 lines
43 KiB
HTML
48 lines
43 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Channel` struct in crate `sdl2`."><meta name="keywords" content="rust, rustlang, rust-lang, Channel"><title>sdl2::mixer::Channel - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../sdl2/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Channel</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.all">all</a><a href="#method.expire">expire</a><a href="#method.fade_in">fade_in</a><a href="#method.fade_in_timed">fade_in_timed</a><a href="#method.fade_out">fade_out</a><a href="#method.get_chunk">get_chunk</a><a href="#method.get_fading">get_fading</a><a href="#method.get_volume">get_volume</a><a href="#method.halt">halt</a><a href="#method.is_paused">is_paused</a><a href="#method.is_playing">is_playing</a><a href="#method.pause">pause</a><a href="#method.play">play</a><a href="#method.play_timed">play_timed</a><a href="#method.post">post</a><a href="#method.resume">resume</a><a href="#method.set_distance">set_distance</a><a href="#method.set_panning">set_panning</a><a href="#method.set_position">set_position</a><a href="#method.set_reverse_stereo">set_reverse_stereo</a><a href="#method.set_volume">set_volume</a><a href="#method.unregister_all_effects">unregister_all_effects</a><a href="#method.unset_distance">unset_distance</a><a href="#method.unset_panning">unset_panning</a><a href="#method.unset_position">unset_position</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-PartialEq%3CChannel%3E">PartialEq<Channel></a><a href="#impl-StructuralPartialEq">StructuralPartialEq</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>sdl2</a>::<wbr><a href='index.html'>mixer</a></p><script>window.sidebarCurrent = {name: 'Channel', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#344' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>sdl2</a>::<wbr><a href='index.html'>mixer</a>::<wbr><a class="struct" href=''>Channel</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct Channel(pub <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>);</pre></div><div class='docblock'><p>Sound effect channel.</p>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#379-610' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.all' class="method"><code id='all.v'>pub fn <a href='#method.all' class='fnname'>all</a>() -> <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#381-383' title='goto source code'>[src]</a></h4><div class='docblock'><p>Represent for all channels (-1)</p>
|
||
</div><h4 id='method.post' class="method"><code id='post.v'>pub fn <a href='#method.post' class='fnname'>post</a>() -> <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#386-388' title='goto source code'>[src]</a></h4><div class='docblock'><p>This is the MIX_CHANNEL_POST (-2)</p>
|
||
</div><h4 id='method.set_volume' class="method"><code id='set_volume.v'>pub fn <a href='#method.set_volume' class='fnname'>set_volume</a>(self, volume: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#391-394' title='goto source code'>[src]</a></h4><div class='docblock'><p>Set the volume for any allocated channel.</p>
|
||
</div><h4 id='method.get_volume' class="method"><code id='get_volume.v'>pub fn <a href='#method.get_volume' class='fnname'>get_volume</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#397-400' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the channels volume on scale of 0 to 128.</p>
|
||
</div><h4 id='method.play' class="method"><code id='play.v'>pub fn <a href='#method.play' class='fnname'>play</a>(self, chunk: &<a class="struct" href="../../sdl2/mixer/struct.Chunk.html" title="struct sdl2::mixer::Chunk">Chunk</a>, loops: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#403-405' title='goto source code'>[src]</a></h4><div class='docblock'><p>Play chunk on channel, or if channel is -1, pick the first free unreserved channel.</p>
|
||
</div><h4 id='method.play_timed' class="method"><code id='play_timed.v'>pub fn <a href='#method.play_timed' class='fnname'>play_timed</a>(<br> self, <br> chunk: &<a class="struct" href="../../sdl2/mixer/struct.Chunk.html" title="struct sdl2::mixer::Chunk">Chunk</a>, <br> loops: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> ticks: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#407-417' title='goto source code'>[src]</a></h4><h4 id='method.fade_in' class="method"><code id='fade_in.v'>pub fn <a href='#method.fade_in' class='fnname'>fade_in</a>(<br> self, <br> chunk: &<a class="struct" href="../../sdl2/mixer/struct.Chunk.html" title="struct sdl2::mixer::Chunk">Chunk</a>, <br> loops: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> ms: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#420-422' title='goto source code'>[src]</a></h4><div class='docblock'><p>Play chunk on channel, or if channel is -1, pick the first free unreserved channel.</p>
|
||
</div><h4 id='method.fade_in_timed' class="method"><code id='fade_in_timed.v'>pub fn <a href='#method.fade_in_timed' class='fnname'>fade_in_timed</a>(<br> self, <br> chunk: &<a class="struct" href="../../sdl2/mixer/struct.Chunk.html" title="struct sdl2::mixer::Chunk">Chunk</a>, <br> loops: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> ms: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>, <br> ticks: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#424-443' title='goto source code'>[src]</a></h4><h4 id='method.pause' class="method"><code id='pause.v'>pub fn <a href='#method.pause' class='fnname'>pause</a>(self)</code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#446-451' title='goto source code'>[src]</a></h4><div class='docblock'><p>Pause channel, or all playing channels if -1 is passed in.</p>
|
||
</div><h4 id='method.resume' class="method"><code id='resume.v'>pub fn <a href='#method.resume' class='fnname'>resume</a>(self)</code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#454-459' title='goto source code'>[src]</a></h4><div class='docblock'><p>Unpause channel, or all playing and paused channels if -1 is passed in.</p>
|
||
</div><h4 id='method.halt' class="method"><code id='halt.v'>pub fn <a href='#method.halt' class='fnname'>halt</a>(self)</code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#462-467' title='goto source code'>[src]</a></h4><div class='docblock'><p>Halt channel playback</p>
|
||
</div><h4 id='method.expire' class="method"><code id='expire.v'>pub fn <a href='#method.expire' class='fnname'>expire</a>(self, ticks: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#470-473' title='goto source code'>[src]</a></h4><div class='docblock'><p>Halt channel playback, after ticks milliseconds.</p>
|
||
</div><h4 id='method.fade_out' class="method"><code id='fade_out.v'>pub fn <a href='#method.fade_out' class='fnname'>fade_out</a>(self, ms: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i32.html">i32</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#476-479' title='goto source code'>[src]</a></h4><div class='docblock'><p>Gradually fade out which channel over ms milliseconds starting from now.</p>
|
||
</div><h4 id='method.is_playing' class="method"><code id='is_playing.v'>pub fn <a href='#method.is_playing' class='fnname'>is_playing</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#482-485' title='goto source code'>[src]</a></h4><div class='docblock'><p>if channel is playing, or not.</p>
|
||
</div><h4 id='method.is_paused' class="method"><code id='is_paused.v'>pub fn <a href='#method.is_paused' class='fnname'>is_paused</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#488-491' title='goto source code'>[src]</a></h4><div class='docblock'><p>if channel is paused, or not.</p>
|
||
</div><h4 id='method.get_fading' class="method"><code id='get_fading.v'>pub fn <a href='#method.get_fading' class='fnname'>get_fading</a>(self) -> <a class="enum" href="../../sdl2/mixer/enum.Fading.html" title="enum sdl2::mixer::Fading">Fading</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#494-502' title='goto source code'>[src]</a></h4><div class='docblock'><p>if channel is fading in, out, or not</p>
|
||
</div><h4 id='method.get_chunk' class="method"><code id='get_chunk.v'>pub fn <a href='#method.get_chunk' class='fnname'>get_chunk</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="../../sdl2/mixer/struct.Chunk.html" title="struct sdl2::mixer::Chunk">Chunk</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#505-516' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the most recent sample chunk pointer played on channel.</p>
|
||
</div><h4 id='method.unregister_all_effects' class="method"><code id='unregister_all_effects.v'>pub fn <a href='#method.unregister_all_effects' class='fnname'>unregister_all_effects</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#519-527' title='goto source code'>[src]</a></h4><div class='docblock'><p>This removes all effects registered to channel.</p>
|
||
</div><h4 id='method.set_panning' class="method"><code id='set_panning.v'>pub fn <a href='#method.set_panning' class='fnname'>set_panning</a>(self, left: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, right: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#531-539' title='goto source code'>[src]</a></h4><div class='docblock'><p>Sets a panning effect, where left and right is the volume of the left and right channels.
|
||
They range from 0 (silence) to 255 (loud).</p>
|
||
</div><h4 id='method.unset_panning' class="method"><code id='unset_panning.v'>pub fn <a href='#method.unset_panning' class='fnname'>unset_panning</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#542-550' title='goto source code'>[src]</a></h4><div class='docblock'><p>Unregisters panning effect.</p>
|
||
</div><h4 id='method.set_distance' class="method"><code id='set_distance.v'>pub fn <a href='#method.set_distance' class='fnname'>set_distance</a>(self, distance: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#554-562' title='goto source code'>[src]</a></h4><div class='docblock'><p>This effect simulates a simple attenuation of volume due to distance.
|
||
distance ranges from 0 (close/loud) to 255 (far/quiet).</p>
|
||
</div><h4 id='method.unset_distance' class="method"><code id='unset_distance.v'>pub fn <a href='#method.unset_distance' class='fnname'>unset_distance</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#565-573' title='goto source code'>[src]</a></h4><div class='docblock'><p>Unregisters distance effect.</p>
|
||
</div><h4 id='method.set_position' class="method"><code id='set_position.v'>pub fn <a href='#method.set_position' class='fnname'>set_position</a>(self, angle: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i16.html">i16</a>, distance: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#578-586' title='goto source code'>[src]</a></h4><div class='docblock'><p>This effect emulates a simple 3D audio effect.
|
||
angle ranges from 0 to 360 degrees going clockwise, where 0 is directly in front.
|
||
distance ranges from 0 (close/loud) to 255 (far/quiet).</p>
|
||
</div><h4 id='method.unset_position' class="method"><code id='unset_position.v'>pub fn <a href='#method.unset_position' class='fnname'>unset_position</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#589-597' title='goto source code'>[src]</a></h4><div class='docblock'><p>Unregisters position effect.</p>
|
||
</div><h4 id='method.set_reverse_stereo' class="method"><code id='set_reverse_stereo.v'>pub fn <a href='#method.set_reverse_stereo' class='fnname'>set_reverse_stereo</a>(self, flip: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#601-609' title='goto source code'>[src]</a></h4><div class='docblock'><p>Simple reverse stereo, swaps left and right channel sound.
|
||
true for reverse, false to unregister effect.</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
</div></div><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></div><h3 id='impl-PartialEq%3CChannel%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-PartialEq%3CChannel%3E' class='anchor'></a><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
||
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
||
</div></div><h3 id='impl-StructuralPartialEq' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-StructuralPartialEq' class='anchor'></a><a class='srclink' href='../../src/sdl2/mixer/mod.rs.html#343' title='goto source code'>[src]</a></h3><div class='impl-items'></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../sdl2/mixer/struct.Channel.html" title="struct sdl2::mixer::Channel">Channel</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#108-112' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#109-111' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-217' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214-216' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220-224' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221-223' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#565-569' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#566-568' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#554-561' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#558-560' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#80-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#602-611' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#608-610' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588-597' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#594-596' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "sdl2";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |