24 lines
16 KiB
HTML
24 lines
16 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="Represents a value of a single sample."><title>Sample in rodio - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rodio" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rodio/index.html">rodio</a><span class="version">0.19.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Sample</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.amplify" title="amplify">amplify</a></li><li><a href="#tymethod.lerp" title="lerp">lerp</a></li><li><a href="#tymethod.saturating_add" title="saturating_add">saturating_add</a></li><li><a href="#tymethod.zero_value" title="zero_value">zero_value</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Sample-for-f32" title="f32">f32</a></li><li><a href="#impl-Sample-for-i16" title="i16">i16</a></li><li><a href="#impl-Sample-for-u16" title="u16">u16</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rodio</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">rodio</a></span><h1>Trait <span class="trait">Sample</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/rodio/conversions/sample.rs.html#74-88">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Sample: <a class="trait" href="../dasp_sample/trait.Sample.html" title="trait dasp_sample::Sample">CpalSample</a> {
|
|
// Required methods
|
|
fn <a href="#tymethod.lerp" class="fn">lerp</a>(first: Self, second: Self, numerator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, denominator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.amplify" class="fn">amplify</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.saturating_add" class="fn">saturating_add</a>(self, other: Self) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.zero_value" class="fn">zero_value</a>() -> Self;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represents a value of a single sample.</p>
|
|
<p>This trait is implemented by default on three types: <code>i16</code>, <code>u16</code> and <code>f32</code>.</p>
|
|
<ul>
|
|
<li>For <code>i16</code>, silence corresponds to the value <code>0</code>. The minimum and maximum amplitudes are
|
|
represented by <code>i16::min_value()</code> and <code>i16::max_value()</code> respectively.</li>
|
|
<li>For <code>u16</code>, silence corresponds to the value <code>u16::max_value() / 2</code>. The minimum and maximum
|
|
amplitudes are represented by <code>0</code> and <code>u16::max_value()</code> respectively.</li>
|
|
<li>For <code>f32</code>, silence corresponds to the value <code>0.0</code>. The minimum and maximum amplitudes are
|
|
represented by <code>-1.0</code> and <code>1.0</code> respectively.</li>
|
|
</ul>
|
|
<p>You can implement this trait on your own type as well if you wish so.</p>
|
|
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.lerp" class="method"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#79">Source</a><h4 class="code-header">fn <a href="#tymethod.lerp" class="fn">lerp</a>(first: Self, second: Self, numerator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, denominator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> Self</h4></section></summary><div class="docblock"><p>Linear interpolation between two samples.</p>
|
|
<p>The result should be equal to
|
|
<code>first * numerator / denominator + second * (1 - numerator / denominator)</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.amplify" class="method"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#81">Source</a><h4 class="code-header">fn <a href="#tymethod.amplify" class="fn">amplify</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> Self</h4></section></summary><div class="docblock"><p>Multiplies the value of this sample by the given amount.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.saturating_add" class="method"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#84">Source</a><h4 class="code-header">fn <a href="#tymethod.saturating_add" class="fn">saturating_add</a>(self, other: Self) -> Self</h4></section></summary><div class="docblock"><p>Calls <code>saturating_add</code> on the sample.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.zero_value" class="method"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#87">Source</a><h4 class="code-header">fn <a href="#tymethod.zero_value" class="fn">zero_value</a>() -> Self</h4></section></summary><div class="docblock"><p>Returns the value corresponding to the absence of sound.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Sample-for-f32" class="impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#139-159">Source</a><a href="#impl-Sample-for-f32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Sample.html" title="trait rodio::Sample">Sample</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="method.lerp" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#141-143">Source</a><a href="#method.lerp" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.lerp" class="fn">lerp</a>(first: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>, second: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>, numerator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, denominator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h4></section><section id="method.amplify" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#146-148">Source</a><a href="#method.amplify" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.amplify" class="fn">amplify</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h4></section><section id="method.saturating_add" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#151-153">Source</a><a href="#method.saturating_add" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_add" class="fn">saturating_add</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h4></section><section id="method.zero_value" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#156-158">Source</a><a href="#method.zero_value" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero_value" class="fn">zero_value</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Sample-for-i16" class="impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#116-137">Source</a><a href="#impl-Sample-for-i16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Sample.html" title="trait rodio::Sample">Sample</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h3></section></summary><div class="impl-items"><section id="method.lerp-1" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#118-121">Source</a><a href="#method.lerp-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.lerp" class="fn">lerp</a>(first: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a>, second: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a>, numerator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, denominator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h4></section><section id="method.amplify-1" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#124-126">Source</a><a href="#method.amplify-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.amplify" class="fn">amplify</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h4></section><section id="method.saturating_add-1" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#129-131">Source</a><a href="#method.saturating_add-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_add" class="fn">saturating_add</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h4></section><section id="method.zero_value-1" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#134-136">Source</a><a href="#method.zero_value-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero_value" class="fn">zero_value</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.i16.html">i16</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Sample-for-u16" class="impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#90-114">Source</a><a href="#impl-Sample-for-u16" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Sample.html" title="trait rodio::Sample">Sample</a> for <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h3></section></summary><div class="impl-items"><section id="method.lerp-2" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#92-98">Source</a><a href="#method.lerp-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.lerp" class="fn">lerp</a>(first: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a>, second: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a>, numerator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, denominator: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h4></section><section id="method.amplify-2" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#101-103">Source</a><a href="#method.amplify-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.amplify" class="fn">amplify</a>(self, value: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h4></section><section id="method.saturating_add-2" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#106-108">Source</a><a href="#method.saturating_add-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.saturating_add" class="fn">saturating_add</a>(self, other: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h4></section><section id="method.zero_value-2" class="method trait-impl"><a class="src rightside" href="../src/rodio/conversions/sample.rs.html#111-113">Source</a><a href="#method.zero_value-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.zero_value" class="fn">zero_value</a>() -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u16.html">u16</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/rodio/conversions/sample/trait.Sample.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |