Crate noise_functions

Source
Expand description

Fast and lightweight noise algorithm implementations.

Check out the live demo!

The implementation of these noise functions are from FastNoiseLite (github/crate).

§Examples

use noise_functions::{ Perlin, CellDistance, OpenSimplex2s, Sample2, Sample3, NoiseFn };

let point = [1.0, 2.0];

// perlin noise
let value = Perlin.sample2(point);

// seeded perlin noise
let value = Perlin.seed(42).sample2(point);

// fractal perlin noise
let value = Perlin.fbm(3, 0.5, 3.0).sample2(point);

// seeded fractal perlin noise
let value = Perlin.fbm(3, 0.5, 3.0).seed(42).sample2(point);

// perlin noise with adjusted frequency
let value = Perlin.frequency(3.0).sample2(point);

// cell distance (voronoi/worley) noise
let value = CellDistance.sample2(point);

// cell distance (voronoi/worley) noise with jitter multiplier
let value = CellDistance.jitter(0.5).sample2(point);

// domain warped OpenSimplex2s noise
let warped_noise = |point: [f32; 2]| {
    let warp_x = OpenSimplex2s.seed(1).sample2(point);
    let warp_y = OpenSimplex2s.seed(2).sample2(point);
    let warped = [point[0] + warp_x, point[1] + warp_y];
    OpenSimplex2s.sample2(warped)
};

let value = warped_noise(point);

let point = [1.0, 2.0, 3.0];

// 3d OpenSimplex2s noise
let value = OpenSimplex2s.sample3(point);

// 3d OpenSimplex2s noise with improved isotropy in the xy plane
let value = OpenSimplex2s.improve_xy().sample3(point);

§Feature flags

  • std (enabled by default) — Uses floating point functions from the standard library.
  • libm — Uses libm for floating point functions. Required for no_std.
  • nightly-simd — Adds support for sampling with simd types.

Modules§

Structs§

  • CellDistance
    2/3 dimensional noise of the distance to the closest cell
  • CellDistanceSq
    2/3 dimensional noise of the squared distance to the closest cell
  • CellValue
    2/3 dimensional noise of the value of the closest cell
  • Frequency
    Wraps a noise and modifies its frequency.
  • NoiseFn
    Wraps a function to make it implement Sample.
  • OpenSimplex2
    2/3 dimensional OpenSimplex2 noise. Fast variant.
  • OpenSimplex2s
    2/3 dimensional OpenSimplex2s noise. Smooth variant.
  • Perlin
    2/3 dimensional Perlin noise
  • Seeded
    Wraps a noise with a seed.
  • Value
    2/3 dimensional Value noise
  • ValueCubic
    2/3 dimensional Cubic Value noise

Traits§

  • Sample
    Trait for sampling noises.
  • Sample2
    Helper trait that provides sample2 as a shorthand for Sample<2, [f32; 2]>::sample.
  • Sample3
    Helper trait that provides sample3 as a shorthand for Sample<3, [f32; 3]>::sample.
  • Sample2anightly-simd
    Helper trait that provides sample2a as a shorthand for Sample<2, f32x2>::sample.
  • Sample3anightly-simd
    Helper trait that provides sample3a as a shorthand for Sample<3, f32x4>::sample.