20 lines
6.0 KiB
HTML
20 lines
6.0 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="This module holds local implementations of the `Distribution` trait for `Standard`, which allow certain Bevy math types (those whose values can be randomly generated without additional input other than an `Rng`) to be produced using `rand`’s APIs. It also holds `FromRng`, an ergonomic extension to that functionality which permits the omission of type annotations."><title>bevy_math::sampling::standard - 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="bevy_math" 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="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc mod"><!--[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><a class="logo-container" href="../../../bevy_math/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../bevy_math/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../../bevy_math/index.html">bevy_<wbr>math</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module standard</a></h2><h3><a href="#traits">Module Items</a></h3><ul class="block"><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In bevy_<wbr>math::<wbr>sampling</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">bevy_math</a>::<wbr><a href="../index.html">sampling</a></span><h1>Module <span>standard</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/bevy_math/sampling/standard.rs.html#1-99">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module holds local implementations of the <a href="../../../rand/distributions/distribution/trait.Distribution.html" title="trait rand::distributions::distribution::Distribution"><code>Distribution</code></a> trait for <a href="../../../rand/distributions/struct.Standard.html" title="struct rand::distributions::Standard"><code>Standard</code></a>, which
|
||
allow certain Bevy math types (those whose values can be randomly generated without additional
|
||
input other than an <a href="../../../rand/rng/trait.Rng.html" title="trait rand::rng::Rng"><code>Rng</code></a>) to be produced using <a href="../../../rand/index.html" title="mod rand"><code>rand</code></a>’s APIs. It also holds <a href="trait.FromRng.html" title="trait bevy_math::sampling::standard::FromRng"><code>FromRng</code></a>,
|
||
an ergonomic extension to that functionality which permits the omission of type annotations.</p>
|
||
<p>For instance:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>rng = StdRng::seed_from_u64(<span class="number">7313429298</span>);
|
||
<span class="comment">// Random direction using thread-local rng
|
||
</span><span class="kw">let </span>random_direction1: Dir3 = random();
|
||
|
||
<span class="comment">// Random direction using the rng constructed above
|
||
</span><span class="kw">let </span>random_direction2: Dir3 = rng.gen();
|
||
|
||
<span class="comment">// The same as the previous but with different syntax
|
||
</span><span class="kw">let </span>random_direction3 = Dir3::from_rng(<span class="kw-2">&mut </span>rng);
|
||
|
||
<span class="comment">// Five random directions, using Standard explicitly
|
||
</span><span class="kw">let </span>many_random_directions: Vec<Dir3> = rng.sample_iter(Standard).take(<span class="number">5</span>).collect();</code></pre></div>
|
||
</div></details><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.FromRng.html" title="trait bevy_math::sampling::standard::FromRng">FromRng</a></div><div class="desc docblock-short">Ergonomics trait for a type with a <a href="../../../rand/distributions/struct.Standard.html" title="struct rand::distributions::Standard"><code>Standard</code></a> distribution, allowing values to be generated
|
||
uniformly from an <a href="../../../rand/rng/trait.Rng.html" title="trait rand::rng::Rng"><code>Rng</code></a> by a method in its own namespace.</div></li></ul></section></div></main></body></html> |