Struct Noise 

pub struct Noise {
    pub kind: NoiseKind,
    pub seed: u32,
    pub frequency: f32,
    pub octaves: u32,
    pub lacunarity: f32,
    pub gain: f32,
    pub warp: f32,
}

Full-featured fractal noise. sample* return -1..1, sample01* return 0..1.

Fields

kind: NoiseKind

Base noise family used for each octave.

seed: u32

Deterministic lattice seed.

frequency: f32

Features per world unit.

octaves: u32

Number of layered octaves (1 = plain noise).

lacunarity: f32

Frequency multiplier between octaves.

gain: f32

Amplitude multiplier between octaves.

warp: f32

Domain warp strength (0 = off): bends the lookup position with more noise.

Implementations

impl Noise

pub fn new(kind: NoiseKind) -> Self

Creates fractal noise of the chosen family with default sampling parameters.

pub fn with_seed(self, seed: u32) -> Self

Builder: changes the deterministic lattice seed.

pub fn with_frequency(self, f: f32) -> Self

Builder: sets features per input unit.

pub fn with_octaves(self, o: u32) -> Self

Builder: sets the octave count; sampling clamps it to a bounded range.

pub fn with_warp(self, w: f32) -> Self

Builder: sets domain-warp strength; zero disables it.

pub fn sample3(&self, x: f32, y: f32, z: f32) -> f32

Samples three-dimensional fractal noise, nominally in -1..1. Octaves are bounded to 1..32; non-finite inputs or results return zero.

pub fn sample2(&self, x: f32, y: f32) -> f32

Samples the XY plane of the three-dimensional noise at Z = 0.

pub fn sample01(&self, x: f32, y: f32, z: f32) -> f32

Samples noise remapped and clamped into 0..1.

pub fn curl2(&self, x: f32, y: f32) -> Vec2

Divergence-free 2D flow field (for swirling particles, smoke, water).

pub fn image( &self, width: u32, height: u32, a: [f32; 3], b: [f32; 3], ) -> Vec<u8>

RGBA8 image with two colours blended by the noise value (a at 0, b at 1). Returns an empty image on invalid dimensions. Use Self::try_image for errors.

pub fn try_image( &self, width: u32, height: u32, a: [f32; 3], b: [f32; 3], ) -> Result<Vec<u8>, String>

Generates RGBA8 pixels with checked dimensions and a 16-million-pixel budget. Rejects zero sizes, non-finite colours and allocation-size overflow.

Trait Implementations

impl Clone for Noise

fn clone(&self) -> Noise

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Noise

impl Debug for Noise

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

Formats the value using the given formatter.

impl Default for Noise

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Noise

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Noise