Struct NoiseFn

pub struct NoiseFn<F, const WITH_SEED: bool>(pub F);

Wraps a function to make it implement Sample.

The function is expected to take one parameter for the point and optionally a seed parameter.

With a seed parameter it can be used for fractals:

use noise_functions::{ Noise, NoiseFn, Sample2, OpenSimplex2s };

let warped = NoiseFn(|point: [f32; 2], seed: i32| {
    let warp_x = OpenSimplex2s.seed(seed + 100).sample2(point);
    let warp_y = OpenSimplex2s.seed(seed + 200).sample2(point);
    let warped = [point[0] + warp_x, point[1] + warp_y];
    OpenSimplex2s.sample2(warped)
});

let warped_fbm = warped.fbm(3, 0.5, 2.0);

let value = warped_fbm.sample2([1.0, 2.0]);

Tuple Fields

0: F

Trait Implementations

impl<F, const WITH_SEED: bool> Noise for NoiseFn<F, WITH_SEED>

fn seed(self, seed: i32) -> Seeded<Self>

where Self: Sized,

Sets a seed to be sampled with.

fn frequency(self, frequency: f32) -> Frequency<Self>

where Self: Sized,

Modifies a noise with a frequency multiplier.

fn fbm(self, octaves: u32, gain: f32, lacunarity: f32) -> Fbm<Self>

where Self: Sized,

Creates a fractal from this noise with the provided octaves, gain and lacunarity.

fn ridged(self) -> Ridged<Self>

where Self: Sized,

Modifies a noise to create a peak at 0.

fn triangle_wave(self, frequency: f32) -> TriangleWave<Self>

where Self: Sized,

Applies a triangle wave to the output of a base noise function.

fn tileable(self, width: f32, height: f32) -> Tileable<Self>

where Self: Sized,

Creates a tileable 2D noise from a 4D noise.

fn mul_seed(self, value: i32) -> MulSeed<Self>

where Self: Sized,

Multiplies the seed by value.

impl<const DIM: usize, Point, F> Sample<DIM, Point> for NoiseFn<F, false>

where F: Fn(Point) -> f32,

fn sample(&self, point: Point) -> f32

impl<const DIM: usize, Point, F> Sample<DIM, Point> for NoiseFn<F, true>

where F: Fn(Point, i32) -> f32,

fn sample(&self, point: Point) -> f32

impl<const DIM: usize, Point, F> SampleWithSeed<DIM, Point> for NoiseFn<F, true>

where F: Fn(Point, i32) -> f32,

fn sample_with_seed(&self, point: Point, seed: i32) -> f32