Struct libnoise::NoiseBuffer

pub struct NoiseBuffer<const D: usize> {
    pub shape: [usize; D],
    pub offsets: [usize; D],
    pub buffer: Vec<f64>,
}

A struct for generating an n-dimensional array and efficiently filling it with noise values.

This struct represents a simple n-dimensional array which is stored as a flat vector. When creating a new NoiseBuffer using the new() method, only the length along each dimension and a noise generator, that is, an object implementing Generator, must be provided. The n-dimensional array is then filled with noise values. The implementation ensures, that the noise is computed in a way such that the underlying flat vector is written sequentially for maximal cache performance.

As NoiseBuffer implements the Index and IndexMut traits, it is possible to index the n-dimensional array with an index array of the appropriate length.

Creating a noise buffer

A noise buffer can be easily and efficiently created using the new() method. The resulting buffer will be filled with noise values according to the provided noise generator.

When filling the buffer, the specific value at a given buffer index is computed by sampling the generator with the index interpreted as coordinates in n-dimensional space. This means that the buffer samples the generator on points of a hypergrid:

// create a generator
let generator = Source::simplex(42);

// create a new noise buffer filled with noise values for each point
let buf = NoiseBuffer::<3>::new([30, 20, 25], &generator);

assert_eq!(buf[[17, 9, 21]], generator.sample([17.0, 9.0, 21.0]));

The scale or position of the grid can be modified by calling adapters such as scale(), translate(), or rotate() on the generator before using it to create a NoiseBuffer.

Fields

shape: [usize; D]

Stores the length of the n-dimensional array along each dimension.

offsets: [usize; D]

Stores offsets which are used to convert n-dimensional coordinates to flat vector indices.

buffer: Vec<f64>

The underlying flat vector storing the noise values.

Implementations

impl NoiseBuffer<1>

pub fn new<G: Generator<1>>(shape: [usize; 1], generator: &G) -> Self

Creates a new noise buffer with the given shape and filled with noise generated by the given generator. For further detail see the Creating a noise buffer section.

impl NoiseBuffer<2>

pub fn new<G: Generator<2>>(shape: [usize; 2], generator: &G) -> Self

Creates a new noise buffer with the given shape and filled with noise generated by the given generator. For further detail see the Creating a noise buffer section.

impl NoiseBuffer<3>

pub fn new<G: Generator<3>>(shape: [usize; 3], generator: &G) -> Self

Creates a new noise buffer with the given shape and filled with noise generated by the given generator. For further detail see the Creating a noise buffer section.

impl NoiseBuffer<4>

pub fn new<G: Generator<4>>(shape: [usize; 4], generator: &G) -> Self

Creates a new noise buffer with the given shape and filled with noise generated by the given generator. For further detail see the Creating a noise buffer section.

Trait Implementations

impl<const D: usize> Clone for NoiseBuffer<D>

fn clone(&self) -> NoiseBuffer<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const D: usize> Debug for NoiseBuffer<D>

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

Formats the value using the given formatter.

impl<const D: usize> From<NoiseBuffer<D>> for Visualizer<D>

fn from(noisebuf: NoiseBuffer<D>) -> Self

Converts to this type from the input type.

impl Index<[usize; 1]> for NoiseBuffer<1>

type Output = f64

The returned type after indexing.

fn index(&self, index: [usize; 1]) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<[usize; 2]> for NoiseBuffer<2>

type Output = f64

The returned type after indexing.

fn index(&self, index: [usize; 2]) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<[usize; 3]> for NoiseBuffer<3>

type Output = f64

The returned type after indexing.

fn index(&self, index: [usize; 3]) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<[usize; 4]> for NoiseBuffer<4>

type Output = f64

The returned type after indexing.

fn index(&self, index: [usize; 4]) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<[usize; 1]> for NoiseBuffer<1>

fn index_mut(&mut self, index: [usize; 1]) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<[usize; 2]> for NoiseBuffer<2>

fn index_mut(&mut self, index: [usize; 2]) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<[usize; 3]> for NoiseBuffer<3>

fn index_mut(&mut self, index: [usize; 3]) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<[usize; 4]> for NoiseBuffer<4>

fn index_mut(&mut self, index: [usize; 4]) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.