Environment

Hereda: Resource < RefCounted < Object

Recurso para nodos del entorno (como WorldEnvironment) que definen múltiples opciones de renderizado.

Descripción

Recurso para nodos de entorno (como WorldEnvironment) que definen múltiples operaciones de entorno (como Sky o Color de fondo, luz ambiental, niebla, profundidad de campo...). Estos parámetros afectan el render final de la escena. El orden de estas operaciones es:

  • Desenfoque de profundidad de campo

  • Resplandor

  • Asignación de tonos (exposición automática)

  • Ajustes

Tutoriales

Propiedades

float

adjustment_brightness

1.0

Texture

adjustment_color_correction

float

adjustment_contrast

1.0

bool

adjustment_enabled

false

float

adjustment_saturation

1.0

Color

ambient_light_color

Color(0, 0, 0, 1)

float

ambient_light_energy

1.0

float

ambient_light_sky_contribution

1.0

AmbientSource

ambient_light_source

0

int

background_camera_feed_id

1

int

background_canvas_max_layer

0

Color

background_color

Color(0, 0, 0, 1)

float

background_energy_multiplier

1.0

float

background_intensity

30000.0

BGMode

background_mode

0

float

fog_aerial_perspective

0.0

float

fog_density

0.01

float

fog_depth_begin

10.0

float

fog_depth_curve

1.0

float

fog_depth_end

100.0

bool

fog_enabled

false

float

fog_height

0.0

float

fog_height_density

0.0

Color

fog_light_color

Color(0.518, 0.553, 0.608, 1)

float

fog_light_energy

1.0

FogMode

fog_mode

0

float

fog_sky_affect

1.0

float

fog_sun_scatter

0.0

GlowBlendMode

glow_blend_mode

2

float

glow_bloom

0.0

bool

glow_enabled

false

float

glow_hdr_luminance_cap

12.0

float

glow_hdr_scale

2.0

float

glow_hdr_threshold

1.0

float

glow_intensity

0.8

float

glow_levels/1

0.0

float

glow_levels/2

0.0

float

glow_levels/3

1.0

float

glow_levels/4

0.0

float

glow_levels/5

1.0

float

glow_levels/6

0.0

float

glow_levels/7

0.0

Texture

glow_map

float

glow_map_strength

0.8

float

glow_mix

0.05

bool

glow_normalized

false

float

glow_strength

1.0

ReflectionSource

reflected_light_source

0

float

sdfgi_bounce_feedback

0.5

float

sdfgi_cascade0_distance

12.8

int

sdfgi_cascades

4

bool

sdfgi_enabled

false

float

sdfgi_energy

1.0

float

sdfgi_max_distance

204.8

float

sdfgi_min_cell_size

0.2

float

sdfgi_normal_bias

1.1

float

sdfgi_probe_bias

1.1

bool

sdfgi_read_sky_light

true

bool

sdfgi_use_occlusion

false

SDFGIYScale

sdfgi_y_scale

1

Sky

sky

float

sky_custom_fov

0.0

Vector3

sky_rotation

Vector3(0, 0, 0)

float

ssao_ao_channel_affect

0.0

float

ssao_detail

0.5

bool

ssao_enabled

false

float

ssao_horizon

0.06

float

ssao_intensity

2.0

float

ssao_light_affect

0.0

float

ssao_power

1.5

float

ssao_radius

1.0

float

ssao_sharpness

0.98

bool

ssil_enabled

false

float

ssil_intensity

1.0

float

ssil_normal_rejection

1.0

float

ssil_radius

5.0

float

ssil_sharpness

0.98

float

ssr_depth_tolerance

0.2

bool

ssr_enabled

false

float

ssr_fade_in

0.15

float

ssr_fade_out

2.0

int

ssr_max_steps

64

float

tonemap_exposure

1.0

ToneMapper

tonemap_mode

0

float

tonemap_white

1.0

Color

volumetric_fog_albedo

Color(1, 1, 1, 1)

float

volumetric_fog_ambient_inject

0.0

float

volumetric_fog_anisotropy

0.2

float

volumetric_fog_density

0.05

float

volumetric_fog_detail_spread

2.0

Color

volumetric_fog_emission

Color(0, 0, 0, 1)

float

volumetric_fog_emission_energy

1.0

bool

volumetric_fog_enabled

false

float

volumetric_fog_gi_inject

1.0

float

volumetric_fog_length

64.0

float

volumetric_fog_sky_affect

1.0

float

volumetric_fog_temporal_reprojection_amount

0.9

bool

volumetric_fog_temporal_reprojection_enabled

true

Métodos

float

get_glow_level(idx: int) const

void

set_glow_level(idx: int, intensity: float)


Enumeraciones

enum BGMode: 🔗

BGMode BG_CLEAR_COLOR = 0

Clears the background using the clear color defined in ProjectSettings.rendering/environment/defaults/default_clear_color.

BGMode BG_COLOR = 1

Despeja el fondo usando un color claro personalizado.

BGMode BG_SKY = 2

Muestra un cielo definido por el usuario en el fondo.

BGMode BG_CANVAS = 3

Muestra una CanvasLayer en el fondo.

BGMode BG_KEEP = 4

Keeps on screen every pixel drawn in the background. This is the fastest background mode, but it can only be safely used in fully-interior scenes (no visible sky or sky reflections). If enabled in a scene where the background is visible, "ghost trail" artifacts will be visible when moving the camera.

BGMode BG_CAMERA_FEED = 5

Muestra un feed de una cámara en el fondo.

BGMode BG_MAX = 6

Representa el tamaño del enum BGMode.


enum AmbientSource: 🔗

AmbientSource AMBIENT_SOURCE_BG = 0

Gather ambient light from whichever source is specified as the background.

AmbientSource AMBIENT_SOURCE_DISABLED = 1

Disable ambient light. This provides a slight performance boost over AMBIENT_SOURCE_SKY.

AmbientSource AMBIENT_SOURCE_COLOR = 2

Specify a specific Color for ambient light. This provides a slight performance boost over AMBIENT_SOURCE_SKY.

AmbientSource AMBIENT_SOURCE_SKY = 3

Gather ambient light from the Sky regardless of what the background is.


enum ReflectionSource: 🔗

ReflectionSource REFLECTION_SOURCE_BG = 0

Utilizar el fondo para los reflejos.

ReflectionSource REFLECTION_SOURCE_DISABLED = 1

Disable reflections. This provides a slight performance boost over other options.

ReflectionSource REFLECTION_SOURCE_SKY = 2

Use the Sky for reflections regardless of what the background is.


enum ToneMapper: 🔗

ToneMapper TONE_MAPPER_LINEAR = 0

Does not modify color data, resulting in a linear tonemapping curve which unnaturally clips bright values, causing bright lighting to look blown out. The simplest and fastest tonemapper.

ToneMapper TONE_MAPPER_REINHARDT = 1

A simple tonemapping curve that rolls off bright values to prevent clipping. This results in an image that can appear dull and low contrast. Slower than TONE_MAPPER_LINEAR.

Note: When tonemap_white is left at the default value of 1.0, TONE_MAPPER_REINHARDT produces an identical image to TONE_MAPPER_LINEAR.

ToneMapper TONE_MAPPER_FILMIC = 2

Uses a film-like tonemapping curve to prevent clipping of bright values and provide better contrast than TONE_MAPPER_REINHARDT. Slightly slower than TONE_MAPPER_REINHARDT.

ToneMapper TONE_MAPPER_ACES = 3

Uses a high-contrast film-like tonemapping curve and desaturates bright values for a more realistic appearance. Slightly slower than TONE_MAPPER_FILMIC.

Note: This tonemapping operator is called "ACES Fitted" in Godot 3.x.

ToneMapper TONE_MAPPER_AGX = 4

Uses a film-like tonemapping curve and desaturates bright values for a more realistic appearance. Better than other tonemappers at maintaining the hue of colors as they become brighter. The slowest tonemapping option.

Note: tonemap_white is fixed at a value of 16.29, which makes TONE_MAPPER_AGX unsuitable for use with the Mobile rendering method.


enum GlowBlendMode: 🔗

GlowBlendMode GLOW_BLEND_MODE_ADDITIVE = 0

Modo de mezcla de brillo aditivo. Se utiliza principalmente para partículas, brillos (florecimiento), destellos de lentes, fuentes brillantes.

GlowBlendMode GLOW_BLEND_MODE_SCREEN = 1

Modo de mezcla de brillo de pantalla. Aumenta el brillo, se usa frecuentemente con el bloom.

GlowBlendMode GLOW_BLEND_MODE_SOFTLIGHT = 2

Modo de mezcla de brillo de luz suave. Modifica el contraste, expone sombras y luces (bloom vivo).

GlowBlendMode GLOW_BLEND_MODE_REPLACE = 3

Reemplazar el modo de mezcla de brillo. Reemplaza el color de todos los píxeles por el valor de brillo. Puede utilizarse para simular un efecto de desenfoque en pantalla completa ajustando los parámetros de brillo para que coincidan con el brillo de la imagen original.

GlowBlendMode GLOW_BLEND_MODE_MIX = 4

Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.


enum FogMode: 🔗

FogMode FOG_MODE_EXPONENTIAL = 0

Use a physically-based fog model defined primarily by fog density.

FogMode FOG_MODE_DEPTH = 1

Use a simple fog model defined by start and end positions and a custom curve. While not physically accurate, this model can be useful when you need more artistic control.


enum SDFGIYScale: 🔗

SDFGIYScale SDFGI_Y_SCALE_50_PERCENT = 0

Use 50% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be twice as short as they are wide. This allows providing increased GI detail and reduced light leaking with thin floors and ceilings. This is usually the best choice for scenes that don't feature much verticality.

SDFGIYScale SDFGI_Y_SCALE_75_PERCENT = 1

Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.

SDFGIYScale SDFGI_Y_SCALE_100_PERCENT = 2

Use 100% scale for SDFGI on the Y (vertical) axis. SDFGI cells will be as tall as they are wide. This is usually the best choice for highly vertical scenes. The downside is that light leaking may become more noticeable with thin floors and ceilings.


Descripciones de Propiedades

float adjustment_brightness = 1.0 🔗

  • void set_adjustment_brightness(value: float)

  • float get_adjustment_brightness()

El valor de brillo global de la escena renderizada. Solo es efectivo si adjustment_enabled es true.


Texture adjustment_color_correction 🔗

  • void set_adjustment_color_correction(value: Texture)

  • Texture get_adjustment_color_correction()

La tabla de búsqueda (Texture2D o Texture3D LUT) para usar en la gradación de color de post-procesamiento incorporada. Se puede usar un GradientTexture1D para una LUT unidimensional, o una Texture3D para una LUT más compleja. Solo es efectivo si adjustment_enabled es true.


float adjustment_contrast = 1.0 🔗

  • void set_adjustment_contrast(value: float)

  • float get_adjustment_contrast()

El valor de contraste global de la escena renderizada (el valor por defecto es 1). Efectivo solo si adjustment_enabled es true.


bool adjustment_enabled = false 🔗

  • void set_adjustment_enabled(value: bool)

  • bool is_adjustment_enabled()

Si es true, activa las propiedades adjustment_* proporcionadas por este recurso. Si es false, las modificaciones de las propiedades adjustment_* no tendrán ningún efecto en la escena renderizada.


float adjustment_saturation = 1.0 🔗

  • void set_adjustment_saturation(value: float)

  • float get_adjustment_saturation()

El valor de saturación de color global de la escena renderizada (el valor por defecto es 1). Efectivo solo si adjustment_enabled es true.


Color ambient_light_color = Color(0, 0, 0, 1) 🔗

  • void set_ambient_light_color(value: Color)

  • Color get_ambient_light_color()

El Color de la luz ambiental. Solo es efectivo si ambient_light_sky_contribution es inferior a 1.0 (exclusivo).


float ambient_light_energy = 1.0 🔗

  • void set_ambient_light_energy(value: float)

  • float get_ambient_light_energy()

La energía de la luz ambiental. Cuanto mayor sea el valor, más fuerte será la luz. Solo es efectivo si ambient_light_sky_contribution es menor que 1.0 (exclusivo).


float ambient_light_sky_contribution = 1.0 🔗

  • void set_ambient_light_sky_contribution(value: float)

  • float get_ambient_light_sky_contribution()

Define la cantidad de luz que el cielo aporta a la escena. Un valor de 0.0 significa que la emisión de luz del cielo no tiene efecto en la iluminación de la escena, por lo que toda la iluminación ambiental es proporcionada por la luz ambiental. Por el contrario, un valor de 1.0 significa que toda la luz que afecta a la escena es proporcionada por el cielo, por lo que el parámetro de luz ambiental no tiene efecto en la escena.

Nota: ambient_light_sky_contribution se limita internamente entre 0.0 y 1.0 (inclusive).


AmbientSource ambient_light_source = 0 🔗

La fuente de luz ambiental que se utilizará para renderizar materiales e iluminación global.


int background_camera_feed_id = 1 🔗

  • void set_camera_feed_id(value: int)

  • int get_camera_feed_id()

La identificación de la feed de la cámara para mostrarla en el fondo.


int background_canvas_max_layer = 0 🔗

  • void set_canvas_max_layer(value: int)

  • int get_canvas_max_layer()

El ID de la capa maxima a mostrar. Sólo es efectivo cuando se utiliza el modo de fondo BG_CANVAS.


Color background_color = Color(0, 0, 0, 1) 🔗

  • void set_bg_color(value: Color)

  • Color get_bg_color()

El Color mostrado para las áreas claras de la escena. Solo es efectivo cuando se usa el modo de fondo BG_COLOR.


float background_energy_multiplier = 1.0 🔗

  • void set_bg_energy_multiplier(value: float)

  • float get_bg_energy_multiplier()

Multiplicador para la energía del fondo. Aumenta para hacer el fondo más brillante, disminuye para hacer el fondo más oscuro.


float background_intensity = 30000.0 🔗

  • void set_bg_intensity(value: float)

  • float get_bg_intensity()

Luminancia del fondo medida en nits (candela por metro cuadrado). Solo se usa cuando ProjectSettings.rendering/lights_and_shadows/use_physical_light_units está habilitado. El valor predeterminado es aproximadamente equivalente al cielo al mediodía.


BGMode background_mode = 0 🔗

  • void set_background(value: BGMode)

  • BGMode get_background()

El modo de fondo.


float fog_aerial_perspective = 0.0 🔗

  • void set_fog_aerial_perspective(value: float)

  • float get_fog_aerial_perspective()

If set above 0.0 (exclusive), blends between the fog's color and the color of the background Sky, as read from the radiance cubemap. This has a small performance cost when set above 0.0. Must have background_mode set to BG_SKY.

This is useful to simulate aerial perspective in large scenes with low density fog. However, it is not very useful for high-density fog, as the sky will shine through. When set to 1.0, the fog color comes completely from the Sky. If set to 0.0, aerial perspective is disabled.

Notice that this does not sample the Sky directly, but rather the radiance cubemap. The cubemap is sampled at a mipmap level depending on the depth of the rendered pixel; the farther away, the higher the resolution of the sampled mipmap. This results in the actual color being a blurred version of the sky, with more blur closer to the camera. The highest mipmap resolution is used at a depth of Camera3D.far.


float fog_density = 0.01 🔗

  • void set_fog_density(value: float)

  • float get_fog_density()

The fog density to be used. This is demonstrated in different ways depending on the fog_mode mode chosen:

Exponential Fog Mode: Higher values result in denser fog. The fog rendering is exponential like in real life.

Depth Fog mode: The maximum intensity of the deep fog, effect will appear in the distance (relative to the camera). At 1.0 the fog will fully obscure the scene, at 0.0 the fog will not be visible.


float fog_depth_begin = 10.0 🔗

  • void set_fog_depth_begin(value: float)

  • float get_fog_depth_begin()

The fog's depth starting distance from the camera. Only available when fog_mode is set to FOG_MODE_DEPTH.


float fog_depth_curve = 1.0 🔗

  • void set_fog_depth_curve(value: float)

  • float get_fog_depth_curve()

The fog depth's intensity curve. A number of presets are available in the Inspector by right-clicking the curve. Only available when fog_mode is set to FOG_MODE_DEPTH.


float fog_depth_end = 100.0 🔗

  • void set_fog_depth_end(value: float)

  • float get_fog_depth_end()

The fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's Camera3D.far value. Only available when fog_mode is set to FOG_MODE_DEPTH.


bool fog_enabled = false 🔗

  • void set_fog_enabled(value: bool)

  • bool is_fog_enabled()

Si es true, se habilitan los efectos de niebla.


float fog_height = 0.0 🔗

  • void set_fog_height(value: float)

  • float get_fog_height()

The height at which the height fog effect begins.


float fog_height_density = 0.0 🔗

  • void set_fog_height_density(value: float)

  • float get_fog_height_density()

The density used to increase fog as height decreases. To make fog increase as height increases, use a negative value.


Color fog_light_color = Color(0.518, 0.553, 0.608, 1) 🔗

  • void set_fog_light_color(value: Color)

  • Color get_fog_light_color()

El color de la niebla.


float fog_light_energy = 1.0 🔗

  • void set_fog_light_energy(value: float)

  • float get_fog_light_energy()

The fog's brightness. Higher values result in brighter fog.


FogMode fog_mode = 0 🔗

El modo de niebla.


float fog_sky_affect = 1.0 🔗

  • void set_fog_sky_affect(value: float)

  • float get_fog_sky_affect()

The factor to use when affecting the sky with non-volumetric fog. 1.0 means that fog can fully obscure the sky. Lower values reduce the impact of fog on sky rendering, with 0.0 not affecting sky rendering at all.

Note: fog_sky_affect has no visual effect if fog_aerial_perspective is 1.0.


float fog_sun_scatter = 0.0 🔗

  • void set_fog_sun_scatter(value: float)

  • float get_fog_sun_scatter()

If set above 0.0, renders the scene's directional light(s) in the fog color depending on the view angle. This can be used to give the impression that the sun is "piercing" through the fog.


GlowBlendMode glow_blend_mode = 2 🔗

The glow blending mode.

Note: glow_blend_mode has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_bloom = 0.0 🔗

  • void set_glow_bloom(value: float)

  • float get_glow_bloom()

La intensidad del bloom. Si se ajusta a un valor superior a 0, esto hará que el brillo sea visible en áreas más oscuras que el glow_hdr_threshold.


bool glow_enabled = false 🔗

  • void set_glow_enabled(value: bool)

  • bool is_glow_enabled()

If true, the glow effect is enabled. This simulates real world eye/camera behavior where bright pixels bleed onto surrounding pixels.

Note: When using the Mobile rendering method, glow looks different due to the lower dynamic range available in the Mobile rendering method.

Note: When using the Compatibility rendering method, glow uses a different implementation with some properties being unavailable and hidden from the inspector: glow_levels/*, glow_normalized, glow_strength, glow_blend_mode, glow_mix, glow_map, and glow_map_strength. This implementation is optimized to run on low-end devices and is less flexible as a result.


float glow_hdr_luminance_cap = 12.0 🔗

  • void set_glow_hdr_luminance_cap(value: float)

  • float get_glow_hdr_luminance_cap()

El umbral más alto del brillo del HDR. Las áreas más brillantes que este umbral serán fijadas para el efecto de brillo.


float glow_hdr_scale = 2.0 🔗

  • void set_glow_hdr_bleed_scale(value: float)

  • float get_glow_hdr_bleed_scale()

La escala de sangrado del brillo del HDR.


float glow_hdr_threshold = 1.0 🔗

  • void set_glow_hdr_bleed_threshold(value: float)

  • float get_glow_hdr_bleed_threshold()

The lower threshold of the HDR glow. When using the Mobile rendering method (which only supports a lower dynamic range up to 2.0), this may need to be below 1.0 for glow to be visible. A value of 0.9 works well in this case. This value also needs to be decreased below 1.0 when using glow in 2D, as 2D rendering is performed in SDR.


float glow_intensity = 0.8 🔗

  • void set_glow_intensity(value: float)

  • float get_glow_intensity()

The overall brightness multiplier of the glow effect. When using the Mobile rendering method (which only supports a lower dynamic range up to 2.0), this should be increased to 1.5 to compensate.


float glow_levels/1 = 0.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 1st level of glow. This is the most "local" level (least blurry).

Note: glow_levels/1 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_levels/2 = 0.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 2nd level of glow.

Note: glow_levels/2 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_levels/3 = 1.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 3rd level of glow.

Note: glow_levels/3 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_levels/4 = 0.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 4th level of glow.

Note: glow_levels/4 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_levels/5 = 1.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 5th level of glow.

Note: glow_levels/5 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_levels/6 = 0.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 6th level of glow.

Note: glow_levels/6 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_levels/7 = 0.0 🔗

  • void set_glow_level(idx: int, intensity: float)

  • float get_glow_level(idx: int) const

The intensity of the 7th level of glow. This is the most "global" level (blurriest).

Note: glow_levels/7 has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


Texture glow_map 🔗

The texture that should be used as a glow map to multiply the resulting glow color according to glow_map_strength. This can be used to create a "lens dirt" effect. The texture's RGB color channels are used for modulation, but the alpha channel is ignored.

Note: The texture will be stretched to fit the screen. Therefore, it's recommended to use a texture with an aspect ratio that matches your project's base aspect ratio (typically 16:9).

Note: glow_map has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_map_strength = 0.8 🔗

  • void set_glow_map_strength(value: float)

  • float get_glow_map_strength()

How strong of an influence the glow_map should have on the overall glow effect. A strength of 0.0 means the glow map has no influence, while a strength of 1.0 means the glow map has full influence.

Note: If the glow map has black areas, a value of 1.0 can also turn off the glow effect entirely in specific areas of the screen.

Note: glow_map_strength has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_mix = 0.05 🔗

  • void set_glow_mix(value: float)

  • float get_glow_mix()

When using the GLOW_BLEND_MODE_MIX glow_blend_mode, this controls how much the source image is blended with the glow layer. A value of 0.0 makes the glow rendering invisible, while a value of 1.0 is equivalent to GLOW_BLEND_MODE_REPLACE.

Note: glow_mix has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


bool glow_normalized = false 🔗

  • void set_glow_normalized(value: bool)

  • bool is_glow_normalized()

If true, glow levels will be normalized so that summed together their intensities equal 1.0.

Note: glow_normalized has no effect when using the Compatibility rendering method, due to this rendering method using a simpler glow implementation optimized for low-end devices.


float glow_strength = 1.0 🔗

  • void set_glow_strength(value: float)

  • float get_glow_strength()

La fuerza del efecto de brillo. Esto se aplica a medida que el brillo se difumina por la pantalla y aumenta la distancia e intensidad del desenfoque. Cuando se utiliza el método de renderizado Mobile, esto debe aumentarse para compensar el menor rango dinámico.

Nota: glow_strength no tiene ningún efecto cuando se utiliza el método de renderizado Compatibility, debido a que este método de renderizado utiliza una implementación de brillo más sencilla optimizada para dispositivos de gama baja.


ReflectionSource reflected_light_source = 0 🔗

La fuente de luz reflejada (especular).


float sdfgi_bounce_feedback = 0.5 🔗

  • void set_sdfgi_bounce_feedback(value: float)

  • float get_sdfgi_bounce_feedback()

The energy multiplier applied to light every time it bounces from a surface when using SDFGI. Values greater than 0.0 will simulate multiple bounces, resulting in a more realistic appearance. Increasing sdfgi_bounce_feedback generally has no performance impact. See also sdfgi_energy.

Note: Values greater than 0.5 can cause infinite feedback loops and should be avoided in scenes with bright materials.

Note: If sdfgi_bounce_feedback is 0.0, indirect lighting will not be represented in reflections as light will only bounce one time.


float sdfgi_cascade0_distance = 12.8 🔗

  • void set_sdfgi_cascade0_distance(value: float)

  • float get_sdfgi_cascade0_distance()

Nota: Esta propiedad está enlazada a sdfgi_min_cell_size y a sdfgi_max_distance. Cambiar su valor cambiará automáticamente también esas propiedades.


int sdfgi_cascades = 4 🔗

  • void set_sdfgi_cascades(value: int)

  • int get_sdfgi_cascades()

The number of cascades to use for SDFGI (between 1 and 8). A higher number of cascades allows displaying SDFGI further away while preserving detail up close, at the cost of performance. When using SDFGI on small-scale levels, sdfgi_cascades can often be decreased between 1 and 4 to improve performance.


bool sdfgi_enabled = false 🔗

  • void set_sdfgi_enabled(value: bool)

  • bool is_sdfgi_enabled()

If true, enables signed distance field global illumination for meshes that have their GeometryInstance3D.gi_mode set to GeometryInstance3D.GI_MODE_STATIC. SDFGI is a real-time global illumination technique that works well with procedurally generated and user-built levels, including in situations where geometry is created during gameplay. The signed distance field is automatically generated around the camera as it moves. Dynamic lights are supported, but dynamic occluders and emissive surfaces are not.

Note: SDFGI is only supported in the Forward+ rendering method, not Mobile or Compatibility.

Performance: SDFGI is relatively demanding on the GPU and is not suited to low-end hardware such as integrated graphics (consider LightmapGI instead). To improve SDFGI performance, enable ProjectSettings.rendering/global_illumination/gi/use_half_resolution in the Project Settings.

Note: Meshes should have sufficiently thick walls to avoid light leaks (avoid one-sided walls). For interior levels, enclose your level geometry in a sufficiently large box and bridge the loops to close the mesh.


float sdfgi_energy = 1.0 🔗

  • void set_sdfgi_energy(value: float)

  • float get_sdfgi_energy()

El multiplicador de energía que se utiliza para SDFGI. Los valores más altos darán como resultado una iluminación indirecta y reflejos más brillantes. Véase también sdfgi_bounce_feedback.


float sdfgi_max_distance = 204.8 🔗

  • void set_sdfgi_max_distance(value: float)

  • float get_sdfgi_max_distance()

La distancia máxima a la que SDFGI es visible. Más allá de esta distancia, se utilizará la iluminación del entorno u otras fuentes de GI como ReflectionProbe como alternativa.

Nota: Esta propiedad está enlazada a sdfgi_min_cell_size y a sdfgi_cascade0_distance. Cambiar su valor cambiará automáticamente también esas propiedades.


float sdfgi_min_cell_size = 0.2 🔗

  • void set_sdfgi_min_cell_size(value: float)

  • float get_sdfgi_min_cell_size()

El tamaño de celda que se utilizará para la cascada SDFGI más cercana (en unidades 3D). Los valores más bajos permiten que SDFGI sea más preciso de cerca, a costa de hacer que las actualizaciones de SDFGI sean más exigentes. Esto puede causar tartamudeo cuando la cámara se mueve rápidamente. Los valores más altos permiten que SDFGI cubra más terreno, al tiempo que reducen el impacto en el rendimiento de las actualizaciones de SDFGI.

Nota: Esta propiedad está enlazada a sdfgi_max_distance y a sdfgi_cascade0_distance. Cambiar su valor cambiará automáticamente también esas propiedades.


float sdfgi_normal_bias = 1.1 🔗

  • void set_sdfgi_normal_bias(value: float)

  • float get_sdfgi_normal_bias()

El sesgo normal que se utilizará para las sondas SDFGI. Aumentar este valor puede reducir los artefactos de rayado visibles en superficies inclinadas, a costa de una mayor fuga de luz.


float sdfgi_probe_bias = 1.1 🔗

  • void set_sdfgi_probe_bias(value: float)

  • float get_sdfgi_probe_bias()

El sesgo constante que se utilizará para las sondas SDFGI. Aumentar este valor puede reducir los artefactos de rayado visibles en superficies inclinadas, a costa de una mayor fuga de luz.


bool sdfgi_read_sky_light = true 🔗

  • void set_sdfgi_read_sky_light(value: bool)

  • bool is_sdfgi_reading_sky_light()

Si es true, SDFGI tiene en cuenta la iluminación del entorno. Esto debería establecerse en false para escenas de interior.


bool sdfgi_use_occlusion = false 🔗

  • void set_sdfgi_use_occlusion(value: bool)

  • bool is_sdfgi_using_occlusion()

Si es true, SDFGI utiliza un enfoque de detección de oclusión para reducir las fugas de luz. Sin embargo, la oclusión puede introducir manchas oscuras en ciertos puntos, lo que puede ser indeseable en escenas principalmente exteriores. sdfgi_use_occlusion tiene un impacto en el rendimiento y solo debe habilitarse cuando sea necesario.


SDFGIYScale sdfgi_y_scale = 1 🔗

La escala Y a utilizar para las celdas SDFGI. Los valores más bajos harán que las celdas SDFGI se empaqueten más juntas en el eje Y. Esto se utiliza para equilibrar la calidad y la cobertura de una gran cantidad de terreno vertical. sdfgi_y_scale debe establecerse dependiendo de lo vertical que sea tu escena (y de lo rápido que tu cámara pueda moverse en el eje Y).


Sky sky 🔗

  • void set_sky(value: Sky)

  • Sky get_sky()

El recurso Sky utilizado para este Environment.


float sky_custom_fov = 0.0 🔗

  • void set_sky_custom_fov(value: float)

  • float get_sky_custom_fov()

Si se establece en un valor mayor que 0.0, anula el campo de visión a utilizar para el renderizado del cielo. Si se establece en 0.0, se utiliza el mismo FOV que el Camera3D actual para el renderizado del cielo.


Vector3 sky_rotation = Vector3(0, 0, 0) 🔗

La rotación a utilizar para el renderizado del cielo.


float ssao_ao_channel_affect = 0.0 🔗

  • void set_ssao_ao_channel_affect(value: float)

  • float get_ssao_ao_channel_affect()

La intensidad de la oclusión ambiental del espacio de pantalla en los materiales que tienen una textura de AO definida. Los valores superiores a 0 harán visible el efecto SSAO en las áreas oscurecidas por las texturas de AO.


float ssao_detail = 0.5 🔗

  • void set_ssao_detail(value: float)

  • float get_ssao_detail()

Establece la fuerza del nivel de detalle adicional para el efecto de oclusión ambiental del espacio de la pantalla. Un valor alto hace que el pase de detalle sea más prominente, pero puede contribuir al aliasing en tu imagen final.


bool ssao_enabled = false 🔗

  • void set_ssao_enabled(value: bool)

  • bool is_ssao_enabled()

If true, the screen-space ambient occlusion effect is enabled. This darkens objects' corners and cavities to simulate ambient light not reaching the entire object as in real life. This works well for small, dynamic objects, but baked lighting or ambient occlusion textures will do a better job at displaying ambient occlusion on large static objects. Godot uses a form of SSAO called Adaptive Screen Space Ambient Occlusion which is itself a form of Horizon Based Ambient Occlusion.

Note: SSAO is only supported in the Forward+ rendering method, not Mobile or Compatibility.


float ssao_horizon = 0.06 🔗

  • void set_ssao_horizon(value: float)

  • float get_ssao_horizon()

El umbral para considerar si un punto dado en una superficie está ocluido o no, representado como un ángulo desde el horizonte mapeado en el rango 0.0-1.0. Un valor de 1.0 resulta en ninguna oclusión.


float ssao_intensity = 2.0 🔗

  • void set_ssao_intensity(value: float)

  • float get_ssao_intensity()

La intensidad primaria de la oclusión ambiental en el espacio de la pantalla. Actúa como un multiplicador para el efecto de oclusión ambiental en el espacio de la pantalla. Un valor más alto resulta en una oclusión más oscura.


float ssao_light_affect = 0.0 🔗

  • void set_ssao_direct_light_affect(value: float)

  • float get_ssao_direct_light_affect()

La intensidad de la oclusión ambiental del espacio de la pantalla en luz directa. En la vida real, la oclusión ambiental sólo se aplica a la luz indirecta, lo que significa que sus efectos no se pueden ver con luz directa. Los valores superiores a 0 harán que el efecto SSAO sea visible en luz directa.


float ssao_power = 1.5 🔗

  • void set_ssao_power(value: float)

  • float get_ssao_power()

La distribución de la oclusión. Un valor más alto resulta en una oclusión más oscura, similar a ssao_intensity, pero con una caída más pronunciada.


float ssao_radius = 1.0 🔗

  • void set_ssao_radius(value: float)

  • float get_ssao_radius()

La distancia a la que los objetos pueden ocluirse entre sí al calcular la oclusión ambiental del espacio de la pantalla. Los valores más altos darán como resultado una oclusión en una distancia mayor, a costa del rendimiento y la calidad.


float ssao_sharpness = 0.98 🔗

  • void set_ssao_sharpness(value: float)

  • float get_ssao_sharpness()

La cantidad que se permite que el efecto de oclusión ambiental del espacio de la pantalla se difumine sobre los bordes de los objetos. Si se establece un valor demasiado alto, se producirá aliasing alrededor de los bordes de los objetos. Si se establece un valor demasiado bajo, los bordes de los objetos aparecerán borrosos.


bool ssil_enabled = false 🔗

  • void set_ssil_enabled(value: bool)

  • bool is_ssil_enabled()

Si es true, el efecto de iluminación indirecta en el espacio de la pantalla está activado. La iluminación indirecta en el espacio de la pantalla es una forma de iluminación indirecta que permite que la luz difusa rebote entre los objetos cercanos. La iluminación indirecta en el espacio de la pantalla funciona de forma muy similar a la oclusión ambiental en el espacio de la pantalla, ya que solo afecta a un rango limitado. Está pensada para ser utilizada junto con una forma de iluminación global adecuada como SDFGI o VoxelGI. La iluminación indirecta del espacio de la pantalla no se ve afectada por la Light3D.light_indirect_energy de la luz individual.

Nota: SSIL solo se soporta en el método de renderizado Forward+, no en Mobile o Compatibility.


float ssil_intensity = 1.0 🔗

  • void set_ssil_intensity(value: float)

  • float get_ssil_intensity()

El multiplicador de brillo para el efecto de iluminación indirecta en el espacio de la pantalla. Un valor más alto resultará en una luz más brillante.


float ssil_normal_rejection = 1.0 🔗

  • void set_ssil_normal_rejection(value: float)

  • float get_ssil_normal_rejection()

Cantidad de rechazo normal utilizada al calcular la iluminación indirecta en el espacio de la pantalla. El rechazo normal utiliza la normal de un punto de muestra dado para rechazar las muestras que están orientadas en dirección opuesta al píxel actual. El rechazo normal es necesario para evitar fugas de luz cuando solo se ilumina un lado de un objeto. Sin embargo, el rechazo normal se puede desactivar si se desea la fuga de luz, como cuando la escena contiene principalmente objetos emisores que emiten luz desde caras que no se pueden ver desde la cámara.


float ssil_radius = 5.0 🔗

  • void set_ssil_radius(value: float)

  • float get_ssil_radius()

La distancia que puede viajar la iluminación rebotada cuando se utiliza el efecto de iluminación indirecta del espacio de la pantalla. Un valor mayor hará que la luz rebote más lejos en una escena, pero puede resultar en artefactos de submuestreo que parecen picos largos que rodean las fuentes de luz.


float ssil_sharpness = 0.98 🔗

  • void set_ssil_sharpness(value: float)

  • float get_ssil_sharpness()

La cantidad que se permite que el efecto de iluminación indirecta del espacio de la pantalla se difumine sobre los bordes de los objetos. Si se establece un valor demasiado alto, se producirá aliasing alrededor de los bordes de los objetos. Si se establece un valor demasiado bajo, los bordes de los objetos aparecerán borrosos.


float ssr_depth_tolerance = 0.2 🔗

  • void set_ssr_depth_tolerance(value: float)

  • float get_ssr_depth_tolerance()

La tolerancia de profundidad para los reflejos del espacio de la pantalla.


bool ssr_enabled = false 🔗

  • void set_ssr_enabled(value: bool)

  • bool is_ssr_enabled()

If true, screen-space reflections are enabled. Screen-space reflections are more accurate than reflections from VoxelGIs or ReflectionProbes, but are slower and can't reflect surfaces occluded by others.

Note: SSR is only supported in the Forward+ rendering method, not Mobile or Compatibility.

Note: SSR is not supported on viewports that have a transparent background (where Viewport.transparent_bg is true).


float ssr_fade_in = 0.15 🔗

  • void set_ssr_fade_in(value: float)

  • float get_ssr_fade_in()

The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection. Only positive values are valid (negative values will be clamped to 0.0).


float ssr_fade_out = 2.0 🔗

  • void set_ssr_fade_out(value: float)

  • float get_ssr_fade_out()

La distancia de atenuación para los reflejos del espacio de la pantalla. Afecta al área desde el reflejo del espacio de la pantalla hasta el reflejo "global". Solo son válidos los valores positivos (los valores negativos se limitarán a 0.0).


int ssr_max_steps = 64 🔗

  • void set_ssr_max_steps(value: int)

  • int get_ssr_max_steps()

El número máximo de pasos para los reflejos en el espacio de la pantalla. Los valores más altos son más lentos.


float tonemap_exposure = 1.0 🔗

  • void set_tonemap_exposure(value: float)

  • float get_tonemap_exposure()

Ajusta el brillo de los valores antes de que se proporcionen al mapeador de tonos.Los valores más altos de tonemap_exposure dan como resultado una imagen más brillante. Véase también tonemap_white.

Nota: Los valores proporcionados al mapeador de tonos también se multiplicarán por 2.0 y 1.8 para TONE_MAPPER_FILMIC y TONE_MAPPER_ACES respectivamente para producir un brillo aparente similar al de TONE_MAPPER_LINEAR.


ToneMapper tonemap_mode = 0 🔗

El modo de mapeo de tonos a utilizar. El mapeo de tonos es el proceso que "convierte" los valores HDR para que sean adecuados para su representación en una pantalla LDR (Godot todavía no soporta el renderizado en pantallas HDR).


float tonemap_white = 1.0 🔗

  • void set_tonemap_white(value: float)

  • float get_tonemap_white()

The white reference value for tonemapping, which indicates where bright white is located in the scale of values provided to the tonemapper. For photorealistic lighting, recommended values are between 6.0 and 8.0. Higher values result in less blown out highlights, but may make the scene appear lower contrast. See also tonemap_exposure.

Note: tonemap_white is ignored when using TONE_MAPPER_LINEAR or TONE_MAPPER_AGX.


Color volumetric_fog_albedo = Color(1, 1, 1, 1) 🔗

  • void set_volumetric_fog_albedo(value: Color)

  • Color get_volumetric_fog_albedo()

El Color de la niebla volumétrica cuando interactúa con las luces. La niebla y la neblina tienen un albedo cercano a Color(1, 1, 1, 1) mientras que el humo tiene un albedo más oscuro.


float volumetric_fog_ambient_inject = 0.0 🔗

  • void set_volumetric_fog_ambient_inject(value: float)

  • float get_volumetric_fog_ambient_inject()

Escala la fuerza de la luz ambiental utilizada en la niebla volumétrica. Un valor de 0.0 significa que la luz ambiental no afectará a la niebla volumétrica. volumetric_fog_ambient_inject tiene un pequeño coste de rendimiento cuando se establece por encima de 0.0.

Nota: Esto no tiene ningún efecto visible si volumetric_fog_density es 0.0 o si volumetric_fog_albedo es un color completamente negro.


float volumetric_fog_anisotropy = 0.2 🔗

  • void set_volumetric_fog_anisotropy(value: float)

  • float get_volumetric_fog_anisotropy()

La dirección de la luz dispersa a medida que atraviesa la niebla volumétrica. Un valor cercano a 1.0 significa que casi toda la luz se dispersa hacia adelante. Un valor cercano a 0.0 significa que la luz se dispersa por igual en todas las direcciones. Un valor cercano a -1.0 significa que la luz se dispersa principalmente hacia atrás. La niebla y la bruma dispersan la luz ligeramente hacia adelante, mientras que el humo dispersa la luz por igual en todas las direcciones.


float volumetric_fog_density = 0.05 🔗

  • void set_volumetric_fog_density(value: float)

  • float get_volumetric_fog_density()

The base exponential density of the volumetric fog. Set this to the lowest density you want to have globally. FogVolumes can be used to add to or subtract from this density in specific areas. Fog rendering is exponential as in real life.

A value of 0.0 disables global volumetric fog while allowing FogVolumes to display volumetric fog in specific areas.

To make volumetric fog work as a volumetric lighting solution, set volumetric_fog_density to the lowest non-zero value (0.0001) then increase lights' Light3D.light_volumetric_fog_energy to values between 10000 and 100000 to compensate for the very low density.


float volumetric_fog_detail_spread = 2.0 🔗

  • void set_volumetric_fog_detail_spread(value: float)

  • float get_volumetric_fog_detail_spread()

La distribución del tamaño a lo largo del búfer de fróxeles. Un valor más alto comprime los fróxeles más cerca de la cámara y coloca más detalles más cerca de la cámara.


Color volumetric_fog_emission = Color(0, 0, 0, 1) 🔗

  • void set_volumetric_fog_emission(value: Color)

  • Color get_volumetric_fog_emission()

La luz emitida por la niebla volumétrica. Incluso con la emisión, la niebla volumétrica no proyectará luz sobre otras superficies. La emisión es útil para establecer un color ambiental. Como el efecto de niebla volumétrica utiliza sólo la dispersión simple, la niebla tiende a necesitar un poco de emisión para suavizar las sombras duras.


float volumetric_fog_emission_energy = 1.0 🔗

  • void set_volumetric_fog_emission_energy(value: float)

  • float get_volumetric_fog_emission_energy()

El brillo de la luz emitida por la niebla volumétrica.


bool volumetric_fog_enabled = false 🔗

  • void set_volumetric_fog_enabled(value: bool)

  • bool is_volumetric_fog_enabled()

Activa el efecto de niebla volumétrica. La niebla volumétrica utiliza un búfer de fróxeles alineado con la pantalla para calcular la dispersión volumétrica precisa en el rango corto a medio. La niebla volumétrica interactúa con los FogVolumes y las luces para calcular la niebla localizada y global. La niebla volumétrica utiliza un modelo de dispersión única PBR basado en la extinción, la dispersión y la emisión, que expone a los usuarios como densidad, albedo y emisión.

Nota: La niebla volumétrica solo es compatible con el método de renderizado Forward+, no con Mobile o Compatibility.


float volumetric_fog_gi_inject = 1.0 🔗

  • void set_volumetric_fog_gi_inject(value: float)

  • float get_volumetric_fog_gi_inject()

Escala la fuerza de la Iluminación Global utilizada en el color albedo de la niebla volumétrica. Un valor de 0.0 significa que la Iluminación Global no afectará a la niebla volumétrica. volumetric_fog_gi_inject tiene un pequeño coste de rendimiento cuando se establece por encima de 0.0.

Nota: Esto no tiene ningún efecto visible si volumetric_fog_density es 0.0 o si volumetric_fog_albedo es un color completamente negro.

Nota: Solo VoxelGI y SDFGI (sdfgi_enabled) se tienen en cuenta al usar volumetric_fog_gi_inject. La iluminación global de LightmapGI, ReflectionProbe y SSIL (ver ssil_enabled) será ignorada por la niebla volumétrica.


float volumetric_fog_length = 64.0 🔗

  • void set_volumetric_fog_length(value: float)

  • float get_volumetric_fog_length()

La distancia sobre la que se calcula la niebla volumétrica. Aumenta para calcular la niebla en un rango mayor, disminuye para añadir más detalle cuando no se necesita un rango largo. Para obtener la mejor calidad de niebla, mantenlo lo más bajo posible. Véase también ProjectSettings.rendering/environment/volumetric_fog/volume_depth.


float volumetric_fog_sky_affect = 1.0 🔗

  • void set_volumetric_fog_sky_affect(value: float)

  • float get_volumetric_fog_sky_affect()

El factor a utilizar al afectar el cielo con la niebla volumétrica. 1.0 significa que la niebla volumétrica puede oscurecer completamente el cielo. Los valores más bajos reducen el impacto de la niebla volumétrica en el renderizado del cielo, y 0.0 no afecta en absoluto al renderizado del cielo.

Nota: volumetric_fog_sky_affect también afecta a los FogVolumes, incluso si volumetric_fog_density es 0.0. Si notas que los FogVolumes desaparecen al mirar hacia el cielo, establece volumetric_fog_sky_affect a 1.0.


float volumetric_fog_temporal_reprojection_amount = 0.9 🔗

  • void set_volumetric_fog_temporal_reprojection_amount(value: float)

  • float get_volumetric_fog_temporal_reprojection_amount()

The amount by which to blend the last frame with the current frame. A higher number results in smoother volumetric fog, but makes "ghosting" much worse. A lower value reduces ghosting but can result in the per-frame temporal jitter becoming visible.


bool volumetric_fog_temporal_reprojection_enabled = true 🔗

  • void set_volumetric_fog_temporal_reprojection_enabled(value: bool)

  • bool is_volumetric_fog_temporal_reprojection_enabled()

Enables temporal reprojection in the volumetric fog. Temporal reprojection blends the current frame's volumetric fog with the last frame's volumetric fog to smooth out jagged edges. The performance cost is minimal; however, it leads to moving FogVolumes and Light3Ds "ghosting" and leaving a trail behind them. When temporal reprojection is enabled, try to avoid moving FogVolumes or Light3Ds too fast. Short-lived dynamic lighting effects should have Light3D.light_volumetric_fog_energy set to 0.0 to avoid ghosting.


Descripciones de Métodos

float get_glow_level(idx: int) const 🔗

Devuelve la intensidad del nivel de brillo idx.


void set_glow_level(idx: int, intensity: float) 🔗

Establece la intensidad del nivel de brillo idx. Un valor superior a 0.0 activa el nivel. Cada nivel se basa en el nivel anterior. Esto significa que habilitar niveles de brillo más altos ralentizará el procesamiento del efecto de brillo, incluso si los niveles anteriores no están habilitados.