Package Exports

perlin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (perlin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JS.Perlin

forked from https://github.com/arcanis/js.perlin and made into a simple commonjs library

npm install perlin

Usage

require('perlin')( [ table ] )

Returns a new generator instance. If table is set, then it will be used as random lookup table otherwise a random table will be generated.

[instance].octaves
[instance].frequency
[instance].persistence

Generator configurations variables.

[instance].generate( start, size, callback )

This function will call callback() for each pixel in the N-dimensional range between start and start+size, with two parameters : the coordinates of the current pixel, and the related Perlin value.

var generator = require('perlin')( );

generator.generate( [ 0, 0 ], [ 2, 2 ], function ( point, value ) {
    console.log( point, value );
} );

Authors

Implementation by Maël Nison, from Jeremy Cochoy's paper.