Struct bevy_rng::Rng

pub struct Rng { /* fields omitted */ }

The Rng resource.

This wraps a random number generator.

See the rand::Rng trait for more details on how to generate random data.

Methods from Deref<Target = Xoshiro256StarStar>

pub fn jump(&mut self)

Jump forward, equivalently to 2^128 calls to next_u64().

This can be used to generate 2^128 non-overlapping subsequences for parallel computations.

use rand_xoshiro::rand_core::SeedableRng;
use rand_xoshiro::Xoshiro256StarStar;

let rng1 = Xoshiro256StarStar::seed_from_u64(0);
let mut rng2 = rng1.clone();
rng2.jump();
let mut rng3 = rng2.clone();
rng3.jump();

pub fn long_jump(&mut self)

Jump forward, equivalently to 2^192 calls to next_u64().

This can be used to generate 2^64 starting points, from each of which jump() will generate 2^64 non-overlapping subsequences for parallel distributed computations.

Trait Implementations

impl Clone for Rng

fn clone(&self) -> Rng

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Rng

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for Rng

type Target = Xoshiro256StarStar

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Rng

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for Rng

impl FromResources for Rng

fn from_resources(resources: &Resources) -> Self

Creates Self using data from the Resources collection

impl PartialEq<Rng> for Rng

fn eq(&self, other: &Rng) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rng) -> bool

This method tests for !=.

impl StructuralEq for Rng

impl StructuralPartialEq for Rng