Environment

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Resource for environment nodes (like WorldEnvironment) that define multiple rendering options.

Properties

float adjustment_brightness
Texture adjustment_color_correction
float adjustment_contrast
bool adjustment_enabled
float adjustment_saturation
Color ambient_light_color
float ambient_light_energy
float ambient_light_sky_contribution
bool auto_exposure_enabled
float auto_exposure_max_luma
float auto_exposure_min_luma
float auto_exposure_scale
float auto_exposure_speed
int background_canvas_max_layer
Color background_color
float background_energy
BGMode background_mode
Sky background_sky
float background_sky_custom_fov
float dof_blur_far_amount
float dof_blur_far_distance
bool dof_blur_far_enabled
DOFBlurQuality dof_blur_far_quality
float dof_blur_far_transition
float dof_blur_near_amount
float dof_blur_near_distance
bool dof_blur_near_enabled
DOFBlurQuality dof_blur_near_quality
float dof_blur_near_transition
Color fog_color
float fog_depth_begin
float fog_depth_curve
bool fog_depth_enabled
bool fog_enabled
float fog_height_curve
bool fog_height_enabled
float fog_height_max
float fog_height_min
float fog_sun_amount
Color fog_sun_color
float fog_transmit_curve
bool fog_transmit_enabled
bool glow_bicubic_upscale
GlowBlendMode glow_blend_mode
float glow_bloom
bool glow_enabled
float glow_hdr_scale
float glow_hdr_threshold
float glow_intensity
bool glow_levels/1
bool glow_levels/2
bool glow_levels/3
bool glow_levels/4
bool glow_levels/5
bool glow_levels/6
bool glow_levels/7
float glow_strength
float ss_reflections_depth_tolerance
bool ss_reflections_enabled
float ss_reflections_fade_in
float ss_reflections_fade_out
int ss_reflections_max_steps
bool ss_reflections_roughness
float ssao_ao_channel_affect
float ssao_bias
SSAOBlur ssao_blur
Color ssao_color
float ssao_edge_sharpness
bool ssao_enabled
float ssao_intensity
float ssao_intensity2
float ssao_light_affect
SSAOQuality ssao_quality
float ssao_radius
float ssao_radius2
float tonemap_exposure
ToneMapper tonemap_mode
float tonemap_white

Enumerations

enum BGMode:

  • BG_KEEP = 5 — Keep on screen every pixel drawn in the background.
  • BG_CLEAR_COLOR = 0 — Clear the background using the project’s clear color.
  • BG_COLOR = 1 — Clear the background using a custom clear color.
  • BG_SKY = 2 — Display a user-defined sky in the background.
  • BG_COLOR_SKY = 3 — Clear the background using a custom clear color and allows defining a sky for shading and reflection.
  • BG_CANVAS = 4 — Display a CanvasLayer in the background.
  • BG_MAX = 6 — Helper constant keeping track of the enum’s size, has no direct usage in API calls.

enum DOFBlurQuality:

  • DOF_BLUR_QUALITY_LOW = 0 — Low depth-of-field blur quality.
  • DOF_BLUR_QUALITY_MEDIUM = 1 — Medium depth-of-field blur quality.
  • DOF_BLUR_QUALITY_HIGH = 2 — High depth-of-field blur quality.

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 — Softlight 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.

enum ToneMapper:

  • TONE_MAPPER_LINEAR = 0 — Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.
  • 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
  • SSAO_BLUR_1x1 = 1
  • SSAO_BLUR_2x2 = 2
  • SSAO_BLUR_3x3 = 3

enum SSAOQuality:

  • SSAO_QUALITY_LOW = 0
  • SSAO_QUALITY_MEDIUM = 1
  • SSAO_QUALITY_HIGH = 2

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:

  • DOF Blur
  • Motion Blur
  • Bloom
  • Tonemap (auto exposure)
  • Adjustments

Property Descriptions

  • float adjustment_brightness
Setter set_adjustment_brightness(value)
Getter get_adjustment_brightness()

Global brightness value of the rendered scene (default value is 1).

  • Texture adjustment_color_correction
Setter set_adjustment_color_correction(value)
Getter get_adjustment_color_correction()

Applies the provided Texture resource to affect the global color aspect of the rendered scene.

  • float adjustment_contrast
Setter set_adjustment_contrast(value)
Getter get_adjustment_contrast()

Global contrast value of the rendered scene (default value is 1).

  • bool adjustment_enabled
Setter set_adjustment_enable(value)
Getter is_adjustment_enabled()

Enables the adjustment_* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.

  • float adjustment_saturation
Setter set_adjustment_saturation(value)
Getter get_adjustment_saturation()

Global color saturation value of the rendered scene (default value is 1).

  • Color ambient_light_color
Setter set_ambient_light_color(value)
Getter get_ambient_light_color()

Color of the ambient light.

  • float ambient_light_energy
Setter set_ambient_light_energy(value)
Getter get_ambient_light_energy()

Energy of the ambient light. The higher the value, the stronger the light.

  • float ambient_light_sky_contribution
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.

  • bool auto_exposure_enabled
Setter set_tonemap_auto_exposure(value)
Getter get_tonemap_auto_exposure()

Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light.

  • float auto_exposure_max_luma
Setter set_tonemap_auto_exposure_max(value)
Getter get_tonemap_auto_exposure_max()

Maximum luminance value for the auto exposure.

  • float auto_exposure_min_luma
Setter set_tonemap_auto_exposure_min(value)
Getter get_tonemap_auto_exposure_min()

Minimum luminance value for the auto exposure.

  • float auto_exposure_scale
Setter set_tonemap_auto_exposure_grey(value)
Getter get_tonemap_auto_exposure_grey()

Scale of the auto exposure effect. Affects the intensity of auto exposure.

  • float auto_exposure_speed
Setter set_tonemap_auto_exposure_speed(value)
Getter get_tonemap_auto_exposure_speed()

Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.

  • int background_canvas_max_layer
Setter set_canvas_max_layer(value)
Getter get_canvas_max_layer()

Maximum layer id (if using Layer background mode).

Setter set_bg_color(value)
Getter get_bg_color()

Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).

  • float background_energy
Setter set_bg_energy(value)
Getter get_bg_energy()

Power of light emitted by the background.

Setter set_background(value)
Getter get_background()

Defines the mode of background.

  • Sky background_sky
Setter set_sky(value)
Getter get_sky()

Sky resource defined as background.

  • float background_sky_custom_fov
Setter set_sky_custom_fov(value)
Getter get_sky_custom_fov()

Sky resource’s custom field of view.

  • float dof_blur_far_amount
Setter set_dof_blur_far_amount(value)
Getter get_dof_blur_far_amount()

Amount of far blur.

  • float dof_blur_far_distance
Setter set_dof_blur_far_distance(value)
Getter get_dof_blur_far_distance()

Distance from the camera where the far blur effect affects the rendering.

  • bool dof_blur_far_enabled
Setter set_dof_blur_far_enabled(value)
Getter is_dof_blur_far_enabled()

Enables the far blur effect.

Setter set_dof_blur_far_quality(value)
Getter get_dof_blur_far_quality()

Quality of the far blur quality.

  • float dof_blur_far_transition
Setter set_dof_blur_far_transition(value)
Getter get_dof_blur_far_transition()

Transition between no-blur area and far blur.

  • float dof_blur_near_amount
Setter set_dof_blur_near_amount(value)
Getter get_dof_blur_near_amount()

Amount of near blur.

  • float dof_blur_near_distance
Setter set_dof_blur_near_distance(value)
Getter get_dof_blur_near_distance()

Distance from the camera where the near blur effect affects the rendering.

  • bool dof_blur_near_enabled
Setter set_dof_blur_near_enabled(value)
Getter is_dof_blur_near_enabled()

Enables the near blur effect.

Setter set_dof_blur_near_quality(value)
Getter get_dof_blur_near_quality()

Quality of the near blur quality.

  • float dof_blur_near_transition
Setter set_dof_blur_near_transition(value)
Getter get_dof_blur_near_transition()

Transition between near blur and no-blur area.

Setter set_fog_color(value)
Getter get_fog_color()

Fog’s Color.

Setter set_fog_depth_begin(value)
Getter get_fog_depth_begin()

Fog’s depth starting distance from the camera.

Setter set_fog_depth_curve(value)
Getter get_fog_depth_curve()

Value defining the fog depth intensity.

  • bool fog_depth_enabled
Setter set_fog_depth_enabled(value)
Getter is_fog_depth_enabled()

Enables the fog depth.

Setter set_fog_enabled(value)
Getter is_fog_enabled()

Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.

Setter set_fog_height_curve(value)
Getter get_fog_height_curve()

Value defining the fog height intensity.

  • bool fog_height_enabled
Setter set_fog_height_enabled(value)
Getter is_fog_height_enabled()

Enables the fog height.

Setter set_fog_height_max(value)
Getter get_fog_height_max()

Maximum height of fog.

Setter set_fog_height_min(value)
Getter get_fog_height_min()

Minimum height of fog.

Setter set_fog_sun_amount(value)
Getter get_fog_sun_amount()

Amount of sun that affects the fog rendering.

Setter set_fog_sun_color(value)
Getter get_fog_sun_color()

Sun Color.

  • float fog_transmit_curve
Setter set_fog_transmit_curve(value)
Getter get_fog_transmit_curve()

Amount of light that the fog transmits.

  • bool fog_transmit_enabled
Setter set_fog_transmit_enabled(value)
Getter is_fog_transmit_enabled()

Enables fog’s light transmission. If enabled, lets reflections light to be transmitted by the fog.

  • bool glow_bicubic_upscale
Setter set_glow_bicubic_upscale(value)
Getter is_glow_bicubic_upscale_enabled()
Setter set_glow_blend_mode(value)
Getter get_glow_blend_mode()

Glow blending mode.

Setter set_glow_bloom(value)
Getter get_glow_bloom()

Bloom value (global glow).

Setter set_glow_enabled(value)
Getter is_glow_enabled()

Enables glow rendering.

Setter set_glow_hdr_bleed_scale(value)
Getter get_glow_hdr_bleed_scale()

Bleed scale of the HDR glow.

  • float glow_hdr_threshold
Setter set_glow_hdr_bleed_threshold(value)
Getter get_glow_hdr_bleed_threshold()

Bleed threshold of the HDR glow.

Setter set_glow_intensity(value)
Getter get_glow_intensity()

Glow intensity.

  • bool glow_levels/1
Setter set_glow_level(value)
Getter is_glow_level_enabled()

First level of glow (most local).

  • bool glow_levels/2
Setter set_glow_level(value)
Getter is_glow_level_enabled()

Second level of glow.

  • bool glow_levels/3
Setter set_glow_level(value)
Getter is_glow_level_enabled()

Third level of glow.

  • bool glow_levels/4
Setter set_glow_level(value)
Getter is_glow_level_enabled()

Fourth level of glow.

  • bool glow_levels/5
Setter set_glow_level(value)
Getter is_glow_level_enabled()

Fifth level of glow.

  • bool glow_levels/6
Setter set_glow_level(value)
Getter is_glow_level_enabled()

Sixth level of glow.

  • bool glow_levels/7
Setter set_glow_level(value)
Getter is_glow_level_enabled()

Seventh level of glow (most global).

Setter set_glow_strength(value)
Getter get_glow_strength()

Glow strength.

  • float ss_reflections_depth_tolerance
Setter set_ssr_depth_tolerance(value)
Getter get_ssr_depth_tolerance()
  • bool ss_reflections_enabled
Setter set_ssr_enabled(value)
Getter is_ssr_enabled()
  • float ss_reflections_fade_in
Setter set_ssr_fade_in(value)
Getter get_ssr_fade_in()
  • float ss_reflections_fade_out
Setter set_ssr_fade_out(value)
Getter get_ssr_fade_out()
  • int ss_reflections_max_steps
Setter set_ssr_max_steps(value)
Getter get_ssr_max_steps()
  • bool ss_reflections_roughness
Setter set_ssr_rough(value)
Getter is_ssr_rough()
  • float ssao_ao_channel_affect
Setter set_ssao_ao_channel_affect(value)
Getter get_ssao_ao_channel_affect()
Setter set_ssao_bias(value)
Getter get_ssao_bias()
Setter set_ssao_blur(value)
Getter is_ssao_blur_enabled()
Setter set_ssao_color(value)
Getter get_ssao_color()
  • float ssao_edge_sharpness
Setter set_ssao_edge_sharpness(value)
Getter get_ssao_edge_sharpness()
Setter set_ssao_enabled(value)
Getter is_ssao_enabled()
Setter set_ssao_intensity(value)
Getter get_ssao_intensity()
Setter set_ssao_intensity2(value)
Getter get_ssao_intensity2()
  • float ssao_light_affect
Setter set_ssao_direct_light_affect(value)
Getter get_ssao_direct_light_affect()
Setter set_ssao_quality(value)
Getter get_ssao_quality()
Setter set_ssao_radius(value)
Getter get_ssao_radius()
Setter set_ssao_radius2(value)
Getter get_ssao_radius2()
Setter set_tonemap_exposure(value)
Getter get_tonemap_exposure()

Default exposure for tonemap.

Setter set_tonemapper(value)
Getter get_tonemapper()

Tonemapping mode.

Setter set_tonemap_white(value)
Getter get_tonemap_white()

White reference value for tonemap.