The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
TCOD-0.004
River stage zero No dependents
++
/ TCOD::Noise

NAME

TCOD::Noise - A generator of Perlin noise and other derived noises

SYNOPSIS

    use TCOD;

    ...

DESCRIPTION

This toolkit provides several functions to generate Perlin noise and other derived noises. It can handle noise functions from 1 to 4 dimensions.

METHODS

new

    $noise = TCOD::Noise->new( $dimensions, $hurst, $lacunarity, $random );

Initialise a noise generator from a number of dimensions (from 1 to 4), some fractal parameters and a TCOD::Random random number generator. You can pass undef as the value for the random number generator to use the default one.

set_type

    $noise->set_type( $type );

Use this function to define the default algorithm used by the noise functions. The default algorithm is simplex. It's much faster than Perlin, especially in 4 dimensions. It has a better contrast too.

The value in $type must be one of the values in the NoiseType enum.

get

    $float = $noise->get(    \@coords        );
    $float = $noise->get_ex( \@coords, $type );

This function returns the noise function value between -1 and 1 at the given coordinates. The number of values needed for the coordinate will depend on the dimensions of the generator. For the same generator, the same coordinates will always result in the same value.

The value in $type for the _ex variant allows you to override the default noise type for this generator. See set_type for how to set it. If none is set, TCOD::NOISE_SIMPLEX will be used.

get_fbm

    $float = $noise->get_fbm(    \@coords, $octaves        );
    $float = $noise->get_fbm_ex( \@coords, $octaves, $type );

This function returns the fbm function value between -1 and 1 at given coordinates, using fractal hurst and lacunarity defined when the generator has been created.

The value in $octaves determines the number of iterations. It must be less than TCOD::NOISE_MAX_OCTAVES (128).

The value in $type for the _ex variant allows you to override the default noise type for this generator. See set_type for how to set it. If none is set, TCOD::NOISE_SIMPLEX will be used.

get_turbulence

    $float = $noise->get_turbulence(    \@coords, $octaves        );
    $float = $noise->get_turbulence_ex( \@coords, $octaves, $type );

This function returns the turbulence function value between -1 and 1 at given coordinates, using fractal hurst and lacunarity defined when the generator has been created.

The value in $octaves determines the number of iterations. It must be less than TCOD::NOISE_MAX_OCTAVES (128).

The value in $type for the _ex variant allows you to override the default noise type for this generator. See set_type for how to set it. If none is set, TCOD::NOISE_SIMPLEX will be used.

SEE ALSO

TCOD
TCOD::Random

COPYRIGHT AND LICENSE

Copyright 2021 José Joaquín Atria

This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0.