Struct NoiseOptions

pub struct NoiseOptions {
    pub frequency: f64,
    pub redistribution: f64,
    pub octaves: usize,
}

Different options for defining how noise should behave.

Fields

frequency: f64

Higher frequency adds a zooming effect to the noise. Default is 1.0.

redistribution: f64

Higher redistribution exaggerates higher peaks and lower lows. Default is 1.0.

octaves: usize

More octaves increases variety. Default is 1.

Implementations

impl NoiseOptions

pub fn new() -> Self

Creates NoiseOptions. See Making maps with noise functions for more detail on each option. Usage of NoiseOptions looks like this:

fn main() {
    let noise_options = NoiseOptions { frequency: 4., ..NoiseOptions::default() };
    Generator::new()
        .with_size(40, 10)
        .with_options(noise_options)
        .spawn_perlin(|value| {
            if value > 0.5 {
                1
            } else {
                0
            }
        })
        .show();
}

Trait Implementations

impl Debug for NoiseOptions

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

Formats the value using the given formatter.

impl Default for NoiseOptions

fn default() -> Self

Return NoiseOptions { frequency: 1.0, redistribution: 1.0, octaves: 1 }