Package org.lwjgl.stb
Class STBPerlin
java.lang.Object
org.lwjgl.stb.STBPerlin
Native bindings to stb_perlin.h from the stb library.
Revised Perlin noise (3D input, 1D output).
-
Method Summary
Modifier and TypeMethodDescriptionstatic float
stb_perlin_fbm_noise3
(float x, float y, float z, float lacunarity, float gain, int octaves) Computes Fractal Brownian Motion noise.static float
stb_perlin_noise3
(float x, float y, float z, int x_wrap, int y_wrap, int z_wrap) Computes a random value at the coordinate (x,y,z).static float
stb_perlin_noise3_seed
(float x, float y, float z, int x_wrap, int y_wrap, int z_wrap, int seed) Asperlin_noise3
, butseed
selects from multiple different variations of the noise function.static float
stb_perlin_noise3_wrap_nonpow2
(float x, float y, float z, int x_wrap, int y_wrap, int z_wrap, byte seed) static float
stb_perlin_ridge_noise3
(float x, float y, float z, float lacunarity, float gain, float offset, int octaves) Computes ridged noise.static float
stb_perlin_turbulence_noise3
(float x, float y, float z, float lacunarity, float gain, int octaves) Computes turbulence noise.
-
Method Details
-
stb_perlin_noise3
public static float stb_perlin_noise3(float x, float y, float z, int x_wrap, int y_wrap, int z_wrap) Computes a random value at the coordinate (x,y,z).Adjacent random values are continuous but the noise fluctuates its randomness with period 1, i.e. takes on wholly unrelated values at integer points. Specifically, this implements Ken Perlin's revised noise function from 2002.
The "wrap" parameters can be used to create wraparound noise that wraps at powers of two. The numbers MUST be powers of two. Specify 0 to mean "don't care". (The noise always wraps every 256 due details of the implementation, even if you ask for larger or no wrapping.)
- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinatex_wrap
- 0, or a power of two value that specifies the x wraparound coordinatey_wrap
- 0, or a power of two value that specifies the y wraparound coordinatez_wrap
- 0, or a power of two value that specifies the z wraparound coordinate
-
stb_perlin_noise3_seed
public static float stb_perlin_noise3_seed(float x, float y, float z, int x_wrap, int y_wrap, int z_wrap, int seed) Asperlin_noise3
, butseed
selects from multiple different variations of the noise function.The current implementation only uses the bottom 8 bits of
seed
, but possibly in the future more bits will be used.- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinatex_wrap
- 0, or a power of two value that specifies the x wraparound coordinatey_wrap
- 0, or a power of two value that specifies the y wraparound coordinatez_wrap
- 0, or a power of two value that specifies the z wraparound coordinateseed
- selects from multiple different variations of the noise function
-
stb_perlin_ridge_noise3
public static float stb_perlin_ridge_noise3(float x, float y, float z, float lacunarity, float gain, float offset, int octaves) Computes ridged noise. Callsperlin_noise3
octaves
times, so this parameter will affect runtime.- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinatelacunarity
- spacing between successive octaves (use exactly 2.0 for wrapping output)gain
- relative weighting applied to each successive octaveoffset
- used to invert the ridges, may need to be larger, not sureoctaves
- number of "octaves" ofnoise3()
to sum
-
stb_perlin_fbm_noise3
public static float stb_perlin_fbm_noise3(float x, float y, float z, float lacunarity, float gain, int octaves) Computes Fractal Brownian Motion noise. Callsperlin_noise3
octaves
times, so this parameter will affect runtime.- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinatelacunarity
- spacing between successive octaves (use exactly 2.0 for wrapping output)gain
- relative weighting applied to each successive octaveoctaves
- number of "octaves" ofnoise3()
to sum
-
stb_perlin_turbulence_noise3
public static float stb_perlin_turbulence_noise3(float x, float y, float z, float lacunarity, float gain, int octaves) Computes turbulence noise. Callsperlin_noise3
octaves
times, so this parameter will affect runtime.- Parameters:
x
- the x coordinatey
- the y coordinatez
- the z coordinatelacunarity
- spacing between successive octaves (use exactly 2.0 for wrapping output)gain
- relative weighting applied to each successive octaveoctaves
- number of "octaves" ofnoise3()
to sum
-
stb_perlin_noise3_wrap_nonpow2
public static float stb_perlin_noise3_wrap_nonpow2(float x, float y, float z, int x_wrap, int y_wrap, int z_wrap, byte seed)
-