@types/noisejs

Installation

npm install --save @types/noisejs

Summary

This package contains type definitions for noisejs (https://github.com/xixixao/noisejs).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/noisejs.

index.d.ts

export = Noise;
export as namespace Noise;

declare class Noise {
    /**
     * Passing in seed will seed this Noise instance
     * @param  {number} seed
     * @return {Noise}       Noise instance
     */
    constructor(seed?: number);

    /**
     * 2D simplex noise
     * @param  {number} x
     * @param  {number} y
     * @return {number} noise value
     */
    simplex2(x: number, y: number): number;

    /**
     * 3D simplex noise
     * @param  {number} x
     * @param  {number} y
     * @param  {number} z
     * @return {number} noise value
     */
    simplex3(x: number, y: number, z: number): number;

    /**
     * 2D Perlin Noise
     * @param  {number} x
     * @param  {number} y
     * @return {number} noise value
     */
    perlin2(x: number, y: number): number;

    /**
     * 3D Perlin Noise
     * @param  {number} x
     * @param  {number} y
     * @param  {number} z
     * @return {number} noise value
     */
    perlin3(x: number, y: number, z: number): number;

    /**
     * This isn't a very good seeding function, but it works ok. It supports 2^16
     * different seed values. Write something better if you need more seeds.
     * @param {number} seed [description]
     */
    seed(seed: number): void;
}

Additional Details

• Last updated: Tue, 24 Sep 2024 19:07:24 GMT
• Dependencies: none

Credits

These definitions were written by Atsushi Izumihara.