Crate noise_functions

Fast and lightweight noise algorithm implementations.

Check out the live demo!

use noise_functions::{ Perlin, CellDistance, OpenSimplex2s, Sample2, 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) noise
let value = CellDistance.sample2(point);

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

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

let value = warped_noise(point);

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

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.
• nightly-const-fn-float — Makes fbm(_weighted) and ridged(_weighted) const fns.

Modules

• cellular
• open_simplex

Structs

• CellDistance
• CellDistanceSq
• CellValue
• Fbm
• FbmWeighted
• Frequency
• NoiseFn
  Wraps a function to make it implement Sample.
• OpenSimplex2
• OpenSimplex2s
• Perlin
• PingPong
• PingPongWeighted
• Ridged
• RidgedWeighted
• Seeded
• Value
• ValueCubic

Traits

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

Functions

• fractal_bounding
  Calculates the fractal_bounding property for Fbm, FbmWeighted, Ridged and RidgedWeighted.