Environment¶
Inherits: Resource < Reference < Object
Resource for environment nodes (like WorldEnvironment) that define multiple rendering options.
Description¶
Resource for environment nodes (like WorldEnvironment) that define multiple environment operations (such as background Sky or Color, ambient light, fog, depth-of-field...). These parameters affect the final render of the scene. The order of these operations is:
Depth of Field Blur
Glow
Tonemap (Auto Exposure)
Adjustments
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
is_glow_level_enabled ( int idx ) const |
|
void |
set_glow_level ( int idx, bool enabled ) |
Enumerations¶
enum BGMode:
BG_CLEAR_COLOR = 0 --- Clears the background using the clear color defined in ProjectSettings.rendering/environment/default_clear_color.
BG_COLOR = 1 --- Clears the background using a custom clear color.
BG_SKY = 2 --- Displays a user-defined sky in the background.
BG_CANVAS = 3 --- Displays a CanvasLayer in the background.
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.
BG_CAMERA_FEED = 5 --- Displays a camera feed in the background.
BG_MAX = 6 --- Represents the size of the BGMode enum.
enum AmbientSource:
AMBIENT_SOURCE_BG = 0
AMBIENT_SOURCE_DISABLED = 1
AMBIENT_SOURCE_COLOR = 2
AMBIENT_SOURCE_SKY = 3
enum ReflectionSource:
REFLECTION_SOURCE_BG = 0
REFLECTION_SOURCE_DISABLED = 1
REFLECTION_SOURCE_SKY = 2
enum GlowBlendMode:
GLOW_BLEND_MODE_ADDITIVE = 0 --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
GLOW_BLEND_MODE_SCREEN = 1 --- Screen glow blending mode. Increases brightness, used frequently with bloom.
GLOW_BLEND_MODE_SOFTLIGHT = 2 --- Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
GLOW_BLEND_MODE_REPLACE = 3 --- Replace glow blending mode. Replaces all pixels' color by the glow value. This can be used to simulate a full-screen blur effect by tweaking the glow parameters to match the original image's brightness.
GLOW_BLEND_MODE_MIX = 4
enum ToneMapper:
TONE_MAPPER_LINEAR = 0 --- Linear tonemapper operator. Reads the linear data and passes it on unmodified.
TONE_MAPPER_REINHARDT = 1 --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula:
color = color / (1 + color).TONE_MAPPER_FILMIC = 2 --- Filmic tonemapper operator.
TONE_MAPPER_ACES = 3 --- Academy Color Encoding System tonemapper operator.
enum SSAOBlur:
SSAO_BLUR_DISABLED = 0 --- No blur for the screen-space ambient occlusion effect (fastest).
SSAO_BLUR_1x1 = 1 --- 1×1 blur for the screen-space ambient occlusion effect.
SSAO_BLUR_2x2 = 2 --- 2×2 blur for the screen-space ambient occlusion effect.
SSAO_BLUR_3x3 = 3 --- 3×3 blur for the screen-space ambient occlusion effect (slowest).
Property Descriptions¶
float adjustment_brightness
Default |
|
Setter |
set_adjustment_brightness(value) |
Getter |
get_adjustment_brightness() |
The global brightness value of the rendered scene. Effective only if adjustment_enabled is true.
Texture2D adjustment_color_correction
Setter |
set_adjustment_color_correction(value) |
Getter |
get_adjustment_color_correction() |
Applies the provided Texture2D resource to affect the global color aspect of the rendered scene. Effective only if adjustment_enabled is true.
float adjustment_contrast
Default |
|
Setter |
set_adjustment_contrast(value) |
Getter |
get_adjustment_contrast() |
The global contrast value of the rendered scene (default value is 1). Effective only if adjustment_enabled is true.
bool adjustment_enabled
Default |
|
Setter |
set_adjustment_enable(value) |
Getter |
is_adjustment_enabled() |
If true, enables the adjustment_* properties provided by this resource. If false, modifications to the adjustment_* properties will have no effect on the rendered scene.
float adjustment_saturation
Default |
|
Setter |
set_adjustment_saturation(value) |
Getter |
get_adjustment_saturation() |
The global color saturation value of the rendered scene (default value is 1). Effective only if adjustment_enabled is true.
Color ambient_light_color
Default |
|
Setter |
set_ambient_light_color(value) |
Getter |
get_ambient_light_color() |
The ambient light's Color.
float ambient_light_energy
Default |
|
Setter |
set_ambient_light_energy(value) |
Getter |
get_ambient_light_energy() |
The ambient light's energy. The higher the value, the stronger the light.
Color ambient_light_occlusion_color
Default |
|
Setter |
set_ao_color(value) |
Getter |
get_ao_color() |
float ambient_light_sky_contribution
Default |
|
Setter |
set_ambient_light_sky_contribution(value) |
Getter |
get_ambient_light_sky_contribution() |
Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene.
AmbientSource ambient_light_source
Default |
|
Setter |
set_ambient_source(value) |
Getter |
get_ambient_source() |
bool auto_exposure_enabled
Default |
|
Setter |
set_tonemap_auto_exposure(value) |
Getter |
get_tonemap_auto_exposure() |
If true, enables the tonemapping auto exposure mode of the scene renderer. If true, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light.
float auto_exposure_max_luma
Default |
|
Setter |
set_tonemap_auto_exposure_max(value) |
Getter |
get_tonemap_auto_exposure_max() |
The maximum luminance value for the auto exposure.
float auto_exposure_min_luma
Default |
|
Setter |
set_tonemap_auto_exposure_min(value) |
Getter |
get_tonemap_auto_exposure_min() |
The minimum luminance value for the auto exposure.
float auto_exposure_scale
Default |
|
Setter |
set_tonemap_auto_exposure_grey(value) |
Getter |
get_tonemap_auto_exposure_grey() |
The scale of the auto exposure effect. Affects the intensity of auto exposure.
float auto_exposure_speed
Default |
|
Setter |
set_tonemap_auto_exposure_speed(value) |
Getter |
get_tonemap_auto_exposure_speed() |
The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
int background_camera_feed_id
Default |
|
Setter |
set_camera_feed_id(value) |
Getter |
get_camera_feed_id() |
The ID of the camera feed to show in the background.
int background_canvas_max_layer
Default |
|
Setter |
set_canvas_max_layer(value) |
Getter |
get_canvas_max_layer() |
The maximum layer ID to display. Only effective when using the BG_CANVAS background mode.
Color background_color
Default |
|
Setter |
set_bg_color(value) |
Getter |
get_bg_color() |
The Color displayed for clear areas of the scene. Only effective when using the BG_COLOR background mode.
float background_energy
Default |
|
Setter |
set_bg_energy(value) |
Getter |
get_bg_energy() |
The power of the light emitted by the background.
BGMode background_mode
Default |
|
Setter |
set_background(value) |
Getter |
get_background() |
The background mode. See BGMode for possible values.
Color fog_color
Default |
|
Setter |
set_fog_color(value) |
Getter |
get_fog_color() |
The fog's Color.
float fog_depth_begin
Default |
|
Setter |
set_fog_depth_begin(value) |
Getter |
get_fog_depth_begin() |
The fog's depth starting distance from the camera.
float fog_depth_curve
Default |
|
Setter |
set_fog_depth_curve(value) |
Getter |
get_fog_depth_curve() |
The fog depth's intensity curve. A number of presets are available in the Inspector by right-clicking the curve.
bool fog_depth_enabled
Default |
|
Setter |
set_fog_depth_enabled(value) |
Getter |
is_fog_depth_enabled() |
If true, the depth fog effect is enabled. When enabled, fog will appear in the distance (relative to the camera).
float fog_depth_end
Default |
|
Setter |
set_fog_depth_end(value) |
Getter |
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 Camera.far value.
bool fog_enabled
Default |
|
Setter |
set_fog_enabled(value) |
Getter |
is_fog_enabled() |
If true, fog effects are enabled. fog_height_enabled and/or fog_depth_enabled must be set to true to actually display fog.
float fog_height_curve
Default |
|
Setter |
set_fog_height_curve(value) |
Getter |
get_fog_height_curve() |
The height fog's intensity. A number of presets are available in the Inspector by right-clicking the curve.
bool fog_height_enabled
Default |
|
Setter |
set_fog_height_enabled(value) |
Getter |
is_fog_height_enabled() |
If true, the height fog effect is enabled. When enabled, fog will appear in a defined height range, regardless of the distance from the camera. This can be used to simulate "deep water" effects with a lower performance cost compared to a dedicated shader.
float fog_height_max
Default |
|
Setter |
set_fog_height_max(value) |
Getter |
get_fog_height_max() |
The Y coordinate where the height fog will be the most intense. If this value is greater than fog_height_min, fog will be displayed from bottom to top. Otherwise, it will be displayed from top to bottom.
float fog_height_min
Default |
|
Setter |
set_fog_height_min(value) |
Getter |
get_fog_height_min() |
The Y coordinate where the height fog will be the least intense. If this value is greater than fog_height_max, fog will be displayed from top to bottom. Otherwise, it will be displayed from bottom to top.
float fog_sun_amount
Default |
|
Setter |
set_fog_sun_amount(value) |
Getter |
get_fog_sun_amount() |
The intensity of the depth fog color transition when looking towards the sun. The sun's direction is determined automatically using the DirectionalLight node in the scene.
Color fog_sun_color
Default |
|
Setter |
set_fog_sun_color(value) |
Getter |
get_fog_sun_color() |
The depth fog's Color when looking towards the sun.
float fog_transmit_curve
Default |
|
Setter |
set_fog_transmit_curve(value) |
Getter |
get_fog_transmit_curve() |
The intensity of the fog light transmittance effect. Amount of light that the fog transmits.
bool fog_transmit_enabled
Default |
|
Setter |
set_fog_transmit_enabled(value) |
Getter |
is_fog_transmit_enabled() |
Enables fog's light transmission effect. If true, light will be more visible in the fog to simulate light scattering as in real life.
bool glow_bicubic_upscale
Default |
|
Setter |
set_glow_bicubic_upscale(value) |
Getter |
is_glow_bicubic_upscale_enabled() |
Smooths out the blockiness created by sampling higher levels, at the cost of performance.
Note: When using the GLES2 renderer, this is only available if the GPU supports the GL_EXT_gpu_shader4 extension.
GlowBlendMode glow_blend_mode
Default |
|
Setter |
set_glow_blend_mode(value) |
Getter |
get_glow_blend_mode() |
The glow blending mode.
float glow_bloom
Default |
|
Setter |
set_glow_bloom(value) |
Getter |
get_glow_bloom() |
The bloom's intensity. If set to a value higher than 0, this will make glow visible in areas darker than the glow_hdr_threshold.
bool glow_enabled
Default |
|
Setter |
set_glow_enabled(value) |
Getter |
is_glow_enabled() |
If true, the glow effect is enabled.
float glow_hdr_luminance_cap
Default |
|
Setter |
set_glow_hdr_luminance_cap(value) |
Getter |
get_glow_hdr_luminance_cap() |
The higher threshold of the HDR glow. Areas brighter than this threshold will be clamped for the purposes of the glow effect.
float glow_hdr_scale
Default |
|
Setter |
set_glow_hdr_bleed_scale(value) |
Getter |
get_glow_hdr_bleed_scale() |
The bleed scale of the HDR glow.
float glow_hdr_threshold
Default |
|
Setter |
set_glow_hdr_bleed_threshold(value) |
Getter |
get_glow_hdr_bleed_threshold() |
The lower threshold of the HDR glow. When using the GLES2 renderer (which doesn't support HDR), this needs to be below 1.0 for glow to be visible. A value of 0.9 works well in this case.
float glow_intensity
Default |
|
Setter |
set_glow_intensity(value) |
Getter |
get_glow_intensity() |
The glow intensity. When using the GLES2 renderer, this should be increased to 1.5 to compensate for the lack of HDR rendering.
bool glow_levels/1
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 1st level of glow is enabled. This is the most "local" level (least blurry).
bool glow_levels/2
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 2th level of glow is enabled.
bool glow_levels/3
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 3th level of glow is enabled.
bool glow_levels/4
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 4th level of glow is enabled.
bool glow_levels/5
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 5th level of glow is enabled.
bool glow_levels/6
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 6th level of glow is enabled.
bool glow_levels/7
Default |
|
Setter |
set_glow_level(value) |
Getter |
is_glow_level_enabled() |
If true, the 7th level of glow is enabled. This is the most "global" level (blurriest).
float glow_mix
Default |
|
Setter |
set_glow_mix(value) |
Getter |
get_glow_mix() |
float glow_strength
Default |
|
Setter |
set_glow_strength(value) |
Getter |
get_glow_strength() |
The glow strength. When using the GLES2 renderer, this should be increased to 1.3 to compensate for the lack of HDR rendering.
ReflectionSource reflected_light_source
Default |
|
Setter |
set_reflection_source(value) |
Getter |
get_reflection_source() |
Sky sky
Setter |
set_sky(value) |
Getter |
get_sky() |
The Sky resource used for this Environment.
float sky_custom_fov
Default |
|
Setter |
set_sky_custom_fov(value) |
Getter |
get_sky_custom_fov() |
Vector3 sky_rotation
Default |
|
Setter |
set_sky_rotation(value) |
Getter |
get_sky_rotation() |
float ss_reflections_depth_tolerance
Default |
|
Setter |
set_ssr_depth_tolerance(value) |
Getter |
get_ssr_depth_tolerance() |
The depth tolerance for screen-space reflections.
bool ss_reflections_enabled
Default |
|
Setter |
set_ssr_enabled(value) |
Getter |
is_ssr_enabled() |
If true, screen-space reflections are enabled. Screen-space reflections are more accurate than reflections from GIProbes or ReflectionProbes, but are slower and can't reflect surfaces occluded by others.
float ss_reflections_fade_in
Default |
|
Setter |
set_ssr_fade_in(value) |
Getter |
get_ssr_fade_in() |
The fade-in distance for screen-space reflections. Affects the area from the reflected material to the screen-space reflection).
float ss_reflections_fade_out
Default |
|
Setter |
set_ssr_fade_out(value) |
Getter |
get_ssr_fade_out() |
The fade-out distance for screen-space reflections. Affects the area from the screen-space reflection to the "global" reflection.
int ss_reflections_max_steps
Default |
|
Setter |
set_ssr_max_steps(value) |
Getter |
get_ssr_max_steps() |
The maximum number of steps for screen-space reflections. Higher values are slower.
bool ss_reflections_roughness
Default |
|
Setter |
set_ssr_rough(value) |
Getter |
is_ssr_rough() |
If true, screen-space reflections will take the material roughness into account.
float ssao_ao_channel_affect
Default |
|
Setter |
set_ssao_ao_channel_affect(value) |
Getter |
get_ssao_ao_channel_affect() |
The screen-space ambient occlusion intensity on materials that have an AO texture defined. Values higher than 0 will make the SSAO effect visible in areas darkened by AO textures.
float ssao_bias
Default |
|
Setter |
set_ssao_bias(value) |
Getter |
get_ssao_bias() |
The screen-space ambient occlusion bias. This should be kept high enough to prevent "smooth" curves from being affected by ambient occlusion.
SSAOBlur ssao_blur
Default |
|
Setter |
set_ssao_blur(value) |
Getter |
get_ssao_blur() |
The screen-space ambient occlusion blur quality. See SSAOBlur for possible values.
float ssao_edge_sharpness
Default |
|
Setter |
set_ssao_edge_sharpness(value) |
Getter |
get_ssao_edge_sharpness() |
The screen-space ambient occlusion edge sharpness.
bool ssao_enabled
Default |
|
Setter |
set_ssao_enabled(value) |
Getter |
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. This is a costly effect and should be disabled first when running into performance issues.
float ssao_intensity
Default |
|
Setter |
set_ssao_intensity(value) |
Getter |
get_ssao_intensity() |
The primary screen-space ambient occlusion intensity. See also ssao_radius.
float ssao_light_affect
Default |
|
Setter |
set_ssao_direct_light_affect(value) |
Getter |
get_ssao_direct_light_affect() |
The screen-space ambient occlusion intensity in direct light. In real life, ambient occlusion only applies to indirect light, which means its effects can't be seen in direct light. Values higher than 0 will make the SSAO effect visible in direct light.
float ssao_radius
Default |
|
Setter |
set_ssao_radius(value) |
Getter |
get_ssao_radius() |
The primary screen-space ambient occlusion radius.
float tonemap_exposure
Default |
|
Setter |
set_tonemap_exposure(value) |
Getter |
get_tonemap_exposure() |
The default exposure used for tonemapping.
ToneMapper tonemap_mode
Default |
|
Setter |
set_tonemapper(value) |
Getter |
get_tonemapper() |
The tonemapping mode to use. Tonemapping is the process that "converts" HDR values to be suitable for rendering on a LDR display. (Godot doesn't support rendering on HDR displays yet.)
float tonemap_white
Default |
|
Setter |
set_tonemap_white(value) |
Getter |
get_tonemap_white() |
The white reference value for tonemapping. Only effective if the tonemap_mode isn't set to TONE_MAPPER_LINEAR.
Method Descriptions¶
Returns true if the glow level idx is specified, false otherwise.
Enables or disables the glow level at index idx. Each level relies on the previous level. This means that enabling higher glow levels will slow down the glow effect rendering, even if previous levels aren't enabled.