Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Noise

Hérite de : Resource < RefCounted < Object

Hérité par : FastNoiseLite

Classe de base abstraite pour les générateurs de bruit.

Description

Cette classe définit l'interface dont les bibliothèques de génération de bruit doivent hériter.

Une implémentation de get_seamless_image() par défaut est fournie pour les bibliothèques qui ne fournissent pas de bruit seamless (qui se répète sans répétition apparente). Cette fonction demande une image plus grande avec la méthode get_image(), inverse les quadrants de l'image, puis utilise les bandes de largeur supplémentaire pour mélanger sur les coutures.

Les classes de bruit héritantes peuvent éventuellement redéfinir cette fonction pour fournir un algorithme plus optimal.

Méthodes

Image

get_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, normalize: bool = true) const

Array[Image]

get_image_3d(width: int, height: int, depth: int, invert: bool = false, normalize: bool = true) const

float

get_noise_1d(x: float) const

float

get_noise_2d(x: float, y: float) const

float

get_noise_2dv(v: Vector2) const

float

get_noise_3d(x: float, y: float, z: float) const

float

get_noise_3dv(v: Vector3) const

Image

get_seamless_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, skirt: float = 0.1, normalize: bool = true) const

Array[Image]

get_seamless_image_3d(width: int, height: int, depth: int, invert: bool = false, skirt: float = 0.1, normalize: bool = true) const


Descriptions des méthodes

Image get_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, normalize: bool = true) const 🔗

Renvoie une Image contenant des valeurs de bruit 2D.

Note : Avec normalize défini à false, l'implémentation par défaut s'attend à ce que le générateur de bruit renvoie des valeurs dans la plage -1.0 à 1.0.


Array[Image] get_image_3d(width: int, height: int, depth: int, invert: bool = false, normalize: bool = true) const 🔗

Renvoie un Array d'Images contenant des valeurs de bruit 3D à utiliser avec ImageTexture3D.create().

Note : Avec normalize défini à false, l'implémentation par défaut s'attend à ce que le générateur de bruit renvoie des valeurs dans la plage -1.0 à 1.0.


float get_noise_1d(x: float) const 🔗

Renvoie la valeur du bruit 1D à la coordonnée (x) donnée.


float get_noise_2d(x: float, y: float) const 🔗

Renvoie la valeur du bruit 2D à la position donnée.


float get_noise_2dv(v: Vector2) const 🔗

Renvoie la valeur du bruit 2D à la position donnée.


float get_noise_3d(x: float, y: float, z: float) const 🔗

Renvoie la valeur du bruit 3D à la position donnée.


float get_noise_3dv(v: Vector3) const 🔗

Renvoie la valeur du bruit 3D à la position donnée.


Image get_seamless_image(width: int, height: int, invert: bool = false, in_3d_space: bool = false, skirt: float = 0.1, normalize: bool = true) const 🔗

Renvoie une Image contenant des valeurs de bruit 2D seamless.

Note : Avec normalize défini à false, l'implémentation par défaut s'attend à ce que le générateur de bruit renvoie des valeurs dans la plage -1.0 à 1.0.


Array[Image] get_seamless_image_3d(width: int, height: int, depth: int, invert: bool = false, skirt: float = 0.1, normalize: bool = true) const 🔗

Renvoie un Array d'Images contenant des valeurs de bruit 3D seamless à utiliser avec ImageTexture3D.create().

Note : Avec normalize défini à false, l'implémentation par défaut s'attend à ce que le générateur de bruit renvoie des valeurs dans la plage -1.0 à 1.0.