Struct ImprovedPerlin

pub struct ImprovedPerlin<const D: usize> { /* private fields */ }

A generator which produces n-dimensional improved perlin noise.

For details, see the documentation of improved_perlin(). Typically, this struct is not meant to be used directly. Instead, improved_perlin() implemented by Source, should be used to create an improved perlin noise generator.

Direct usage of this struct

Direct instantiation of this struct:

let generator = ImprovedPerlin::new(42);
let value = generator.sample([0.2, 0.5]);

Implementations

impl<const D: usize> ImprovedPerlin<D>

pub fn new(seed: impl Seed) -> Self

Create a new improved perlin noise generator.

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl Generator<1> for ImprovedPerlin<1>

fn sample(&self, point: [f64; 1]) -> f64

Samples the generator at a given point and returns the resulting value.

fn scale(self, scale: [f64; D]) -> Scale<D, Self>

Create a generator which scales input points before passing them to the underlying generator.

fn translate(self, translation: [f64; D]) -> Translate<D, Self>

Create a generator which translates input points before passing them to the underlying generator.

fn neg(self) -> Neg<D, Self>

Create a generator which negates the results of the underlying generator.

fn abs(self) -> Abs<D, Self>

Create a generator returning the absolute value of the results of the underlying generator.

fn exp(self) -> Exp<D, Self>

Create a generator applying the exponential function on results of the underlying generator.

fn add(self, offset: f64) -> Add<D, Self>

Create a generator adding offset to results of the underlying generator.

fn mul(self, scale: f64) -> Mul<D, Self>

Create a generator multiplying scale to results of the underlying generator.

fn powi(self, exponent: i32) -> Pow<D, Self, i32>

Create a generator raising results of the underlying generator to the power of exponent.

fn powf(self, exponent: f64) -> Pow<D, Self, f64>

Create a generator raising results of the underlying generator to the power of exponent.

fn clamp(self, min: f64, max: f64) -> Clamp<D, Self>

Create a generator clamping results of the underlying generator to a given interval.

fn lambda<L>(self, lambda: L) -> Lambda<D, Self, L>

where L: Fn(f64) -> f64,

Create a generator applying the supplied closure to results of the underlying generator.

fn sum<G>(self, other: G) -> Sum<D, Self, G>

where G: Generator<D>,

Create a generator adding results of the underlying generator to results of a given other generator.

fn product<G>(self, other: G) -> Product<D, Self, G>

where G: Generator<D>,

Create a generator multiplying results of the underlying generator to results of a given other generator.

fn min<G>(self, other: G) -> Min<D, Self, G>

where G: Generator<D>,

Create a generator producing the minimum of results of the underlying generator and results of a given other generator.

fn max<G>(self, other: G) -> Max<D, Self, G>

where G: Generator<D>,

Create a generator producing the maximum of results of the underlying generator and results of a given other generator.

fn power<G>(self, other: G) -> Power<D, Self, G>

where G: Generator<D>,

Create a generator raising results of the underlying generator to the power of results of a given other generator.

fn fbm( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Fbm<D, Self>

Create a generator applying fractal brownian motion on the underlying generator.

fn billow( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Billow<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn ridgedmulti( self, octaves: u32, frequency: f64, lacunarity: f64, attenuation: f64, ) -> RidgedMulti<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn blend<G, GC>(self, other: G, control: GC) -> Blend<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator blending the underlying generator with a given other generator based on the value supplied by a control-generator.

fn select<G, GC>( self, other: G, control: GC, selection_min: f64, selection_max: f64, ) -> Select<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator selecting the result of either the underlying generator or that of a given other generator based on whether the value supplied by a control-generator lies within the provided interval.

fn spline<S>(self, knot_vector: &[f64], knots: &[f64]) -> Spline<D, Self, S>

where S: SplineImpl,

Create a generator returning the function value of a provided spline given the result of the underlying generator as input.

impl Generator<2> for ImprovedPerlin<2>

fn sample(&self, point: [f64; 2]) -> f64

Samples the generator at a given point and returns the resulting value.

fn scale(self, scale: [f64; D]) -> Scale<D, Self>

Create a generator which scales input points before passing them to the underlying generator.

fn translate(self, translation: [f64; D]) -> Translate<D, Self>

Create a generator which translates input points before passing them to the underlying generator.

fn neg(self) -> Neg<D, Self>

Create a generator which negates the results of the underlying generator.

fn abs(self) -> Abs<D, Self>

Create a generator returning the absolute value of the results of the underlying generator.

fn exp(self) -> Exp<D, Self>

Create a generator applying the exponential function on results of the underlying generator.

fn add(self, offset: f64) -> Add<D, Self>

Create a generator adding offset to results of the underlying generator.

fn mul(self, scale: f64) -> Mul<D, Self>

Create a generator multiplying scale to results of the underlying generator.

fn powi(self, exponent: i32) -> Pow<D, Self, i32>

Create a generator raising results of the underlying generator to the power of exponent.

fn powf(self, exponent: f64) -> Pow<D, Self, f64>

Create a generator raising results of the underlying generator to the power of exponent.

fn clamp(self, min: f64, max: f64) -> Clamp<D, Self>

Create a generator clamping results of the underlying generator to a given interval.

fn lambda<L>(self, lambda: L) -> Lambda<D, Self, L>

where L: Fn(f64) -> f64,

Create a generator applying the supplied closure to results of the underlying generator.

fn sum<G>(self, other: G) -> Sum<D, Self, G>

where G: Generator<D>,

Create a generator adding results of the underlying generator to results of a given other generator.

fn product<G>(self, other: G) -> Product<D, Self, G>

where G: Generator<D>,

Create a generator multiplying results of the underlying generator to results of a given other generator.

fn min<G>(self, other: G) -> Min<D, Self, G>

where G: Generator<D>,

Create a generator producing the minimum of results of the underlying generator and results of a given other generator.

fn max<G>(self, other: G) -> Max<D, Self, G>

where G: Generator<D>,

Create a generator producing the maximum of results of the underlying generator and results of a given other generator.

fn power<G>(self, other: G) -> Power<D, Self, G>

where G: Generator<D>,

Create a generator raising results of the underlying generator to the power of results of a given other generator.

fn fbm( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Fbm<D, Self>

Create a generator applying fractal brownian motion on the underlying generator.

fn billow( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Billow<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn ridgedmulti( self, octaves: u32, frequency: f64, lacunarity: f64, attenuation: f64, ) -> RidgedMulti<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn blend<G, GC>(self, other: G, control: GC) -> Blend<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator blending the underlying generator with a given other generator based on the value supplied by a control-generator.

fn select<G, GC>( self, other: G, control: GC, selection_min: f64, selection_max: f64, ) -> Select<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator selecting the result of either the underlying generator or that of a given other generator based on whether the value supplied by a control-generator lies within the provided interval.

fn spline<S>(self, knot_vector: &[f64], knots: &[f64]) -> Spline<D, Self, S>

where S: SplineImpl,

Create a generator returning the function value of a provided spline given the result of the underlying generator as input.

impl Generator<3> for ImprovedPerlin<3>

fn sample(&self, point: [f64; 3]) -> f64

Samples the generator at a given point and returns the resulting value.

fn scale(self, scale: [f64; D]) -> Scale<D, Self>

Create a generator which scales input points before passing them to the underlying generator.

fn translate(self, translation: [f64; D]) -> Translate<D, Self>

Create a generator which translates input points before passing them to the underlying generator.

fn neg(self) -> Neg<D, Self>

Create a generator which negates the results of the underlying generator.

fn abs(self) -> Abs<D, Self>

Create a generator returning the absolute value of the results of the underlying generator.

fn exp(self) -> Exp<D, Self>

Create a generator applying the exponential function on results of the underlying generator.

fn add(self, offset: f64) -> Add<D, Self>

Create a generator adding offset to results of the underlying generator.

fn mul(self, scale: f64) -> Mul<D, Self>

Create a generator multiplying scale to results of the underlying generator.

fn powi(self, exponent: i32) -> Pow<D, Self, i32>

Create a generator raising results of the underlying generator to the power of exponent.

fn powf(self, exponent: f64) -> Pow<D, Self, f64>

Create a generator raising results of the underlying generator to the power of exponent.

fn clamp(self, min: f64, max: f64) -> Clamp<D, Self>

Create a generator clamping results of the underlying generator to a given interval.

fn lambda<L>(self, lambda: L) -> Lambda<D, Self, L>

where L: Fn(f64) -> f64,

Create a generator applying the supplied closure to results of the underlying generator.

fn sum<G>(self, other: G) -> Sum<D, Self, G>

where G: Generator<D>,

Create a generator adding results of the underlying generator to results of a given other generator.

fn product<G>(self, other: G) -> Product<D, Self, G>

where G: Generator<D>,

Create a generator multiplying results of the underlying generator to results of a given other generator.

fn min<G>(self, other: G) -> Min<D, Self, G>

where G: Generator<D>,

Create a generator producing the minimum of results of the underlying generator and results of a given other generator.

fn max<G>(self, other: G) -> Max<D, Self, G>

where G: Generator<D>,

Create a generator producing the maximum of results of the underlying generator and results of a given other generator.

fn power<G>(self, other: G) -> Power<D, Self, G>

where G: Generator<D>,

Create a generator raising results of the underlying generator to the power of results of a given other generator.

fn fbm( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Fbm<D, Self>

Create a generator applying fractal brownian motion on the underlying generator.

fn billow( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Billow<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn ridgedmulti( self, octaves: u32, frequency: f64, lacunarity: f64, attenuation: f64, ) -> RidgedMulti<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn blend<G, GC>(self, other: G, control: GC) -> Blend<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator blending the underlying generator with a given other generator based on the value supplied by a control-generator.

fn select<G, GC>( self, other: G, control: GC, selection_min: f64, selection_max: f64, ) -> Select<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator selecting the result of either the underlying generator or that of a given other generator based on whether the value supplied by a control-generator lies within the provided interval.

fn spline<S>(self, knot_vector: &[f64], knots: &[f64]) -> Spline<D, Self, S>

where S: SplineImpl,

Create a generator returning the function value of a provided spline given the result of the underlying generator as input.

impl Generator<4> for ImprovedPerlin<4>

fn sample(&self, point: [f64; 4]) -> f64

Samples the generator at a given point and returns the resulting value.

fn scale(self, scale: [f64; D]) -> Scale<D, Self>

Create a generator which scales input points before passing them to the underlying generator.

fn translate(self, translation: [f64; D]) -> Translate<D, Self>

Create a generator which translates input points before passing them to the underlying generator.

fn neg(self) -> Neg<D, Self>

Create a generator which negates the results of the underlying generator.

fn abs(self) -> Abs<D, Self>

Create a generator returning the absolute value of the results of the underlying generator.

fn exp(self) -> Exp<D, Self>

Create a generator applying the exponential function on results of the underlying generator.

fn add(self, offset: f64) -> Add<D, Self>

Create a generator adding offset to results of the underlying generator.

fn mul(self, scale: f64) -> Mul<D, Self>

Create a generator multiplying scale to results of the underlying generator.

fn powi(self, exponent: i32) -> Pow<D, Self, i32>

Create a generator raising results of the underlying generator to the power of exponent.

fn powf(self, exponent: f64) -> Pow<D, Self, f64>

Create a generator raising results of the underlying generator to the power of exponent.

fn clamp(self, min: f64, max: f64) -> Clamp<D, Self>

Create a generator clamping results of the underlying generator to a given interval.

fn lambda<L>(self, lambda: L) -> Lambda<D, Self, L>

where L: Fn(f64) -> f64,

Create a generator applying the supplied closure to results of the underlying generator.

fn sum<G>(self, other: G) -> Sum<D, Self, G>

where G: Generator<D>,

Create a generator adding results of the underlying generator to results of a given other generator.

fn product<G>(self, other: G) -> Product<D, Self, G>

where G: Generator<D>,

Create a generator multiplying results of the underlying generator to results of a given other generator.

fn min<G>(self, other: G) -> Min<D, Self, G>

where G: Generator<D>,

Create a generator producing the minimum of results of the underlying generator and results of a given other generator.

fn max<G>(self, other: G) -> Max<D, Self, G>

where G: Generator<D>,

Create a generator producing the maximum of results of the underlying generator and results of a given other generator.

fn power<G>(self, other: G) -> Power<D, Self, G>

where G: Generator<D>,

Create a generator raising results of the underlying generator to the power of results of a given other generator.

fn fbm( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Fbm<D, Self>

Create a generator applying fractal brownian motion on the underlying generator.

fn billow( self, octaves: u32, frequency: f64, lacunarity: f64, persistence: f64, ) -> Billow<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn ridgedmulti( self, octaves: u32, frequency: f64, lacunarity: f64, attenuation: f64, ) -> RidgedMulti<D, Self>

Create a generator applying an fbm()-like effect on the underlying generator.

fn blend<G, GC>(self, other: G, control: GC) -> Blend<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator blending the underlying generator with a given other generator based on the value supplied by a control-generator.

fn select<G, GC>( self, other: G, control: GC, selection_min: f64, selection_max: f64, ) -> Select<D, Self, G, GC>

where G: Generator<D>, GC: Generator<D>,

Create a generator selecting the result of either the underlying generator or that of a given other generator based on whether the value supplied by a control-generator lies within the provided interval.

fn spline<S>(self, knot_vector: &[f64], knots: &[f64]) -> Spline<D, Self, S>

where S: SplineImpl,

Create a generator returning the function value of a provided spline given the result of the underlying generator as input.

impl Generator1D for ImprovedPerlin<1>

fn displace_x<GA>(self, displacement_generator: GA) -> Displace<1, 0, Self, GA>

where GA: Generator<1>,

Create a generator providing the results of the underlying generator after displacing the x-coordinate by the result of the provided generator.

impl Generator2D for ImprovedPerlin<2>

fn rotate(self, rotation: [f64; 1]) -> Rotate<2, 1, Self>

Create a generator which rotates input points before passing them to the underlying generator.

fn displace_x<GA>(self, displacement_generator: GA) -> Displace<2, 0, Self, GA>

where GA: Generator<2>,

Create a generator providing the results of the underlying generator after displacing the x-coordinate by the result of the provided generator.

fn displace_y<GA>(self, displacement_generator: GA) -> Displace<2, 1, Self, GA>

where GA: Generator<2>,

Create a generator providing the results of the underlying generator after displacing the y-coordinate by the result of the provided generator.

impl Generator3D for ImprovedPerlin<3>

fn rotate(self, rotation: [f64; 3]) -> Rotate<3, 3, Self>

Create a generator which rotates input points before passing them to the underlying generator.

fn displace_x<GA>(self, displacement_generator: GA) -> Displace<3, 0, Self, GA>

where GA: Generator<3>,

Create a generator providing the results of the underlying generator after displacing the x-coordinate by the result of the provided generator.

fn displace_y<GA>(self, displacement_generator: GA) -> Displace<3, 1, Self, GA>

where GA: Generator<3>,

Create a generator providing the results of the underlying generator after displacing the y-coordinate by the result of the provided generator.

fn displace_z<GA>(self, displacement_generator: GA) -> Displace<3, 2, Self, GA>

where GA: Generator<3>,

Create a generator providing the results of the underlying generator after displacing the z-coordinate by the result of the provided generator.

impl Generator4D for ImprovedPerlin<4>

fn rotate(self, rotation: [f64; 6]) -> Rotate<4, 6, Self>

Create a generator which rotates input points before passing them to the underlying generator.

fn displace_x<GA>(self, displacement_generator: GA) -> Displace<4, 0, Self, GA>

where GA: Generator<4>,

Create a generator providing the results of the underlying generator after displacing the x-coordinate by the result of the provided generator.

fn displace_y<GA>(self, displacement_generator: GA) -> Displace<4, 1, Self, GA>

where GA: Generator<4>,

Create a generator providing the results of the underlying generator after displacing the y-coordinate by the result of the provided generator.

fn displace_z<GA>(self, displacement_generator: GA) -> Displace<4, 2, Self, GA>

where GA: Generator<4>,

Create a generator providing the results of the underlying generator after displacing the z-coordinate by the result of the provided generator.

fn displace_w<GA>(self, displacement_generator: GA) -> Displace<4, 3, Self, GA>

where GA: Generator<4>,

Create a generator providing the results of the underlying generator after displacing the w-coordinate by the result of the provided generator.