Environment

Inherits: Resource < Reference < Object

Category: Core

Brief Description

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

Properties

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
bool auto_exposure_enabled false
float auto_exposure_max_luma 8.0
float auto_exposure_min_luma 0.05
float auto_exposure_scale 0.4
float auto_exposure_speed 0.5
int background_camera_feed_id 1
int background_canvas_max_layer 0
Color background_color Color( 0, 0, 0, 1 )
float background_energy 1.0
BGMode background_mode 0
Sky background_sky  
float background_sky_custom_fov 0.0
Basis background_sky_orientation Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )
Vector3 background_sky_rotation Vector3( 0, 0, 0 )
Vector3 background_sky_rotation_degrees Vector3( 0, 0, 0 )
float dof_blur_far_amount 0.1
float dof_blur_far_distance 10.0
bool dof_blur_far_enabled false
DOFBlurQuality dof_blur_far_quality 1
float dof_blur_far_transition 5.0
float dof_blur_near_amount 0.1
float dof_blur_near_distance 2.0
bool dof_blur_near_enabled false
DOFBlurQuality dof_blur_near_quality 1
float dof_blur_near_transition 1.0
Color fog_color Color( 0.5, 0.6, 0.7, 1 )
float fog_depth_begin 10.0
float fog_depth_curve 1.0
bool fog_depth_enabled true
float fog_depth_end 100.0
bool fog_enabled false
float fog_height_curve 1.0
bool fog_height_enabled false
float fog_height_max 0.0
float fog_height_min 10.0
float fog_sun_amount 0.0
Color fog_sun_color Color( 1, 0.9, 0.7, 1 )
float fog_transmit_curve 1.0
bool fog_transmit_enabled false
bool glow_bicubic_upscale false
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
bool glow_levels/1 false
bool glow_levels/2 false
bool glow_levels/3 true
bool glow_levels/4 false
bool glow_levels/5 true
bool glow_levels/6 false
bool glow_levels/7 false
float glow_strength 1.0
float ss_reflections_depth_tolerance 0.2
bool ss_reflections_enabled false
float ss_reflections_fade_in 0.15
float ss_reflections_fade_out 2.0
int ss_reflections_max_steps 64
bool ss_reflections_roughness true
float ssao_ao_channel_affect 0.0
float ssao_bias 0.01
SSAOBlur ssao_blur 3
Color ssao_color Color( 0, 0, 0, 1 )
float ssao_edge_sharpness 4.0
bool ssao_enabled false
float ssao_intensity 1.0
float ssao_intensity2 1.0
float ssao_light_affect 0.0
SSAOQuality ssao_quality 1
float ssao_radius 1.0
float ssao_radius2 0.0
float tonemap_exposure 1.0
ToneMapper tonemap_mode 0
float tonemap_white 1.0

Methods

bool is_glow_level_enabled ( int idx ) const
void set_glow_level ( int idx, bool enabled )

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_CAMERA_FEED = 6 — Display a camera feed in the background.
  • BG_MAX = 7 — Represents the size of the BGMode enum.

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.

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 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 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:

  • Depth of Field Blur
  • Glow
  • Tonemap (Auto Exposure)
  • Adjustments

Property Descriptions

  • float adjustment_brightness
Default 1.0
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
Default 1.0
Setter set_adjustment_contrast(value)
Getter get_adjustment_contrast()

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


  • bool adjustment_enabled
Default false
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
Default 1.0
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
Default Color( 0, 0, 0, 1 )
Setter set_ambient_light_color(value)
Getter get_ambient_light_color()

Color of the ambient light.


  • float ambient_light_energy
Default 1.0
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
Default 1.0
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
Default false
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
Default 8.0
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
Default 0.05
Setter set_tonemap_auto_exposure_min(value)
Getter get_tonemap_auto_exposure_min()

Minimum luminance value for the auto exposure.


  • float auto_exposure_scale
Default 0.4
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
Default 0.5
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_camera_feed_id
Default 1
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 0
Setter set_canvas_max_layer(value)
Getter get_canvas_max_layer()

Maximum layer id (if using Layer background mode).


Default Color( 0, 0, 0, 1 )
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
Default 1.0
Setter set_bg_energy(value)
Getter get_bg_energy()

Power of light emitted by the background.


Default 0
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
Default 0.0
Setter set_sky_custom_fov(value)
Getter get_sky_custom_fov()

Sky resource’s custom field of view.


  • Basis background_sky_orientation
Default Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )
Setter set_sky_orientation(value)
Getter get_sky_orientation()

Sky resource’s rotation expressed as a Basis


Default Vector3( 0, 0, 0 )
Setter set_sky_rotation(value)
Getter get_sky_rotation()

Sky resource’s rotation expressed as euler angles in radians


  • Vector3 background_sky_rotation_degrees
Default Vector3( 0, 0, 0 )
Setter set_sky_rotation_degrees(value)
Getter get_sky_rotation_degrees()

Sky resource’s rotation expressed as euler angles in degrees


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

Amount of far blur.


  • float dof_blur_far_distance
Default 10.0
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
Default false
Setter set_dof_blur_far_enabled(value)
Getter is_dof_blur_far_enabled()

Enables the far blur effect.


Default 1
Setter set_dof_blur_far_quality(value)
Getter get_dof_blur_far_quality()

Quality of the far blur quality.


  • float dof_blur_far_transition
Default 5.0
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
Default 0.1
Setter set_dof_blur_near_amount(value)
Getter get_dof_blur_near_amount()

Amount of near blur.


  • float dof_blur_near_distance
Default 2.0
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
Default false
Setter set_dof_blur_near_enabled(value)
Getter is_dof_blur_near_enabled()

Enables the near blur effect.


Default 1
Setter set_dof_blur_near_quality(value)
Getter get_dof_blur_near_quality()

Quality of the near blur quality.


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

Transition between near blur and no-blur area.


Default Color( 0.5, 0.6, 0.7, 1 )
Setter set_fog_color(value)
Getter get_fog_color()

Fog’s Color.


Default 10.0
Setter set_fog_depth_begin(value)
Getter get_fog_depth_begin()

Fog’s depth starting distance from the camera.


Default 1.0
Setter set_fog_depth_curve(value)
Getter get_fog_depth_curve()

Value defining the fog depth intensity.


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

Enables the fog depth.


Default 100.0
Setter set_fog_depth_end(value)
Getter get_fog_depth_end()

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.


Default false
Setter set_fog_enabled(value)
Getter is_fog_enabled()

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


Default 1.0
Setter set_fog_height_curve(value)
Getter get_fog_height_curve()

Value defining the fog height intensity.


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

Enables the fog height.


Default 0.0
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.


Default 10.0
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.


Default 0.0
Setter set_fog_sun_amount(value)
Getter get_fog_sun_amount()

Amount of sun that affects the fog rendering.


Default Color( 1, 0.9, 0.7, 1 )
Setter set_fog_sun_color(value)
Getter get_fog_sun_color()

Sun Color.


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

Amount of light that the fog transmits.


  • bool fog_transmit_enabled
Default false
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
Default false
Setter set_glow_bicubic_upscale(value)
Getter is_glow_bicubic_upscale_enabled()

Smooths out blockiness created by sampling higher levels.


Default 2
Setter set_glow_blend_mode(value)
Getter get_glow_blend_mode()

Glow blending mode.


Default 0.0
Setter set_glow_bloom(value)
Getter get_glow_bloom()

Bloom value (global glow).


Default false
Setter set_glow_enabled(value)
Getter is_glow_enabled()

Enables glow rendering.


  • float glow_hdr_luminance_cap
Default 12.0
Setter set_glow_hdr_luminance_cap(value)
Getter get_glow_hdr_luminance_cap()

Default 2.0
Setter set_glow_hdr_bleed_scale(value)
Getter get_glow_hdr_bleed_scale()

Bleed scale of the HDR glow.


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

Bleed threshold of the HDR glow. In GLES2, this needs to be below 1.0 in order for glow to be visible, a default value of 0.9 works well.


Default 0.8
Setter set_glow_intensity(value)
Getter get_glow_intensity()

Glow intensity. In GLES2, this should be increased to 1.5 by default to compensate for not using HDR.


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

First level of glow (most local).


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

Second level of glow.


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

Third level of glow.


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

Fourth level of glow.


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

Fifth level of glow.


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

Sixth level of glow.


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

Seventh level of glow (most global).


Default 1.0
Setter set_glow_strength(value)
Getter get_glow_strength()

Glow strength. In GLES2, this should be increased to 1.3 by default to compensate for not using HDR.


  • float ss_reflections_depth_tolerance
Default 0.2
Setter set_ssr_depth_tolerance(value)
Getter get_ssr_depth_tolerance()

  • bool ss_reflections_enabled
Default false
Setter set_ssr_enabled(value)
Getter is_ssr_enabled()

  • float ss_reflections_fade_in
Default 0.15
Setter set_ssr_fade_in(value)
Getter get_ssr_fade_in()

  • float ss_reflections_fade_out
Default 2.0
Setter set_ssr_fade_out(value)
Getter get_ssr_fade_out()

  • int ss_reflections_max_steps
Default 64
Setter set_ssr_max_steps(value)
Getter get_ssr_max_steps()

  • bool ss_reflections_roughness
Default true
Setter set_ssr_rough(value)
Getter is_ssr_rough()

  • float ssao_ao_channel_affect
Default 0.0
Setter set_ssao_ao_channel_affect(value)
Getter get_ssao_ao_channel_affect()

Default 0.01
Setter set_ssao_bias(value)
Getter get_ssao_bias()

Default 3
Setter set_ssao_blur(value)
Getter get_ssao_blur()

Default Color( 0, 0, 0, 1 )
Setter set_ssao_color(value)
Getter get_ssao_color()

  • float ssao_edge_sharpness
Default 4.0
Setter set_ssao_edge_sharpness(value)
Getter get_ssao_edge_sharpness()

Default false
Setter set_ssao_enabled(value)
Getter is_ssao_enabled()

Default 1.0
Setter set_ssao_intensity(value)
Getter get_ssao_intensity()

Default 1.0
Setter set_ssao_intensity2(value)
Getter get_ssao_intensity2()

  • float ssao_light_affect
Default 0.0
Setter set_ssao_direct_light_affect(value)
Getter get_ssao_direct_light_affect()

Default 1
Setter set_ssao_quality(value)
Getter get_ssao_quality()

Default 1.0
Setter set_ssao_radius(value)
Getter get_ssao_radius()

Default 0.0
Setter set_ssao_radius2(value)
Getter get_ssao_radius2()

Default 1.0
Setter set_tonemap_exposure(value)
Getter get_tonemap_exposure()

Default exposure for tonemap.


Default 0
Setter set_tonemapper(value)
Getter get_tonemapper()

Tonemapping mode.


Default 1.0
Setter set_tonemap_white(value)
Getter get_tonemap_white()

White reference value for tonemap.

Method Descriptions

  • bool is_glow_level_enabled ( int idx ) const

  • void set_glow_level ( int idx, bool enabled )