Skip to content

Commit 5e4db82

Browse files
committed
Improved docs
1 parent 6608759 commit 5e4db82

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,8 @@ const simplex = {
158158
- Removed the built in version of the alea PRNG to focus the library to do only one thing.
159159
If you want to continue to use it you'll have to install and import it separately.
160160
- Noise functions are a bit faster (~ 10-20%) due to using integers in some places
161-
- Noise values can be different from previous versions especially for inputs > 2^31
161+
- Noise values can be different from previous versions
162+
- Inputs coordinates bigger than 2^31 may not result in a noisy output anymore.
162163
- Test coverage is now at 100%
163164

164165
### 3.0.1

simplex-noise.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ export type RandomFn = () => number;
9090

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

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

316320
/**
317321
* Samples the noise field in four dimensions
322+
*
323+
* Coordinates should be finite, bigger than -2^31 and smaller than 2^31.
318324
* @param x
319325
* @param y
320326
* @param z

0 commit comments

Comments
 (0)