.. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. .. _class_Environment: Environment =========== **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` **Category:** Core Brief Description ----------------- Member Functions ---------------- +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_adjustment_brightness` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_adjustment_color_correction` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_adjustment_contrast` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_adjustment_saturation` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_ambient_light_color` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ambient_light_energy` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ambient_light_sky_contribution` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_background` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_bg_color` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bg_energy` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_canvas_max_layer` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_far_amount` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_far_distance` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_dof_blur_far_quality` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_far_transition` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_near_amount` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_near_distance` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_dof_blur_near_quality` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_dof_blur_near_transition` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_fog_color` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_depth_begin` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_depth_curve` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_height_curve` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_height_max` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_height_min` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_sun_amount` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_fog_sun_color` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fog_transmit_curve` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_glow_blend_mode` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_bloom` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_strength` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Sky` | :ref:`get_sky` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_sky_scale` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_bias` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_ssao_color` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_direct_light_affect` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_intensity` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_intensity2` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_radius` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssao_radius2` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssr_depth_tolerance` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssr_fade_in` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_ssr_fade_out` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_ssr_max_steps` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_tonemap_auto_exposure` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_tonemap_auto_exposure_grey` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_tonemap_auto_exposure_max` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_tonemap_auto_exposure_min` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_tonemap_auto_exposure_speed` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_tonemap_exposure` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_tonemap_white` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_tonemapper` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_adjustment_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_dof_blur_far_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_dof_blur_near_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_fog_depth_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_fog_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_fog_height_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_fog_transmit_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_glow_bicubic_upscale_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_glow_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_glow_level_enabled` **(** :ref:`int` idx **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ssao_blur_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ssao_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ssr_enabled` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ssr_rough` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_brightness` **(** :ref:`float` brightness **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_color_correction` **(** :ref:`Texture` color_correction **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_contrast` **(** :ref:`float` contrast **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_enable` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_adjustment_saturation` **(** :ref:`float` saturation **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ambient_light_color` **(** :ref:`Color` color **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ambient_light_energy` **(** :ref:`float` energy **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ambient_light_sky_contribution` **(** :ref:`float` energy **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_background` **(** :ref:`int` mode **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bg_color` **(** :ref:`Color` color **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bg_energy` **(** :ref:`float` energy **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_canvas_max_layer` **(** :ref:`int` layer **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_far_amount` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_far_distance` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_far_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_far_quality` **(** :ref:`int` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_far_transition` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_near_amount` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_near_distance` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_near_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_near_quality` **(** :ref:`int` level **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_dof_blur_near_transition` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_color` **(** :ref:`Color` color **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_depth_begin` **(** :ref:`float` distance **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_depth_curve` **(** :ref:`float` curve **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_depth_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_height_curve` **(** :ref:`float` curve **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_height_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_height_max` **(** :ref:`float` height **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_height_min` **(** :ref:`float` height **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_sun_amount` **(** :ref:`float` amount **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_sun_color` **(** :ref:`Color` color **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_transmit_curve` **(** :ref:`float` curve **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_fog_transmit_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_bicubic_upscale` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_blend_mode` **(** :ref:`int` mode **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_bloom` **(** :ref:`float` amount **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_level` **(** :ref:`int` idx, :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sky_scale` **(** :ref:`float` scale **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_bias` **(** :ref:`float` bias **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_blur` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_color` **(** :ref:`Color` color **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_direct_light_affect` **(** :ref:`float` amount **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_intensity` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_intensity2` **(** :ref:`float` intensity **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_radius` **(** :ref:`float` radius **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssao_radius2` **(** :ref:`float` radius **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_depth_tolerance` **(** :ref:`float` depth_tolerance **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_enabled` **(** :ref:`bool` enabled **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_fade_in` **(** :ref:`float` fade_in **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_fade_out` **(** :ref:`float` fade_out **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_max_steps` **(** :ref:`int` max_steps **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ssr_rough` **(** :ref:`bool` rough **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure` **(** :ref:`bool` auto_exposure **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure_grey` **(** :ref:`float` exposure_grey **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure_max` **(** :ref:`float` exposure_max **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure_min` **(** :ref:`float` exposure_min **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_auto_exposure_speed` **(** :ref:`float` exposure_speed **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_exposure` **(** :ref:`float` exposure **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemap_white` **(** :ref:`float` white **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tonemapper` **(** :ref:`int` mode **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`float` **adjustment_brightness** - :ref:`Texture` **adjustment_color_correction** - :ref:`float` **adjustment_contrast** - :ref:`bool` **adjustment_enabled** - :ref:`float` **adjustment_saturation** - :ref:`Color` **ambient_light_color** - :ref:`float` **ambient_light_energy** - :ref:`float` **ambient_light_sky_contribution** - :ref:`bool` **auto_exposure_enabled** - :ref:`float` **auto_exposure_max_luma** - :ref:`float` **auto_exposure_min_luma** - :ref:`float` **auto_exposure_scale** - :ref:`float` **auto_exposure_speed** - :ref:`int` **background_canvas_max_layer** - :ref:`Color` **background_color** - :ref:`float` **background_energy** - :ref:`int` **background_mode** - :ref:`Sky` **background_sky** - :ref:`float` **background_sky_scale** - :ref:`float` **dof_blur_far_amount** - :ref:`float` **dof_blur_far_distance** - :ref:`bool` **dof_blur_far_enabled** - :ref:`int` **dof_blur_far_quality** - :ref:`float` **dof_blur_far_transition** - :ref:`float` **dof_blur_near_amount** - :ref:`float` **dof_blur_near_distance** - :ref:`bool` **dof_blur_near_enabled** - :ref:`int` **dof_blur_near_quality** - :ref:`float` **dof_blur_near_transition** - :ref:`Color` **fog_color** - :ref:`float` **fog_depth_begin** - :ref:`float` **fog_depth_curve** - :ref:`bool` **fog_depth_enabled** - :ref:`bool` **fog_enabled** - :ref:`float` **fog_height_curve** - :ref:`bool` **fog_height_enabled** - :ref:`float` **fog_height_max** - :ref:`float` **fog_height_min** - :ref:`float` **fog_sun_amount** - :ref:`Color` **fog_sun_color** - :ref:`float` **fog_transmit_curve** - :ref:`bool` **fog_transmit_enabled** - :ref:`bool` **glow_bicubic_upscale** - :ref:`int` **glow_blend_mode** - :ref:`float` **glow_bloom** - :ref:`bool` **glow_enabled** - :ref:`float` **glow_hdr_scale** - :ref:`float` **glow_hdr_threshold** - :ref:`float` **glow_intensity** - :ref:`bool` **glow_levels/1** - :ref:`bool` **glow_levels/2** - :ref:`bool` **glow_levels/3** - :ref:`bool` **glow_levels/4** - :ref:`bool` **glow_levels/5** - :ref:`bool` **glow_levels/6** - :ref:`bool` **glow_levels/7** - :ref:`float` **glow_strength** - :ref:`float` **ss_reflections_depth_tolerance** - :ref:`bool` **ss_reflections_enabled** - :ref:`float` **ss_reflections_fade_in** - :ref:`float` **ss_reflections_fade_out** - :ref:`int` **ss_reflections_max_steps** - :ref:`bool` **ss_reflections_roughness** - :ref:`float` **ssao_bias** - :ref:`bool` **ssao_blur** - :ref:`Color` **ssao_color** - :ref:`bool` **ssao_enabled** - :ref:`float` **ssao_intensity** - :ref:`float` **ssao_intensity2** - :ref:`float` **ssao_light_affect** - :ref:`float` **ssao_radius** - :ref:`float` **ssao_radius2** - :ref:`float` **tonemap_exposure** - :ref:`int` **tonemap_mode** - :ref:`float` **tonemap_white** Numeric Constants ----------------- - **BG_KEEP** = **4** - **BG_CLEAR_COLOR** = **0** - **BG_COLOR** = **1** - **BG_SKY** = **2** - **BG_CANVAS** = **3** - **BG_MAX** = **5** - **GLOW_BLEND_MODE_ADDITIVE** = **0** - **GLOW_BLEND_MODE_SCREEN** = **1** - **GLOW_BLEND_MODE_SOFTLIGHT** = **2** - **GLOW_BLEND_MODE_REPLACE** = **3** - **TONE_MAPPER_LINEAR** = **0** - **TONE_MAPPER_REINHARDT** = **1** - **TONE_MAPPER_FILMIC** = **2** - **TONE_MAPPER_ACES** = **3** - **DOF_BLUR_QUALITY_LOW** = **0** - **DOF_BLUR_QUALITY_MEDIUM** = **1** - **DOF_BLUR_QUALITY_HIGH** = **2** Member Function Description --------------------------- .. _class_Environment_get_adjustment_brightness: - :ref:`float` **get_adjustment_brightness** **(** **)** const .. _class_Environment_get_adjustment_color_correction: - :ref:`Texture` **get_adjustment_color_correction** **(** **)** const .. _class_Environment_get_adjustment_contrast: - :ref:`float` **get_adjustment_contrast** **(** **)** const .. _class_Environment_get_adjustment_saturation: - :ref:`float` **get_adjustment_saturation** **(** **)** const .. _class_Environment_get_ambient_light_color: - :ref:`Color` **get_ambient_light_color** **(** **)** const .. _class_Environment_get_ambient_light_energy: - :ref:`float` **get_ambient_light_energy** **(** **)** const .. _class_Environment_get_ambient_light_sky_contribution: - :ref:`float` **get_ambient_light_sky_contribution** **(** **)** const .. _class_Environment_get_background: - :ref:`int` **get_background** **(** **)** const .. _class_Environment_get_bg_color: - :ref:`Color` **get_bg_color** **(** **)** const .. _class_Environment_get_bg_energy: - :ref:`float` **get_bg_energy** **(** **)** const .. _class_Environment_get_canvas_max_layer: - :ref:`int` **get_canvas_max_layer** **(** **)** const .. _class_Environment_get_dof_blur_far_amount: - :ref:`float` **get_dof_blur_far_amount** **(** **)** const .. _class_Environment_get_dof_blur_far_distance: - :ref:`float` **get_dof_blur_far_distance** **(** **)** const .. _class_Environment_get_dof_blur_far_quality: - :ref:`int` **get_dof_blur_far_quality** **(** **)** const .. _class_Environment_get_dof_blur_far_transition: - :ref:`float` **get_dof_blur_far_transition** **(** **)** const .. _class_Environment_get_dof_blur_near_amount: - :ref:`float` **get_dof_blur_near_amount** **(** **)** const .. _class_Environment_get_dof_blur_near_distance: - :ref:`float` **get_dof_blur_near_distance** **(** **)** const .. _class_Environment_get_dof_blur_near_quality: - :ref:`int` **get_dof_blur_near_quality** **(** **)** const .. _class_Environment_get_dof_blur_near_transition: - :ref:`float` **get_dof_blur_near_transition** **(** **)** const .. _class_Environment_get_fog_color: - :ref:`Color` **get_fog_color** **(** **)** const .. _class_Environment_get_fog_depth_begin: - :ref:`float` **get_fog_depth_begin** **(** **)** const .. _class_Environment_get_fog_depth_curve: - :ref:`float` **get_fog_depth_curve** **(** **)** const .. _class_Environment_get_fog_height_curve: - :ref:`float` **get_fog_height_curve** **(** **)** const .. _class_Environment_get_fog_height_max: - :ref:`float` **get_fog_height_max** **(** **)** const .. _class_Environment_get_fog_height_min: - :ref:`float` **get_fog_height_min** **(** **)** const .. _class_Environment_get_fog_sun_amount: - :ref:`float` **get_fog_sun_amount** **(** **)** const .. _class_Environment_get_fog_sun_color: - :ref:`Color` **get_fog_sun_color** **(** **)** const .. _class_Environment_get_fog_transmit_curve: - :ref:`float` **get_fog_transmit_curve** **(** **)** const .. _class_Environment_get_glow_blend_mode: - :ref:`int` **get_glow_blend_mode** **(** **)** const .. _class_Environment_get_glow_bloom: - :ref:`float` **get_glow_bloom** **(** **)** const .. _class_Environment_get_glow_hdr_bleed_scale: - :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** const .. _class_Environment_get_glow_hdr_bleed_threshold: - :ref:`float` **get_glow_hdr_bleed_threshold** **(** **)** const .. _class_Environment_get_glow_intensity: - :ref:`float` **get_glow_intensity** **(** **)** const .. _class_Environment_get_glow_strength: - :ref:`float` **get_glow_strength** **(** **)** const .. _class_Environment_get_sky: - :ref:`Sky` **get_sky** **(** **)** const .. _class_Environment_get_sky_scale: - :ref:`float` **get_sky_scale** **(** **)** const .. _class_Environment_get_ssao_bias: - :ref:`float` **get_ssao_bias** **(** **)** const .. _class_Environment_get_ssao_color: - :ref:`Color` **get_ssao_color** **(** **)** const .. _class_Environment_get_ssao_direct_light_affect: - :ref:`float` **get_ssao_direct_light_affect** **(** **)** const .. _class_Environment_get_ssao_intensity: - :ref:`float` **get_ssao_intensity** **(** **)** const .. _class_Environment_get_ssao_intensity2: - :ref:`float` **get_ssao_intensity2** **(** **)** const .. _class_Environment_get_ssao_radius: - :ref:`float` **get_ssao_radius** **(** **)** const .. _class_Environment_get_ssao_radius2: - :ref:`float` **get_ssao_radius2** **(** **)** const .. _class_Environment_get_ssr_depth_tolerance: - :ref:`float` **get_ssr_depth_tolerance** **(** **)** const .. _class_Environment_get_ssr_fade_in: - :ref:`float` **get_ssr_fade_in** **(** **)** const .. _class_Environment_get_ssr_fade_out: - :ref:`float` **get_ssr_fade_out** **(** **)** const .. _class_Environment_get_ssr_max_steps: - :ref:`int` **get_ssr_max_steps** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure: - :ref:`bool` **get_tonemap_auto_exposure** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_grey: - :ref:`float` **get_tonemap_auto_exposure_grey** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_max: - :ref:`float` **get_tonemap_auto_exposure_max** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_min: - :ref:`float` **get_tonemap_auto_exposure_min** **(** **)** const .. _class_Environment_get_tonemap_auto_exposure_speed: - :ref:`float` **get_tonemap_auto_exposure_speed** **(** **)** const .. _class_Environment_get_tonemap_exposure: - :ref:`float` **get_tonemap_exposure** **(** **)** const .. _class_Environment_get_tonemap_white: - :ref:`float` **get_tonemap_white** **(** **)** const .. _class_Environment_get_tonemapper: - :ref:`int` **get_tonemapper** **(** **)** const .. _class_Environment_is_adjustment_enabled: - :ref:`bool` **is_adjustment_enabled** **(** **)** const .. _class_Environment_is_dof_blur_far_enabled: - :ref:`bool` **is_dof_blur_far_enabled** **(** **)** const .. _class_Environment_is_dof_blur_near_enabled: - :ref:`bool` **is_dof_blur_near_enabled** **(** **)** const .. _class_Environment_is_fog_depth_enabled: - :ref:`bool` **is_fog_depth_enabled** **(** **)** const .. _class_Environment_is_fog_enabled: - :ref:`bool` **is_fog_enabled** **(** **)** const .. _class_Environment_is_fog_height_enabled: - :ref:`bool` **is_fog_height_enabled** **(** **)** const .. _class_Environment_is_fog_transmit_enabled: - :ref:`bool` **is_fog_transmit_enabled** **(** **)** const .. _class_Environment_is_glow_bicubic_upscale_enabled: - :ref:`bool` **is_glow_bicubic_upscale_enabled** **(** **)** const .. _class_Environment_is_glow_enabled: - :ref:`bool` **is_glow_enabled** **(** **)** const .. _class_Environment_is_glow_level_enabled: - :ref:`bool` **is_glow_level_enabled** **(** :ref:`int` idx **)** const .. _class_Environment_is_ssao_blur_enabled: - :ref:`bool` **is_ssao_blur_enabled** **(** **)** const .. _class_Environment_is_ssao_enabled: - :ref:`bool` **is_ssao_enabled** **(** **)** const .. _class_Environment_is_ssr_enabled: - :ref:`bool` **is_ssr_enabled** **(** **)** const .. _class_Environment_is_ssr_rough: - :ref:`bool` **is_ssr_rough** **(** **)** const .. _class_Environment_set_adjustment_brightness: - void **set_adjustment_brightness** **(** :ref:`float` brightness **)** .. _class_Environment_set_adjustment_color_correction: - void **set_adjustment_color_correction** **(** :ref:`Texture` color_correction **)** .. _class_Environment_set_adjustment_contrast: - void **set_adjustment_contrast** **(** :ref:`float` contrast **)** .. _class_Environment_set_adjustment_enable: - void **set_adjustment_enable** **(** :ref:`bool` enabled **)** .. _class_Environment_set_adjustment_saturation: - void **set_adjustment_saturation** **(** :ref:`float` saturation **)** .. _class_Environment_set_ambient_light_color: - void **set_ambient_light_color** **(** :ref:`Color` color **)** .. _class_Environment_set_ambient_light_energy: - void **set_ambient_light_energy** **(** :ref:`float` energy **)** .. _class_Environment_set_ambient_light_sky_contribution: - void **set_ambient_light_sky_contribution** **(** :ref:`float` energy **)** .. _class_Environment_set_background: - void **set_background** **(** :ref:`int` mode **)** .. _class_Environment_set_bg_color: - void **set_bg_color** **(** :ref:`Color` color **)** .. _class_Environment_set_bg_energy: - void **set_bg_energy** **(** :ref:`float` energy **)** .. _class_Environment_set_canvas_max_layer: - void **set_canvas_max_layer** **(** :ref:`int` layer **)** .. _class_Environment_set_dof_blur_far_amount: - void **set_dof_blur_far_amount** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_far_distance: - void **set_dof_blur_far_distance** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_far_enabled: - void **set_dof_blur_far_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_dof_blur_far_quality: - void **set_dof_blur_far_quality** **(** :ref:`int` intensity **)** .. _class_Environment_set_dof_blur_far_transition: - void **set_dof_blur_far_transition** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_near_amount: - void **set_dof_blur_near_amount** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_near_distance: - void **set_dof_blur_near_distance** **(** :ref:`float` intensity **)** .. _class_Environment_set_dof_blur_near_enabled: - void **set_dof_blur_near_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_dof_blur_near_quality: - void **set_dof_blur_near_quality** **(** :ref:`int` level **)** .. _class_Environment_set_dof_blur_near_transition: - void **set_dof_blur_near_transition** **(** :ref:`float` intensity **)** .. _class_Environment_set_fog_color: - void **set_fog_color** **(** :ref:`Color` color **)** .. _class_Environment_set_fog_depth_begin: - void **set_fog_depth_begin** **(** :ref:`float` distance **)** .. _class_Environment_set_fog_depth_curve: - void **set_fog_depth_curve** **(** :ref:`float` curve **)** .. _class_Environment_set_fog_depth_enabled: - void **set_fog_depth_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_fog_enabled: - void **set_fog_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_fog_height_curve: - void **set_fog_height_curve** **(** :ref:`float` curve **)** .. _class_Environment_set_fog_height_enabled: - void **set_fog_height_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_fog_height_max: - void **set_fog_height_max** **(** :ref:`float` height **)** .. _class_Environment_set_fog_height_min: - void **set_fog_height_min** **(** :ref:`float` height **)** .. _class_Environment_set_fog_sun_amount: - void **set_fog_sun_amount** **(** :ref:`float` amount **)** .. _class_Environment_set_fog_sun_color: - void **set_fog_sun_color** **(** :ref:`Color` color **)** .. _class_Environment_set_fog_transmit_curve: - void **set_fog_transmit_curve** **(** :ref:`float` curve **)** .. _class_Environment_set_fog_transmit_enabled: - void **set_fog_transmit_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_glow_bicubic_upscale: - void **set_glow_bicubic_upscale** **(** :ref:`bool` enabled **)** .. _class_Environment_set_glow_blend_mode: - void **set_glow_blend_mode** **(** :ref:`int` mode **)** .. _class_Environment_set_glow_bloom: - void **set_glow_bloom** **(** :ref:`float` amount **)** .. _class_Environment_set_glow_enabled: - void **set_glow_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_glow_hdr_bleed_scale: - void **set_glow_hdr_bleed_scale** **(** :ref:`float` scale **)** .. _class_Environment_set_glow_hdr_bleed_threshold: - void **set_glow_hdr_bleed_threshold** **(** :ref:`float` threshold **)** .. _class_Environment_set_glow_intensity: - void **set_glow_intensity** **(** :ref:`float` intensity **)** .. _class_Environment_set_glow_level: - void **set_glow_level** **(** :ref:`int` idx, :ref:`bool` enabled **)** .. _class_Environment_set_glow_strength: - void **set_glow_strength** **(** :ref:`float` strength **)** .. _class_Environment_set_sky: - void **set_sky** **(** :ref:`Sky` sky **)** .. _class_Environment_set_sky_scale: - void **set_sky_scale** **(** :ref:`float` scale **)** .. _class_Environment_set_ssao_bias: - void **set_ssao_bias** **(** :ref:`float` bias **)** .. _class_Environment_set_ssao_blur: - void **set_ssao_blur** **(** :ref:`bool` enabled **)** .. _class_Environment_set_ssao_color: - void **set_ssao_color** **(** :ref:`Color` color **)** .. _class_Environment_set_ssao_direct_light_affect: - void **set_ssao_direct_light_affect** **(** :ref:`float` amount **)** .. _class_Environment_set_ssao_enabled: - void **set_ssao_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_ssao_intensity: - void **set_ssao_intensity** **(** :ref:`float` intensity **)** .. _class_Environment_set_ssao_intensity2: - void **set_ssao_intensity2** **(** :ref:`float` intensity **)** .. _class_Environment_set_ssao_radius: - void **set_ssao_radius** **(** :ref:`float` radius **)** .. _class_Environment_set_ssao_radius2: - void **set_ssao_radius2** **(** :ref:`float` radius **)** .. _class_Environment_set_ssr_depth_tolerance: - void **set_ssr_depth_tolerance** **(** :ref:`float` depth_tolerance **)** .. _class_Environment_set_ssr_enabled: - void **set_ssr_enabled** **(** :ref:`bool` enabled **)** .. _class_Environment_set_ssr_fade_in: - void **set_ssr_fade_in** **(** :ref:`float` fade_in **)** .. _class_Environment_set_ssr_fade_out: - void **set_ssr_fade_out** **(** :ref:`float` fade_out **)** .. _class_Environment_set_ssr_max_steps: - void **set_ssr_max_steps** **(** :ref:`int` max_steps **)** .. _class_Environment_set_ssr_rough: - void **set_ssr_rough** **(** :ref:`bool` rough **)** .. _class_Environment_set_tonemap_auto_exposure: - void **set_tonemap_auto_exposure** **(** :ref:`bool` auto_exposure **)** .. _class_Environment_set_tonemap_auto_exposure_grey: - void **set_tonemap_auto_exposure_grey** **(** :ref:`float` exposure_grey **)** .. _class_Environment_set_tonemap_auto_exposure_max: - void **set_tonemap_auto_exposure_max** **(** :ref:`float` exposure_max **)** .. _class_Environment_set_tonemap_auto_exposure_min: - void **set_tonemap_auto_exposure_min** **(** :ref:`float` exposure_min **)** .. _class_Environment_set_tonemap_auto_exposure_speed: - void **set_tonemap_auto_exposure_speed** **(** :ref:`float` exposure_speed **)** .. _class_Environment_set_tonemap_exposure: - void **set_tonemap_exposure** **(** :ref:`float` exposure **)** .. _class_Environment_set_tonemap_white: - void **set_tonemap_white** **(** :ref:`float` white **)** .. _class_Environment_set_tonemapper: - void **set_tonemapper** **(** :ref:`int` mode **)**