Skip to content

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jwagner committed Jul 23, 2022
1 parent 6608759 commit 5e4db82
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ const simplex = {
- Removed the built in version of the alea PRNG to focus the library to do only one thing.
If you want to continue to use it you'll have to install and import it separately.
- Noise functions are a bit faster (~ 10-20%) due to using integers in some places
- Noise values can be different from previous versions especially for inputs > 2^31
- Noise values can be different from previous versions
- Inputs coordinates bigger than 2^31 may not result in a noisy output anymore.
- Test coverage is now at 100%

### 3.0.1
Expand Down
6 changes: 6 additions & 0 deletions simplex-noise.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ export type RandomFn = () => number;

/**
* Samples the noise field in two dimensions
*
* Coordinates should be finite, bigger than -2^31 and smaller than 2^31.
* @param x
* @param y
* @returns a number in the interval [-1, 1]
Expand Down Expand Up @@ -177,6 +179,8 @@ export function createNoise2D(random: RandomFn = Math.random): NoiseFunction2D {

/**
* Samples the noise field in three dimensions
*
* Coordinates should be finite, bigger than -2^31 and smaller than 2^31.
* @param x
* @param y
* @param z
Expand Down Expand Up @@ -315,6 +319,8 @@ export function createNoise3D(random: RandomFn = Math.random): NoiseFunction3D {

/**
* Samples the noise field in four dimensions
*
* Coordinates should be finite, bigger than -2^31 and smaller than 2^31.
* @param x
* @param y
* @param z
Expand Down

0 comments on commit 5e4db82

Please sign in to comment.