OpenSimplexNoise

Inherits: Resource < Reference < Object

Noise generator based on Open Simplex.

Description

This resource allows you to configure and sample a fractal noise space. Here is a brief usage example that configures an OpenSimplexNoise and gets samples at various positions and dimensions:

var noise = OpenSimplexNoise.new()

# Configure
noise.seed = randi()
noise.octaves = 4
noise.period = 20.0
noise.persistence = 0.8

# Sample
print("Values:")
print(noise.get_noise_2d(1.0, 1.0))
print(noise.get_noise_3d(0.5, 3.0, 15.0))
print(noise.get_noise_4d(0.5, 1.9, 4.7, 0.0))

Property Descriptions

Default2.0
Setterset_lacunarity(value)
Getterget_lacunarity()

Difference in period between octaves.


Default3
Setterset_octaves(value)
Getterget_octaves()

Number of OpenSimplex noise layers that are sampled to get the fractal noise. Higher values result in more detailed noise but take more time to generate.

Note: The maximum allowed value is 9.


Default64.0
Setterset_period(value)
Getterget_period()

Period of the base octave. A lower period results in a higher-frequency noise (more value changes across the same distance).


Default0.5
Setterset_persistence(value)
Getterget_persistence()

Contribution factor of the different octaves. A persistence value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.


Default0
Setterset_seed(value)
Getterget_seed()

Seed used to generate random values, different seeds will generate different noise maps.

Method Descriptions

Generate a noise image with the requested width and height, based on the current noise parameters.


Returns the 1D noise value [-1,1] at the given x-coordinate.

Note: This method actually returns the 2D noise value [-1,1] with fixed y-coordinate value 0.0.


Returns the 2D noise value [-1,1] at the given position.


Returns the 2D noise value [-1,1] at the given position.


Returns the 3D noise value [-1,1] at the given position.


Returns the 3D noise value [-1,1] at the given position.


Returns the 4D noise value [-1,1] at the given position.


Generate a tileable noise image, based on the current noise parameters. Generated seamless images are always square (size × size).

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.