godot-docs/classes/class_environment.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Environment.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Environment:

Environment
===========

**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Resource for environment nodes (like :ref:`WorldEnvironment<class_worldenvironment>`) that define multiple rendering options.

Member Functions
----------------

+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_adjustment_brightness<class_Environment_get_adjustment_brightness>`  **(** **)** const                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_adjustment_color_correction<class_Environment_get_adjustment_color_correction>`  **(** **)** const                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_adjustment_contrast<class_Environment_get_adjustment_contrast>`  **(** **)** const                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_adjustment_saturation<class_Environment_get_adjustment_saturation>`  **(** **)** const                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`      | :ref:`get_ambient_light_color<class_Environment_get_ambient_light_color>`  **(** **)** const                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ambient_light_energy<class_Environment_get_ambient_light_energy>`  **(** **)** const                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ambient_light_sky_contribution<class_Environment_get_ambient_light_sky_contribution>`  **(** **)** const                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_background<class_Environment_get_background>`  **(** **)** const                                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`      | :ref:`get_bg_color<class_Environment_get_bg_color>`  **(** **)** const                                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_bg_energy<class_Environment_get_bg_energy>`  **(** **)** const                                                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_canvas_max_layer<class_Environment_get_canvas_max_layer>`  **(** **)** const                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_dof_blur_far_amount<class_Environment_get_dof_blur_far_amount>`  **(** **)** const                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_dof_blur_far_distance<class_Environment_get_dof_blur_far_distance>`  **(** **)** const                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_dof_blur_far_quality<class_Environment_get_dof_blur_far_quality>`  **(** **)** const                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_dof_blur_far_transition<class_Environment_get_dof_blur_far_transition>`  **(** **)** const                                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_dof_blur_near_amount<class_Environment_get_dof_blur_near_amount>`  **(** **)** const                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_dof_blur_near_distance<class_Environment_get_dof_blur_near_distance>`  **(** **)** const                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_dof_blur_near_quality<class_Environment_get_dof_blur_near_quality>`  **(** **)** const                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_dof_blur_near_transition<class_Environment_get_dof_blur_near_transition>`  **(** **)** const                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`      | :ref:`get_fog_color<class_Environment_get_fog_color>`  **(** **)** const                                                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_depth_begin<class_Environment_get_fog_depth_begin>`  **(** **)** const                                                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_depth_curve<class_Environment_get_fog_depth_curve>`  **(** **)** const                                                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_height_curve<class_Environment_get_fog_height_curve>`  **(** **)** const                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_height_max<class_Environment_get_fog_height_max>`  **(** **)** const                                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_height_min<class_Environment_get_fog_height_min>`  **(** **)** const                                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_sun_amount<class_Environment_get_fog_sun_amount>`  **(** **)** const                                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`      | :ref:`get_fog_sun_color<class_Environment_get_fog_sun_color>`  **(** **)** const                                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_fog_transmit_curve<class_Environment_get_fog_transmit_curve>`  **(** **)** const                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_glow_blend_mode<class_Environment_get_glow_blend_mode>`  **(** **)** const                                                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_glow_bloom<class_Environment_get_glow_bloom>`  **(** **)** const                                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_glow_hdr_bleed_scale<class_Environment_get_glow_hdr_bleed_scale>`  **(** **)** const                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_glow_hdr_bleed_threshold<class_Environment_get_glow_hdr_bleed_threshold>`  **(** **)** const                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_glow_intensity<class_Environment_get_glow_intensity>`  **(** **)** const                                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_glow_strength<class_Environment_get_glow_strength>`  **(** **)** const                                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Sky<class_sky>`          | :ref:`get_sky<class_Environment_get_sky>`  **(** **)** const                                                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_sky_custom_fov<class_Environment_get_sky_custom_fov>`  **(** **)** const                                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssao_bias<class_Environment_get_ssao_bias>`  **(** **)** const                                                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>`      | :ref:`get_ssao_color<class_Environment_get_ssao_color>`  **(** **)** const                                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssao_direct_light_affect<class_Environment_get_ssao_direct_light_affect>`  **(** **)** const                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssao_intensity<class_Environment_get_ssao_intensity>`  **(** **)** const                                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssao_intensity2<class_Environment_get_ssao_intensity2>`  **(** **)** const                                                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssao_radius<class_Environment_get_ssao_radius>`  **(** **)** const                                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssao_radius2<class_Environment_get_ssao_radius2>`  **(** **)** const                                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssr_depth_tolerance<class_Environment_get_ssr_depth_tolerance>`  **(** **)** const                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssr_fade_in<class_Environment_get_ssr_fade_in>`  **(** **)** const                                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_ssr_fade_out<class_Environment_get_ssr_fade_out>`  **(** **)** const                                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_ssr_max_steps<class_Environment_get_ssr_max_steps>`  **(** **)** const                                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`get_tonemap_auto_exposure<class_Environment_get_tonemap_auto_exposure>`  **(** **)** const                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_tonemap_auto_exposure_grey<class_Environment_get_tonemap_auto_exposure_grey>`  **(** **)** const                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_tonemap_auto_exposure_max<class_Environment_get_tonemap_auto_exposure_max>`  **(** **)** const                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_tonemap_auto_exposure_min<class_Environment_get_tonemap_auto_exposure_min>`  **(** **)** const                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_tonemap_auto_exposure_speed<class_Environment_get_tonemap_auto_exposure_speed>`  **(** **)** const                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_tonemap_exposure<class_Environment_get_tonemap_exposure>`  **(** **)** const                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`      | :ref:`get_tonemap_white<class_Environment_get_tonemap_white>`  **(** **)** const                                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_tonemapper<class_Environment_get_tonemapper>`  **(** **)** const                                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_adjustment_enabled<class_Environment_is_adjustment_enabled>`  **(** **)** const                                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_dof_blur_far_enabled<class_Environment_is_dof_blur_far_enabled>`  **(** **)** const                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_dof_blur_near_enabled<class_Environment_is_dof_blur_near_enabled>`  **(** **)** const                                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_fog_depth_enabled<class_Environment_is_fog_depth_enabled>`  **(** **)** const                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_fog_enabled<class_Environment_is_fog_enabled>`  **(** **)** const                                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_fog_height_enabled<class_Environment_is_fog_height_enabled>`  **(** **)** const                                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_fog_transmit_enabled<class_Environment_is_fog_transmit_enabled>`  **(** **)** const                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_glow_bicubic_upscale_enabled<class_Environment_is_glow_bicubic_upscale_enabled>`  **(** **)** const                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_glow_enabled<class_Environment_is_glow_enabled>`  **(** **)** const                                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_glow_level_enabled<class_Environment_is_glow_level_enabled>`  **(** :ref:`int<class_int>` idx  **)** const                                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_ssao_blur_enabled<class_Environment_is_ssao_blur_enabled>`  **(** **)** const                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_ssao_enabled<class_Environment_is_ssao_enabled>`  **(** **)** const                                                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_ssr_enabled<class_Environment_is_ssr_enabled>`  **(** **)** const                                                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`is_ssr_rough<class_Environment_is_ssr_rough>`  **(** **)** const                                                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_adjustment_brightness<class_Environment_set_adjustment_brightness>`  **(** :ref:`float<class_float>` brightness  **)**                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_adjustment_color_correction<class_Environment_set_adjustment_color_correction>`  **(** :ref:`Texture<class_texture>` color_correction  **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_adjustment_contrast<class_Environment_set_adjustment_contrast>`  **(** :ref:`float<class_float>` contrast  **)**                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_adjustment_enable<class_Environment_set_adjustment_enable>`  **(** :ref:`bool<class_bool>` enabled  **)**                                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_adjustment_saturation<class_Environment_set_adjustment_saturation>`  **(** :ref:`float<class_float>` saturation  **)**                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ambient_light_color<class_Environment_set_ambient_light_color>`  **(** :ref:`Color<class_color>` color  **)**                                |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ambient_light_energy<class_Environment_set_ambient_light_energy>`  **(** :ref:`float<class_float>` energy  **)**                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ambient_light_sky_contribution<class_Environment_set_ambient_light_sky_contribution>`  **(** :ref:`float<class_float>` energy  **)**         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_background<class_Environment_set_background>`  **(** :ref:`int<class_int>` mode  **)**                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_bg_color<class_Environment_set_bg_color>`  **(** :ref:`Color<class_color>` color  **)**                                                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_bg_energy<class_Environment_set_bg_energy>`  **(** :ref:`float<class_float>` energy  **)**                                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_canvas_max_layer<class_Environment_set_canvas_max_layer>`  **(** :ref:`int<class_int>` layer  **)**                                          |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_far_amount<class_Environment_set_dof_blur_far_amount>`  **(** :ref:`float<class_float>` intensity  **)**                            |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_far_distance<class_Environment_set_dof_blur_far_distance>`  **(** :ref:`float<class_float>` intensity  **)**                        |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_far_enabled<class_Environment_set_dof_blur_far_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_far_quality<class_Environment_set_dof_blur_far_quality>`  **(** :ref:`int<class_int>` intensity  **)**                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_far_transition<class_Environment_set_dof_blur_far_transition>`  **(** :ref:`float<class_float>` intensity  **)**                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_near_amount<class_Environment_set_dof_blur_near_amount>`  **(** :ref:`float<class_float>` intensity  **)**                          |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_near_distance<class_Environment_set_dof_blur_near_distance>`  **(** :ref:`float<class_float>` intensity  **)**                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_near_enabled<class_Environment_set_dof_blur_near_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                            |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_near_quality<class_Environment_set_dof_blur_near_quality>`  **(** :ref:`int<class_int>` level  **)**                                |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_dof_blur_near_transition<class_Environment_set_dof_blur_near_transition>`  **(** :ref:`float<class_float>` intensity  **)**                  |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_color<class_Environment_set_fog_color>`  **(** :ref:`Color<class_color>` color  **)**                                                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_depth_begin<class_Environment_set_fog_depth_begin>`  **(** :ref:`float<class_float>` distance  **)**                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_depth_curve<class_Environment_set_fog_depth_curve>`  **(** :ref:`float<class_float>` curve  **)**                                        |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_depth_enabled<class_Environment_set_fog_depth_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_enabled<class_Environment_set_fog_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                                |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_height_curve<class_Environment_set_fog_height_curve>`  **(** :ref:`float<class_float>` curve  **)**                                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_height_enabled<class_Environment_set_fog_height_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                  |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_height_max<class_Environment_set_fog_height_max>`  **(** :ref:`float<class_float>` height  **)**                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_height_min<class_Environment_set_fog_height_min>`  **(** :ref:`float<class_float>` height  **)**                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_sun_amount<class_Environment_set_fog_sun_amount>`  **(** :ref:`float<class_float>` amount  **)**                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_sun_color<class_Environment_set_fog_sun_color>`  **(** :ref:`Color<class_color>` color  **)**                                            |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_transmit_curve<class_Environment_set_fog_transmit_curve>`  **(** :ref:`float<class_float>` curve  **)**                                  |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_fog_transmit_enabled<class_Environment_set_fog_transmit_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_bicubic_upscale<class_Environment_set_glow_bicubic_upscale>`  **(** :ref:`bool<class_bool>` enabled  **)**                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_blend_mode<class_Environment_set_glow_blend_mode>`  **(** :ref:`int<class_int>` mode  **)**                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_bloom<class_Environment_set_glow_bloom>`  **(** :ref:`float<class_float>` amount  **)**                                                 |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_enabled<class_Environment_set_glow_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_hdr_bleed_scale<class_Environment_set_glow_hdr_bleed_scale>`  **(** :ref:`float<class_float>` scale  **)**                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_hdr_bleed_threshold<class_Environment_set_glow_hdr_bleed_threshold>`  **(** :ref:`float<class_float>` threshold  **)**                  |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_intensity<class_Environment_set_glow_intensity>`  **(** :ref:`float<class_float>` intensity  **)**                                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_level<class_Environment_set_glow_level>`  **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled  **)**                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_glow_strength<class_Environment_set_glow_strength>`  **(** :ref:`float<class_float>` strength  **)**                                         |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_sky<class_Environment_set_sky>`  **(** :ref:`Sky<class_sky>` sky  **)**                                                                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_sky_custom_fov<class_Environment_set_sky_custom_fov>`  **(** :ref:`float<class_float>` scale  **)**                                          |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_bias<class_Environment_set_ssao_bias>`  **(** :ref:`float<class_float>` bias  **)**                                                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_blur<class_Environment_set_ssao_blur>`  **(** :ref:`bool<class_bool>` enabled  **)**                                                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_color<class_Environment_set_ssao_color>`  **(** :ref:`Color<class_color>` color  **)**                                                  |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_direct_light_affect<class_Environment_set_ssao_direct_light_affect>`  **(** :ref:`float<class_float>` amount  **)**                     |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_enabled<class_Environment_set_ssao_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_intensity<class_Environment_set_ssao_intensity>`  **(** :ref:`float<class_float>` intensity  **)**                                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_intensity2<class_Environment_set_ssao_intensity2>`  **(** :ref:`float<class_float>` intensity  **)**                                    |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_radius<class_Environment_set_ssao_radius>`  **(** :ref:`float<class_float>` radius  **)**                                               |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssao_radius2<class_Environment_set_ssao_radius2>`  **(** :ref:`float<class_float>` radius  **)**                                             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssr_depth_tolerance<class_Environment_set_ssr_depth_tolerance>`  **(** :ref:`float<class_float>` depth_tolerance  **)**                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssr_enabled<class_Environment_set_ssr_enabled>`  **(** :ref:`bool<class_bool>` enabled  **)**                                                |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssr_fade_in<class_Environment_set_ssr_fade_in>`  **(** :ref:`float<class_float>` fade_in  **)**                                              |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssr_fade_out<class_Environment_set_ssr_fade_out>`  **(** :ref:`float<class_float>` fade_out  **)**                                           |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssr_max_steps<class_Environment_set_ssr_max_steps>`  **(** :ref:`int<class_int>` max_steps  **)**                                            |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_ssr_rough<class_Environment_set_ssr_rough>`  **(** :ref:`bool<class_bool>` rough  **)**                                                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_auto_exposure<class_Environment_set_tonemap_auto_exposure>`  **(** :ref:`bool<class_bool>` auto_exposure  **)**                      |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_auto_exposure_grey<class_Environment_set_tonemap_auto_exposure_grey>`  **(** :ref:`float<class_float>` exposure_grey  **)**          |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_auto_exposure_max<class_Environment_set_tonemap_auto_exposure_max>`  **(** :ref:`float<class_float>` exposure_max  **)**             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_auto_exposure_min<class_Environment_set_tonemap_auto_exposure_min>`  **(** :ref:`float<class_float>` exposure_min  **)**             |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_auto_exposure_speed<class_Environment_set_tonemap_auto_exposure_speed>`  **(** :ref:`float<class_float>` exposure_speed  **)**       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_exposure<class_Environment_set_tonemap_exposure>`  **(** :ref:`float<class_float>` exposure  **)**                                   |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemap_white<class_Environment_set_tonemap_white>`  **(** :ref:`float<class_float>` white  **)**                                            |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tonemapper<class_Environment_set_tonemapper>`  **(** :ref:`int<class_int>` mode  **)**                                                       |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

  .. _class_Environment_adjustment_brightness:

- :ref:`float<class_float>` **adjustment_brightness** - Global brightness value of the rendered scene (default value is 1).

  .. _class_Environment_adjustment_color_correction:

- :ref:`Texture<class_texture>` **adjustment_color_correction** - Applies the provided :ref:`Texture<class_texture>` resource to affect the global color aspect of the rendered scene.

  .. _class_Environment_adjustment_contrast:

- :ref:`float<class_float>` **adjustment_contrast** - Global contrast value of the rendered scene (default value is 1).

  .. _class_Environment_adjustment_enabled:

- :ref:`bool<class_bool>` **adjustment_enabled** - Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene.

  .. _class_Environment_adjustment_saturation:

- :ref:`float<class_float>` **adjustment_saturation** - Global color saturation value of the rendered scene (default value is 1).

  .. _class_Environment_ambient_light_color:

- :ref:`Color<class_color>` **ambient_light_color** - :ref:`Color<class_color>` of the ambient light.

  .. _class_Environment_ambient_light_energy:

- :ref:`float<class_float>` **ambient_light_energy** - Energy of the ambient light. The higher the value, the stronger the light.

  .. _class_Environment_ambient_light_sky_contribution:

- :ref:`float<class_float>` **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.

  .. _class_Environment_auto_exposure_enabled:

- :ref:`bool<class_bool>` **auto_exposure_enabled** - 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.

  .. _class_Environment_auto_exposure_max_luma:

- :ref:`float<class_float>` **auto_exposure_max_luma** - Maximum luminance value for the auto exposure.

  .. _class_Environment_auto_exposure_min_luma:

- :ref:`float<class_float>` **auto_exposure_min_luma** - Minimum luminance value for the auto exposure.

  .. _class_Environment_auto_exposure_scale:

- :ref:`float<class_float>` **auto_exposure_scale** - Scale of the auto exposure effect. Affects the intensity of auto exposure.

  .. _class_Environment_auto_exposure_speed:

- :ref:`float<class_float>` **auto_exposure_speed** - Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.

  .. _class_Environment_background_canvas_max_layer:

- :ref:`int<class_int>` **background_canvas_max_layer** - Maximum layer id (if using Layer background mode).

  .. _class_Environment_background_color:

- :ref:`Color<class_color>` **background_color** - Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).

  .. _class_Environment_background_energy:

- :ref:`float<class_float>` **background_energy** - Power of light emitted by the background.

  .. _class_Environment_background_mode:

- :ref:`int<class_int>` **background_mode** - Defines the mode of background.

  .. _class_Environment_background_sky:

- :ref:`Sky<class_sky>` **background_sky** - :ref:`Sky<class_sky>` resource defined as background.

  .. _class_Environment_background_sky_custom_fov:

- :ref:`float<class_float>` **background_sky_custom_fov** - :ref:`Sky<class_sky>` resource's custom field of view.

  .. _class_Environment_dof_blur_far_amount:

- :ref:`float<class_float>` **dof_blur_far_amount** - Amount of far blur.

  .. _class_Environment_dof_blur_far_distance:

- :ref:`float<class_float>` **dof_blur_far_distance** - Distance from the camera where the far blur effect affects the rendering.

  .. _class_Environment_dof_blur_far_enabled:

- :ref:`bool<class_bool>` **dof_blur_far_enabled** - Enables the far blur effect.

  .. _class_Environment_dof_blur_far_quality:

- :ref:`int<class_int>` **dof_blur_far_quality** - Quality of the far blur quality.

  .. _class_Environment_dof_blur_far_transition:

- :ref:`float<class_float>` **dof_blur_far_transition** - Transition between no-blur area and far blur.

  .. _class_Environment_dof_blur_near_amount:

- :ref:`float<class_float>` **dof_blur_near_amount** - Amount of near blur.

  .. _class_Environment_dof_blur_near_distance:

- :ref:`float<class_float>` **dof_blur_near_distance** - Distance from the camera where the near blur effect affects the rendering.

  .. _class_Environment_dof_blur_near_enabled:

- :ref:`bool<class_bool>` **dof_blur_near_enabled** - Enables the near blur effect.

  .. _class_Environment_dof_blur_near_quality:

- :ref:`int<class_int>` **dof_blur_near_quality** - Quality of the near blur quality.

  .. _class_Environment_dof_blur_near_transition:

- :ref:`float<class_float>` **dof_blur_near_transition** - Transition between near blur and no-blur area.

  .. _class_Environment_fog_color:

- :ref:`Color<class_color>` **fog_color** - Fog's :ref:`Color<class_color>`.

  .. _class_Environment_fog_depth_begin:

- :ref:`float<class_float>` **fog_depth_begin** - Fog's depth starting distance from the camera.

  .. _class_Environment_fog_depth_curve:

- :ref:`float<class_float>` **fog_depth_curve** - Value defining the fog depth intensity.

  .. _class_Environment_fog_depth_enabled:

- :ref:`bool<class_bool>` **fog_depth_enabled** - Enables the fog depth.

  .. _class_Environment_fog_enabled:

- :ref:`bool<class_bool>` **fog_enabled** - Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.

  .. _class_Environment_fog_height_curve:

- :ref:`float<class_float>` **fog_height_curve** - Value defining the fog height intensity.

  .. _class_Environment_fog_height_enabled:

- :ref:`bool<class_bool>` **fog_height_enabled** - Enables the fog height.

  .. _class_Environment_fog_height_max:

- :ref:`float<class_float>` **fog_height_max** - Maximum height of fog.

  .. _class_Environment_fog_height_min:

- :ref:`float<class_float>` **fog_height_min** - Minimum height of fog.

  .. _class_Environment_fog_sun_amount:

- :ref:`float<class_float>` **fog_sun_amount** - Amount of sun that affects the fog rendering.

  .. _class_Environment_fog_sun_color:

- :ref:`Color<class_color>` **fog_sun_color** - Sun :ref:`Color<class_color>`.

  .. _class_Environment_fog_transmit_curve:

- :ref:`float<class_float>` **fog_transmit_curve** - Amount of light that the fog transmits.

  .. _class_Environment_fog_transmit_enabled:

- :ref:`bool<class_bool>` **fog_transmit_enabled** - Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.

  .. _class_Environment_glow_bicubic_upscale:

- :ref:`bool<class_bool>` **glow_bicubic_upscale**

  .. _class_Environment_glow_blend_mode:

- :ref:`int<class_int>` **glow_blend_mode** - Glow blending mode.

  .. _class_Environment_glow_bloom:

- :ref:`float<class_float>` **glow_bloom** - Bloom value (global glow).

  .. _class_Environment_glow_enabled:

- :ref:`bool<class_bool>` **glow_enabled** - Enables glow rendering.

  .. _class_Environment_glow_hdr_scale:

- :ref:`float<class_float>` **glow_hdr_scale** - Bleed scale of the HDR glow.

  .. _class_Environment_glow_hdr_threshold:

- :ref:`float<class_float>` **glow_hdr_threshold** - Bleed threshold of the HDR glow.

  .. _class_Environment_glow_intensity:

- :ref:`float<class_float>` **glow_intensity** - Glow intensity.

  .. _class_Environment_glow_levels/1:

- :ref:`bool<class_bool>` **glow_levels/1** - First level of glow (most local).

  .. _class_Environment_glow_levels/2:

- :ref:`bool<class_bool>` **glow_levels/2** - Second level of glow.

  .. _class_Environment_glow_levels/3:

- :ref:`bool<class_bool>` **glow_levels/3** - Third level of glow.

  .. _class_Environment_glow_levels/4:

- :ref:`bool<class_bool>` **glow_levels/4** - Fourth level of glow.

  .. _class_Environment_glow_levels/5:

- :ref:`bool<class_bool>` **glow_levels/5** - Fifth level of glow.

  .. _class_Environment_glow_levels/6:

- :ref:`bool<class_bool>` **glow_levels/6** - Sixth level of glow.

  .. _class_Environment_glow_levels/7:

- :ref:`bool<class_bool>` **glow_levels/7** - Seventh level of glow (most global).

  .. _class_Environment_glow_strength:

- :ref:`float<class_float>` **glow_strength** - Glow strength.

  .. _class_Environment_ss_reflections_depth_tolerance:

- :ref:`float<class_float>` **ss_reflections_depth_tolerance**

  .. _class_Environment_ss_reflections_enabled:

- :ref:`bool<class_bool>` **ss_reflections_enabled**

  .. _class_Environment_ss_reflections_fade_in:

- :ref:`float<class_float>` **ss_reflections_fade_in**

  .. _class_Environment_ss_reflections_fade_out:

- :ref:`float<class_float>` **ss_reflections_fade_out**

  .. _class_Environment_ss_reflections_max_steps:

- :ref:`int<class_int>` **ss_reflections_max_steps**

  .. _class_Environment_ss_reflections_roughness:

- :ref:`bool<class_bool>` **ss_reflections_roughness**

  .. _class_Environment_ssao_bias:

- :ref:`float<class_float>` **ssao_bias**

  .. _class_Environment_ssao_blur:

- :ref:`bool<class_bool>` **ssao_blur**

  .. _class_Environment_ssao_color:

- :ref:`Color<class_color>` **ssao_color**

  .. _class_Environment_ssao_enabled:

- :ref:`bool<class_bool>` **ssao_enabled**

  .. _class_Environment_ssao_intensity:

- :ref:`float<class_float>` **ssao_intensity**

  .. _class_Environment_ssao_intensity2:

- :ref:`float<class_float>` **ssao_intensity2**

  .. _class_Environment_ssao_light_affect:

- :ref:`float<class_float>` **ssao_light_affect**

  .. _class_Environment_ssao_radius:

- :ref:`float<class_float>` **ssao_radius**

  .. _class_Environment_ssao_radius2:

- :ref:`float<class_float>` **ssao_radius2**

  .. _class_Environment_tonemap_exposure:

- :ref:`float<class_float>` **tonemap_exposure** - Default exposure for tonemap.

  .. _class_Environment_tonemap_mode:

- :ref:`int<class_int>` **tonemap_mode** - Tonemapping mode.

  .. _class_Environment_tonemap_white:

- :ref:`float<class_float>` **tonemap_white** - White reference value for tonemap.


Numeric Constants
-----------------

- **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 :ref:`CanvasLayer<class_canvaslayer>` in the background.
- **BG_MAX** = **6** --- Helper constant keeping track of the enum's size, has no direct usage in API calls.
- **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.
- **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.
- **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.

Description
-----------

Resource for environment nodes (like :ref:`WorldEnvironment<class_worldenvironment>`) that define multiple environment operations (such as background :ref:`Sky<class_sky>` or :ref:`Color<class_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

Member Function Description
---------------------------

.. _class_Environment_get_adjustment_brightness:

- :ref:`float<class_float>`  **get_adjustment_brightness**  **(** **)** const

.. _class_Environment_get_adjustment_color_correction:

- :ref:`Texture<class_texture>`  **get_adjustment_color_correction**  **(** **)** const

.. _class_Environment_get_adjustment_contrast:

- :ref:`float<class_float>`  **get_adjustment_contrast**  **(** **)** const

.. _class_Environment_get_adjustment_saturation:

- :ref:`float<class_float>`  **get_adjustment_saturation**  **(** **)** const

.. _class_Environment_get_ambient_light_color:

- :ref:`Color<class_color>`  **get_ambient_light_color**  **(** **)** const

.. _class_Environment_get_ambient_light_energy:

- :ref:`float<class_float>`  **get_ambient_light_energy**  **(** **)** const

.. _class_Environment_get_ambient_light_sky_contribution:

- :ref:`float<class_float>`  **get_ambient_light_sky_contribution**  **(** **)** const

.. _class_Environment_get_background:

- :ref:`int<class_int>`  **get_background**  **(** **)** const

.. _class_Environment_get_bg_color:

- :ref:`Color<class_color>`  **get_bg_color**  **(** **)** const

.. _class_Environment_get_bg_energy:

- :ref:`float<class_float>`  **get_bg_energy**  **(** **)** const

.. _class_Environment_get_canvas_max_layer:

- :ref:`int<class_int>`  **get_canvas_max_layer**  **(** **)** const

.. _class_Environment_get_dof_blur_far_amount:

- :ref:`float<class_float>`  **get_dof_blur_far_amount**  **(** **)** const

.. _class_Environment_get_dof_blur_far_distance:

- :ref:`float<class_float>`  **get_dof_blur_far_distance**  **(** **)** const

.. _class_Environment_get_dof_blur_far_quality:

- :ref:`int<class_int>`  **get_dof_blur_far_quality**  **(** **)** const

.. _class_Environment_get_dof_blur_far_transition:

- :ref:`float<class_float>`  **get_dof_blur_far_transition**  **(** **)** const

.. _class_Environment_get_dof_blur_near_amount:

- :ref:`float<class_float>`  **get_dof_blur_near_amount**  **(** **)** const

.. _class_Environment_get_dof_blur_near_distance:

- :ref:`float<class_float>`  **get_dof_blur_near_distance**  **(** **)** const

.. _class_Environment_get_dof_blur_near_quality:

- :ref:`int<class_int>`  **get_dof_blur_near_quality**  **(** **)** const

.. _class_Environment_get_dof_blur_near_transition:

- :ref:`float<class_float>`  **get_dof_blur_near_transition**  **(** **)** const

.. _class_Environment_get_fog_color:

- :ref:`Color<class_color>`  **get_fog_color**  **(** **)** const

.. _class_Environment_get_fog_depth_begin:

- :ref:`float<class_float>`  **get_fog_depth_begin**  **(** **)** const

.. _class_Environment_get_fog_depth_curve:

- :ref:`float<class_float>`  **get_fog_depth_curve**  **(** **)** const

.. _class_Environment_get_fog_height_curve:

- :ref:`float<class_float>`  **get_fog_height_curve**  **(** **)** const

.. _class_Environment_get_fog_height_max:

- :ref:`float<class_float>`  **get_fog_height_max**  **(** **)** const

.. _class_Environment_get_fog_height_min:

- :ref:`float<class_float>`  **get_fog_height_min**  **(** **)** const

.. _class_Environment_get_fog_sun_amount:

- :ref:`float<class_float>`  **get_fog_sun_amount**  **(** **)** const

.. _class_Environment_get_fog_sun_color:

- :ref:`Color<class_color>`  **get_fog_sun_color**  **(** **)** const

.. _class_Environment_get_fog_transmit_curve:

- :ref:`float<class_float>`  **get_fog_transmit_curve**  **(** **)** const

.. _class_Environment_get_glow_blend_mode:

- :ref:`int<class_int>`  **get_glow_blend_mode**  **(** **)** const

.. _class_Environment_get_glow_bloom:

- :ref:`float<class_float>`  **get_glow_bloom**  **(** **)** const

.. _class_Environment_get_glow_hdr_bleed_scale:

- :ref:`float<class_float>`  **get_glow_hdr_bleed_scale**  **(** **)** const

.. _class_Environment_get_glow_hdr_bleed_threshold:

- :ref:`float<class_float>`  **get_glow_hdr_bleed_threshold**  **(** **)** const

.. _class_Environment_get_glow_intensity:

- :ref:`float<class_float>`  **get_glow_intensity**  **(** **)** const

.. _class_Environment_get_glow_strength:

- :ref:`float<class_float>`  **get_glow_strength**  **(** **)** const

.. _class_Environment_get_sky:

- :ref:`Sky<class_sky>`  **get_sky**  **(** **)** const

.. _class_Environment_get_sky_custom_fov:

- :ref:`float<class_float>`  **get_sky_custom_fov**  **(** **)** const

.. _class_Environment_get_ssao_bias:

- :ref:`float<class_float>`  **get_ssao_bias**  **(** **)** const

.. _class_Environment_get_ssao_color:

- :ref:`Color<class_color>`  **get_ssao_color**  **(** **)** const

.. _class_Environment_get_ssao_direct_light_affect:

- :ref:`float<class_float>`  **get_ssao_direct_light_affect**  **(** **)** const

.. _class_Environment_get_ssao_intensity:

- :ref:`float<class_float>`  **get_ssao_intensity**  **(** **)** const

.. _class_Environment_get_ssao_intensity2:

- :ref:`float<class_float>`  **get_ssao_intensity2**  **(** **)** const

.. _class_Environment_get_ssao_radius:

- :ref:`float<class_float>`  **get_ssao_radius**  **(** **)** const

.. _class_Environment_get_ssao_radius2:

- :ref:`float<class_float>`  **get_ssao_radius2**  **(** **)** const

.. _class_Environment_get_ssr_depth_tolerance:

- :ref:`float<class_float>`  **get_ssr_depth_tolerance**  **(** **)** const

.. _class_Environment_get_ssr_fade_in:

- :ref:`float<class_float>`  **get_ssr_fade_in**  **(** **)** const

.. _class_Environment_get_ssr_fade_out:

- :ref:`float<class_float>`  **get_ssr_fade_out**  **(** **)** const

.. _class_Environment_get_ssr_max_steps:

- :ref:`int<class_int>`  **get_ssr_max_steps**  **(** **)** const

.. _class_Environment_get_tonemap_auto_exposure:

- :ref:`bool<class_bool>`  **get_tonemap_auto_exposure**  **(** **)** const

.. _class_Environment_get_tonemap_auto_exposure_grey:

- :ref:`float<class_float>`  **get_tonemap_auto_exposure_grey**  **(** **)** const

.. _class_Environment_get_tonemap_auto_exposure_max:

- :ref:`float<class_float>`  **get_tonemap_auto_exposure_max**  **(** **)** const

.. _class_Environment_get_tonemap_auto_exposure_min:

- :ref:`float<class_float>`  **get_tonemap_auto_exposure_min**  **(** **)** const

.. _class_Environment_get_tonemap_auto_exposure_speed:

- :ref:`float<class_float>`  **get_tonemap_auto_exposure_speed**  **(** **)** const

.. _class_Environment_get_tonemap_exposure:

- :ref:`float<class_float>`  **get_tonemap_exposure**  **(** **)** const

.. _class_Environment_get_tonemap_white:

- :ref:`float<class_float>`  **get_tonemap_white**  **(** **)** const

.. _class_Environment_get_tonemapper:

- :ref:`int<class_int>`  **get_tonemapper**  **(** **)** const

.. _class_Environment_is_adjustment_enabled:

- :ref:`bool<class_bool>`  **is_adjustment_enabled**  **(** **)** const

.. _class_Environment_is_dof_blur_far_enabled:

- :ref:`bool<class_bool>`  **is_dof_blur_far_enabled**  **(** **)** const

.. _class_Environment_is_dof_blur_near_enabled:

- :ref:`bool<class_bool>`  **is_dof_blur_near_enabled**  **(** **)** const

.. _class_Environment_is_fog_depth_enabled:

- :ref:`bool<class_bool>`  **is_fog_depth_enabled**  **(** **)** const

.. _class_Environment_is_fog_enabled:

- :ref:`bool<class_bool>`  **is_fog_enabled**  **(** **)** const

.. _class_Environment_is_fog_height_enabled:

- :ref:`bool<class_bool>`  **is_fog_height_enabled**  **(** **)** const

.. _class_Environment_is_fog_transmit_enabled:

- :ref:`bool<class_bool>`  **is_fog_transmit_enabled**  **(** **)** const

.. _class_Environment_is_glow_bicubic_upscale_enabled:

- :ref:`bool<class_bool>`  **is_glow_bicubic_upscale_enabled**  **(** **)** const

.. _class_Environment_is_glow_enabled:

- :ref:`bool<class_bool>`  **is_glow_enabled**  **(** **)** const

.. _class_Environment_is_glow_level_enabled:

- :ref:`bool<class_bool>`  **is_glow_level_enabled**  **(** :ref:`int<class_int>` idx  **)** const

.. _class_Environment_is_ssao_blur_enabled:

- :ref:`bool<class_bool>`  **is_ssao_blur_enabled**  **(** **)** const

.. _class_Environment_is_ssao_enabled:

- :ref:`bool<class_bool>`  **is_ssao_enabled**  **(** **)** const

.. _class_Environment_is_ssr_enabled:

- :ref:`bool<class_bool>`  **is_ssr_enabled**  **(** **)** const

.. _class_Environment_is_ssr_rough:

- :ref:`bool<class_bool>`  **is_ssr_rough**  **(** **)** const

.. _class_Environment_set_adjustment_brightness:

- void  **set_adjustment_brightness**  **(** :ref:`float<class_float>` brightness  **)**

.. _class_Environment_set_adjustment_color_correction:

- void  **set_adjustment_color_correction**  **(** :ref:`Texture<class_texture>` color_correction  **)**

.. _class_Environment_set_adjustment_contrast:

- void  **set_adjustment_contrast**  **(** :ref:`float<class_float>` contrast  **)**

.. _class_Environment_set_adjustment_enable:

- void  **set_adjustment_enable**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_adjustment_saturation:

- void  **set_adjustment_saturation**  **(** :ref:`float<class_float>` saturation  **)**

.. _class_Environment_set_ambient_light_color:

- void  **set_ambient_light_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_Environment_set_ambient_light_energy:

- void  **set_ambient_light_energy**  **(** :ref:`float<class_float>` energy  **)**

.. _class_Environment_set_ambient_light_sky_contribution:

- void  **set_ambient_light_sky_contribution**  **(** :ref:`float<class_float>` energy  **)**

.. _class_Environment_set_background:

- void  **set_background**  **(** :ref:`int<class_int>` mode  **)**

.. _class_Environment_set_bg_color:

- void  **set_bg_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_Environment_set_bg_energy:

- void  **set_bg_energy**  **(** :ref:`float<class_float>` energy  **)**

.. _class_Environment_set_canvas_max_layer:

- void  **set_canvas_max_layer**  **(** :ref:`int<class_int>` layer  **)**

.. _class_Environment_set_dof_blur_far_amount:

- void  **set_dof_blur_far_amount**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_dof_blur_far_distance:

- void  **set_dof_blur_far_distance**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_dof_blur_far_enabled:

- void  **set_dof_blur_far_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_dof_blur_far_quality:

- void  **set_dof_blur_far_quality**  **(** :ref:`int<class_int>` intensity  **)**

.. _class_Environment_set_dof_blur_far_transition:

- void  **set_dof_blur_far_transition**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_dof_blur_near_amount:

- void  **set_dof_blur_near_amount**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_dof_blur_near_distance:

- void  **set_dof_blur_near_distance**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_dof_blur_near_enabled:

- void  **set_dof_blur_near_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_dof_blur_near_quality:

- void  **set_dof_blur_near_quality**  **(** :ref:`int<class_int>` level  **)**

.. _class_Environment_set_dof_blur_near_transition:

- void  **set_dof_blur_near_transition**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_fog_color:

- void  **set_fog_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_Environment_set_fog_depth_begin:

- void  **set_fog_depth_begin**  **(** :ref:`float<class_float>` distance  **)**

.. _class_Environment_set_fog_depth_curve:

- void  **set_fog_depth_curve**  **(** :ref:`float<class_float>` curve  **)**

.. _class_Environment_set_fog_depth_enabled:

- void  **set_fog_depth_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_fog_enabled:

- void  **set_fog_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_fog_height_curve:

- void  **set_fog_height_curve**  **(** :ref:`float<class_float>` curve  **)**

.. _class_Environment_set_fog_height_enabled:

- void  **set_fog_height_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_fog_height_max:

- void  **set_fog_height_max**  **(** :ref:`float<class_float>` height  **)**

.. _class_Environment_set_fog_height_min:

- void  **set_fog_height_min**  **(** :ref:`float<class_float>` height  **)**

.. _class_Environment_set_fog_sun_amount:

- void  **set_fog_sun_amount**  **(** :ref:`float<class_float>` amount  **)**

.. _class_Environment_set_fog_sun_color:

- void  **set_fog_sun_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_Environment_set_fog_transmit_curve:

- void  **set_fog_transmit_curve**  **(** :ref:`float<class_float>` curve  **)**

.. _class_Environment_set_fog_transmit_enabled:

- void  **set_fog_transmit_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_glow_bicubic_upscale:

- void  **set_glow_bicubic_upscale**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_glow_blend_mode:

- void  **set_glow_blend_mode**  **(** :ref:`int<class_int>` mode  **)**

.. _class_Environment_set_glow_bloom:

- void  **set_glow_bloom**  **(** :ref:`float<class_float>` amount  **)**

.. _class_Environment_set_glow_enabled:

- void  **set_glow_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_glow_hdr_bleed_scale:

- void  **set_glow_hdr_bleed_scale**  **(** :ref:`float<class_float>` scale  **)**

.. _class_Environment_set_glow_hdr_bleed_threshold:

- void  **set_glow_hdr_bleed_threshold**  **(** :ref:`float<class_float>` threshold  **)**

.. _class_Environment_set_glow_intensity:

- void  **set_glow_intensity**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_glow_level:

- void  **set_glow_level**  **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_glow_strength:

- void  **set_glow_strength**  **(** :ref:`float<class_float>` strength  **)**

.. _class_Environment_set_sky:

- void  **set_sky**  **(** :ref:`Sky<class_sky>` sky  **)**

.. _class_Environment_set_sky_custom_fov:

- void  **set_sky_custom_fov**  **(** :ref:`float<class_float>` scale  **)**

.. _class_Environment_set_ssao_bias:

- void  **set_ssao_bias**  **(** :ref:`float<class_float>` bias  **)**

.. _class_Environment_set_ssao_blur:

- void  **set_ssao_blur**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_ssao_color:

- void  **set_ssao_color**  **(** :ref:`Color<class_color>` color  **)**

.. _class_Environment_set_ssao_direct_light_affect:

- void  **set_ssao_direct_light_affect**  **(** :ref:`float<class_float>` amount  **)**

.. _class_Environment_set_ssao_enabled:

- void  **set_ssao_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_ssao_intensity:

- void  **set_ssao_intensity**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_ssao_intensity2:

- void  **set_ssao_intensity2**  **(** :ref:`float<class_float>` intensity  **)**

.. _class_Environment_set_ssao_radius:

- void  **set_ssao_radius**  **(** :ref:`float<class_float>` radius  **)**

.. _class_Environment_set_ssao_radius2:

- void  **set_ssao_radius2**  **(** :ref:`float<class_float>` radius  **)**

.. _class_Environment_set_ssr_depth_tolerance:

- void  **set_ssr_depth_tolerance**  **(** :ref:`float<class_float>` depth_tolerance  **)**

.. _class_Environment_set_ssr_enabled:

- void  **set_ssr_enabled**  **(** :ref:`bool<class_bool>` enabled  **)**

.. _class_Environment_set_ssr_fade_in:

- void  **set_ssr_fade_in**  **(** :ref:`float<class_float>` fade_in  **)**

.. _class_Environment_set_ssr_fade_out:

- void  **set_ssr_fade_out**  **(** :ref:`float<class_float>` fade_out  **)**

.. _class_Environment_set_ssr_max_steps:

- void  **set_ssr_max_steps**  **(** :ref:`int<class_int>` max_steps  **)**

.. _class_Environment_set_ssr_rough:

- void  **set_ssr_rough**  **(** :ref:`bool<class_bool>` rough  **)**

.. _class_Environment_set_tonemap_auto_exposure:

- void  **set_tonemap_auto_exposure**  **(** :ref:`bool<class_bool>` auto_exposure  **)**

.. _class_Environment_set_tonemap_auto_exposure_grey:

- void  **set_tonemap_auto_exposure_grey**  **(** :ref:`float<class_float>` exposure_grey  **)**

.. _class_Environment_set_tonemap_auto_exposure_max:

- void  **set_tonemap_auto_exposure_max**  **(** :ref:`float<class_float>` exposure_max  **)**

.. _class_Environment_set_tonemap_auto_exposure_min:

- void  **set_tonemap_auto_exposure_min**  **(** :ref:`float<class_float>` exposure_min  **)**

.. _class_Environment_set_tonemap_auto_exposure_speed:

- void  **set_tonemap_auto_exposure_speed**  **(** :ref:`float<class_float>` exposure_speed  **)**

.. _class_Environment_set_tonemap_exposure:

- void  **set_tonemap_exposure**  **(** :ref:`float<class_float>` exposure  **)**

.. _class_Environment_set_tonemap_white:

- void  **set_tonemap_white**  **(** :ref:`float<class_float>` white  **)**

.. _class_Environment_set_tonemapper:

- void  **set_tonemapper**  **(** :ref:`int<class_int>` mode  **)**