1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471 |
- :github_url: hide
- .. 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.
- Properties
- ----------
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`adjustment_brightness<class_Environment_property_adjustment_brightness>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Texture<class_Texture>` | :ref:`adjustment_color_correction<class_Environment_property_adjustment_color_correction>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`adjustment_contrast<class_Environment_property_adjustment_contrast>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`adjustment_enabled<class_Environment_property_adjustment_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`adjustment_saturation<class_Environment_property_adjustment_saturation>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`ambient_light_color<class_Environment_property_ambient_light_color>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ambient_light_energy<class_Environment_property_ambient_light_energy>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ambient_light_sky_contribution<class_Environment_property_ambient_light_sky_contribution>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`auto_exposure_enabled<class_Environment_property_auto_exposure_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`auto_exposure_max_luma<class_Environment_property_auto_exposure_max_luma>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`auto_exposure_min_luma<class_Environment_property_auto_exposure_min_luma>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`auto_exposure_scale<class_Environment_property_auto_exposure_scale>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`auto_exposure_speed<class_Environment_property_auto_exposure_speed>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`background_canvas_max_layer<class_Environment_property_background_canvas_max_layer>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`background_color<class_Environment_property_background_color>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`background_energy<class_Environment_property_background_energy>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`BGMode<enum_Environment_BGMode>` | :ref:`background_mode<class_Environment_property_background_mode>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Sky<class_Sky>` | :ref:`background_sky<class_Environment_property_background_sky>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`background_sky_custom_fov<class_Environment_property_background_sky_custom_fov>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Basis<class_Basis>` | :ref:`background_sky_orientation<class_Environment_property_background_sky_orientation>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`background_sky_rotation<class_Environment_property_background_sky_rotation>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Vector3<class_Vector3>` | :ref:`background_sky_rotation_degrees<class_Environment_property_background_sky_rotation_degrees>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`dof_blur_far_amount<class_Environment_property_dof_blur_far_amount>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`dof_blur_far_distance<class_Environment_property_dof_blur_far_distance>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`dof_blur_far_enabled<class_Environment_property_dof_blur_far_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` | :ref:`dof_blur_far_quality<class_Environment_property_dof_blur_far_quality>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`dof_blur_far_transition<class_Environment_property_dof_blur_far_transition>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`dof_blur_near_amount<class_Environment_property_dof_blur_near_amount>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`dof_blur_near_distance<class_Environment_property_dof_blur_near_distance>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`dof_blur_near_enabled<class_Environment_property_dof_blur_near_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` | :ref:`dof_blur_near_quality<class_Environment_property_dof_blur_near_quality>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`dof_blur_near_transition<class_Environment_property_dof_blur_near_transition>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`fog_color<class_Environment_property_fog_color>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_depth_begin<class_Environment_property_fog_depth_begin>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_depth_curve<class_Environment_property_fog_depth_curve>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`fog_depth_enabled<class_Environment_property_fog_depth_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_depth_end<class_Environment_property_fog_depth_end>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`fog_enabled<class_Environment_property_fog_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_height_curve<class_Environment_property_fog_height_curve>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`fog_height_enabled<class_Environment_property_fog_height_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_height_max<class_Environment_property_fog_height_max>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_height_min<class_Environment_property_fog_height_min>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_sun_amount<class_Environment_property_fog_sun_amount>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`fog_sun_color<class_Environment_property_fog_sun_color>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`fog_transmit_curve<class_Environment_property_fog_transmit_curve>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`fog_transmit_enabled<class_Environment_property_fog_transmit_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_bicubic_upscale<class_Environment_property_glow_bicubic_upscale>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`GlowBlendMode<enum_Environment_GlowBlendMode>` | :ref:`glow_blend_mode<class_Environment_property_glow_blend_mode>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`glow_bloom<class_Environment_property_glow_bloom>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_enabled<class_Environment_property_glow_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`glow_hdr_luminance_cap<class_Environment_property_glow_hdr_luminance_cap>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`glow_hdr_scale<class_Environment_property_glow_hdr_scale>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`glow_hdr_threshold<class_Environment_property_glow_hdr_threshold>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`glow_intensity<class_Environment_property_glow_intensity>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/1<class_Environment_property_glow_levels/1>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/2<class_Environment_property_glow_levels/2>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/3<class_Environment_property_glow_levels/3>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/4<class_Environment_property_glow_levels/4>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/5<class_Environment_property_glow_levels/5>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/6<class_Environment_property_glow_levels/6>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`glow_levels/7<class_Environment_property_glow_levels/7>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`glow_strength<class_Environment_property_glow_strength>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ss_reflections_depth_tolerance<class_Environment_property_ss_reflections_depth_tolerance>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`ss_reflections_enabled<class_Environment_property_ss_reflections_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ss_reflections_fade_in<class_Environment_property_ss_reflections_fade_in>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ss_reflections_fade_out<class_Environment_property_ss_reflections_fade_out>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`ss_reflections_max_steps<class_Environment_property_ss_reflections_max_steps>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`ss_reflections_roughness<class_Environment_property_ss_reflections_roughness>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_ao_channel_affect<class_Environment_property_ssao_ao_channel_affect>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_bias<class_Environment_property_ssao_bias>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`SSAOBlur<enum_Environment_SSAOBlur>` | :ref:`ssao_blur<class_Environment_property_ssao_blur>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`ssao_color<class_Environment_property_ssao_color>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_edge_sharpness<class_Environment_property_ssao_edge_sharpness>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`ssao_enabled<class_Environment_property_ssao_enabled>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_intensity<class_Environment_property_ssao_intensity>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_intensity2<class_Environment_property_ssao_intensity2>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_light_affect<class_Environment_property_ssao_light_affect>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`SSAOQuality<enum_Environment_SSAOQuality>` | :ref:`ssao_quality<class_Environment_property_ssao_quality>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_radius<class_Environment_property_ssao_radius>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`ssao_radius2<class_Environment_property_ssao_radius2>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`tonemap_exposure<class_Environment_property_tonemap_exposure>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`ToneMapper<enum_Environment_ToneMapper>` | :ref:`tonemap_mode<class_Environment_property_tonemap_mode>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`tonemap_white<class_Environment_property_tonemap_white>` |
- +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_Environment_BGMode:
- .. _class_Environment_constant_BG_KEEP:
- .. _class_Environment_constant_BG_CLEAR_COLOR:
- .. _class_Environment_constant_BG_COLOR:
- .. _class_Environment_constant_BG_SKY:
- .. _class_Environment_constant_BG_COLOR_SKY:
- .. _class_Environment_constant_BG_CANVAS:
- .. _class_Environment_constant_BG_MAX:
- enum **BGMode**:
- - **BG_KEEP** = **5** --- Keep on screen every pixel drawn in the background.
- - **BG_CLEAR_COLOR** = **0** --- Clear the background using the project's clear color.
- - **BG_COLOR** = **1** --- Clear the background using a custom clear color.
- - **BG_SKY** = **2** --- Display a user-defined sky in the background.
- - **BG_COLOR_SKY** = **3** --- Clear the background using a custom clear color and allows defining a sky for shading and reflection.
- - **BG_CANVAS** = **4** --- Display a :ref:`CanvasLayer<class_CanvasLayer>` in the background.
- - **BG_MAX** = **6** --- Represents the size of the :ref:`BGMode<enum_Environment_BGMode>` enum.
- ----
- .. _enum_Environment_GlowBlendMode:
- .. _class_Environment_constant_GLOW_BLEND_MODE_ADDITIVE:
- .. _class_Environment_constant_GLOW_BLEND_MODE_SCREEN:
- .. _class_Environment_constant_GLOW_BLEND_MODE_SOFTLIGHT:
- .. _class_Environment_constant_GLOW_BLEND_MODE_REPLACE:
- enum **GlowBlendMode**:
- - **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
- - **GLOW_BLEND_MODE_SCREEN** = **1** --- Screen glow blending mode. Increases brightness, used frequently with bloom.
- - **GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom.
- - **GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value.
- ----
- .. _enum_Environment_ToneMapper:
- .. _class_Environment_constant_TONE_MAPPER_LINEAR:
- .. _class_Environment_constant_TONE_MAPPER_REINHARDT:
- .. _class_Environment_constant_TONE_MAPPER_FILMIC:
- .. _class_Environment_constant_TONE_MAPPER_ACES:
- enum **ToneMapper**:
- - **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.
- - **TONE_MAPPER_REINHARDT** = **1** --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color).
- - **TONE_MAPPER_FILMIC** = **2** --- Filmic tonemapper operator.
- - **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator.
- ----
- .. _enum_Environment_DOFBlurQuality:
- .. _class_Environment_constant_DOF_BLUR_QUALITY_LOW:
- .. _class_Environment_constant_DOF_BLUR_QUALITY_MEDIUM:
- .. _class_Environment_constant_DOF_BLUR_QUALITY_HIGH:
- enum **DOFBlurQuality**:
- - **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality.
- - **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality.
- - **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality.
- ----
- .. _enum_Environment_SSAOBlur:
- .. _class_Environment_constant_SSAO_BLUR_DISABLED:
- .. _class_Environment_constant_SSAO_BLUR_1x1:
- .. _class_Environment_constant_SSAO_BLUR_2x2:
- .. _class_Environment_constant_SSAO_BLUR_3x3:
- enum **SSAOBlur**:
- - **SSAO_BLUR_DISABLED** = **0**
- - **SSAO_BLUR_1x1** = **1**
- - **SSAO_BLUR_2x2** = **2**
- - **SSAO_BLUR_3x3** = **3**
- ----
- .. _enum_Environment_SSAOQuality:
- .. _class_Environment_constant_SSAO_QUALITY_LOW:
- .. _class_Environment_constant_SSAO_QUALITY_MEDIUM:
- .. _class_Environment_constant_SSAO_QUALITY_HIGH:
- enum **SSAOQuality**:
- - **SSAO_QUALITY_LOW** = **0**
- - **SSAO_QUALITY_MEDIUM** = **1**
- - **SSAO_QUALITY_HIGH** = **2**
- 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
- Tutorials
- ---------
- - :doc:`../tutorials/3d/environment_and_post_processing`
- - :doc:`../tutorials/3d/high_dynamic_range`
- Property Descriptions
- ---------------------
- .. _class_Environment_property_adjustment_brightness:
- - :ref:`float<class_float>` **adjustment_brightness**
- +----------+----------------------------------+
- | *Setter* | set_adjustment_brightness(value) |
- +----------+----------------------------------+
- | *Getter* | get_adjustment_brightness() |
- +----------+----------------------------------+
- Global brightness value of the rendered scene (default value is 1).
- ----
- .. _class_Environment_property_adjustment_color_correction:
- - :ref:`Texture<class_Texture>` **adjustment_color_correction**
- +----------+----------------------------------------+
- | *Setter* | set_adjustment_color_correction(value) |
- +----------+----------------------------------------+
- | *Getter* | get_adjustment_color_correction() |
- +----------+----------------------------------------+
- Applies the provided :ref:`Texture<class_Texture>` resource to affect the global color aspect of the rendered scene.
- ----
- .. _class_Environment_property_adjustment_contrast:
- - :ref:`float<class_float>` **adjustment_contrast**
- +----------+--------------------------------+
- | *Setter* | set_adjustment_contrast(value) |
- +----------+--------------------------------+
- | *Getter* | get_adjustment_contrast() |
- +----------+--------------------------------+
- Global contrast value of the rendered scene (default value is 1).
- ----
- .. _class_Environment_property_adjustment_enabled:
- - :ref:`bool<class_bool>` **adjustment_enabled**
- +----------+------------------------------+
- | *Setter* | set_adjustment_enable(value) |
- +----------+------------------------------+
- | *Getter* | is_adjustment_enabled() |
- +----------+------------------------------+
- Enables the adjustment\_\* options provided by this resource. If ``false``, adjustments modifications will have no effect on the rendered scene.
- ----
- .. _class_Environment_property_adjustment_saturation:
- - :ref:`float<class_float>` **adjustment_saturation**
- +----------+----------------------------------+
- | *Setter* | set_adjustment_saturation(value) |
- +----------+----------------------------------+
- | *Getter* | get_adjustment_saturation() |
- +----------+----------------------------------+
- Global color saturation value of the rendered scene (default value is 1).
- ----
- .. _class_Environment_property_ambient_light_color:
- - :ref:`Color<class_Color>` **ambient_light_color**
- +----------+--------------------------------+
- | *Setter* | set_ambient_light_color(value) |
- +----------+--------------------------------+
- | *Getter* | get_ambient_light_color() |
- +----------+--------------------------------+
- :ref:`Color<class_Color>` of the ambient light.
- ----
- .. _class_Environment_property_ambient_light_energy:
- - :ref:`float<class_float>` **ambient_light_energy**
- +----------+---------------------------------+
- | *Setter* | set_ambient_light_energy(value) |
- +----------+---------------------------------+
- | *Getter* | get_ambient_light_energy() |
- +----------+---------------------------------+
- Energy of the ambient light. The higher the value, the stronger the light.
- ----
- .. _class_Environment_property_ambient_light_sky_contribution:
- - :ref:`float<class_float>` **ambient_light_sky_contribution**
- +----------+-------------------------------------------+
- | *Setter* | set_ambient_light_sky_contribution(value) |
- +----------+-------------------------------------------+
- | *Getter* | get_ambient_light_sky_contribution() |
- +----------+-------------------------------------------+
- Defines the amount of light that the sky brings on the scene. A value of 0 means that the sky's light emission has no effect on the scene illumination, thus all ambient illumination is provided by the ambient light. On the contrary, a value of 1 means that all the light that affects the scene is provided by the sky, thus the ambient light parameter has no effect on the scene.
- ----
- .. _class_Environment_property_auto_exposure_enabled:
- - :ref:`bool<class_bool>` **auto_exposure_enabled**
- +----------+----------------------------------+
- | *Setter* | set_tonemap_auto_exposure(value) |
- +----------+----------------------------------+
- | *Getter* | get_tonemap_auto_exposure() |
- +----------+----------------------------------+
- Enables the tonemapping auto exposure mode of the scene renderer. If activated, the renderer will automatically determine the exposure setting to adapt to the illumination of the scene and the observed light.
- ----
- .. _class_Environment_property_auto_exposure_max_luma:
- - :ref:`float<class_float>` **auto_exposure_max_luma**
- +----------+--------------------------------------+
- | *Setter* | set_tonemap_auto_exposure_max(value) |
- +----------+--------------------------------------+
- | *Getter* | get_tonemap_auto_exposure_max() |
- +----------+--------------------------------------+
- Maximum luminance value for the auto exposure.
- ----
- .. _class_Environment_property_auto_exposure_min_luma:
- - :ref:`float<class_float>` **auto_exposure_min_luma**
- +----------+--------------------------------------+
- | *Setter* | set_tonemap_auto_exposure_min(value) |
- +----------+--------------------------------------+
- | *Getter* | get_tonemap_auto_exposure_min() |
- +----------+--------------------------------------+
- Minimum luminance value for the auto exposure.
- ----
- .. _class_Environment_property_auto_exposure_scale:
- - :ref:`float<class_float>` **auto_exposure_scale**
- +----------+---------------------------------------+
- | *Setter* | set_tonemap_auto_exposure_grey(value) |
- +----------+---------------------------------------+
- | *Getter* | get_tonemap_auto_exposure_grey() |
- +----------+---------------------------------------+
- Scale of the auto exposure effect. Affects the intensity of auto exposure.
- ----
- .. _class_Environment_property_auto_exposure_speed:
- - :ref:`float<class_float>` **auto_exposure_speed**
- +----------+----------------------------------------+
- | *Setter* | set_tonemap_auto_exposure_speed(value) |
- +----------+----------------------------------------+
- | *Getter* | get_tonemap_auto_exposure_speed() |
- +----------+----------------------------------------+
- Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
- ----
- .. _class_Environment_property_background_canvas_max_layer:
- - :ref:`int<class_int>` **background_canvas_max_layer**
- +----------+-----------------------------+
- | *Setter* | set_canvas_max_layer(value) |
- +----------+-----------------------------+
- | *Getter* | get_canvas_max_layer() |
- +----------+-----------------------------+
- Maximum layer id (if using Layer background mode).
- ----
- .. _class_Environment_property_background_color:
- - :ref:`Color<class_Color>` **background_color**
- +----------+---------------------+
- | *Setter* | set_bg_color(value) |
- +----------+---------------------+
- | *Getter* | get_bg_color() |
- +----------+---------------------+
- Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
- ----
- .. _class_Environment_property_background_energy:
- - :ref:`float<class_float>` **background_energy**
- +----------+----------------------+
- | *Setter* | set_bg_energy(value) |
- +----------+----------------------+
- | *Getter* | get_bg_energy() |
- +----------+----------------------+
- Power of light emitted by the background.
- ----
- .. _class_Environment_property_background_mode:
- - :ref:`BGMode<enum_Environment_BGMode>` **background_mode**
- +----------+-----------------------+
- | *Setter* | set_background(value) |
- +----------+-----------------------+
- | *Getter* | get_background() |
- +----------+-----------------------+
- Defines the mode of background.
- ----
- .. _class_Environment_property_background_sky:
- - :ref:`Sky<class_Sky>` **background_sky**
- +----------+----------------+
- | *Setter* | set_sky(value) |
- +----------+----------------+
- | *Getter* | get_sky() |
- +----------+----------------+
- :ref:`Sky<class_Sky>` resource defined as background.
- ----
- .. _class_Environment_property_background_sky_custom_fov:
- - :ref:`float<class_float>` **background_sky_custom_fov**
- +----------+---------------------------+
- | *Setter* | set_sky_custom_fov(value) |
- +----------+---------------------------+
- | *Getter* | get_sky_custom_fov() |
- +----------+---------------------------+
- :ref:`Sky<class_Sky>` resource's custom field of view.
- ----
- .. _class_Environment_property_background_sky_orientation:
- - :ref:`Basis<class_Basis>` **background_sky_orientation**
- +----------+----------------------------+
- | *Setter* | set_sky_orientation(value) |
- +----------+----------------------------+
- | *Getter* | get_sky_orientation() |
- +----------+----------------------------+
- :ref:`Sky<class_Sky>` resource's rotation expressed as a :ref:`Basis<class_Basis>`
- ----
- .. _class_Environment_property_background_sky_rotation:
- - :ref:`Vector3<class_Vector3>` **background_sky_rotation**
- +----------+-------------------------+
- | *Setter* | set_sky_rotation(value) |
- +----------+-------------------------+
- | *Getter* | get_sky_rotation() |
- +----------+-------------------------+
- :ref:`Sky<class_Sky>` resource's rotation expressed as euler angles in radians
- ----
- .. _class_Environment_property_background_sky_rotation_degrees:
- - :ref:`Vector3<class_Vector3>` **background_sky_rotation_degrees**
- +----------+---------------------------------+
- | *Setter* | set_sky_rotation_degrees(value) |
- +----------+---------------------------------+
- | *Getter* | get_sky_rotation_degrees() |
- +----------+---------------------------------+
- :ref:`Sky<class_Sky>` resource's rotation expressed as euler angles in degrees
- ----
- .. _class_Environment_property_dof_blur_far_amount:
- - :ref:`float<class_float>` **dof_blur_far_amount**
- +----------+--------------------------------+
- | *Setter* | set_dof_blur_far_amount(value) |
- +----------+--------------------------------+
- | *Getter* | get_dof_blur_far_amount() |
- +----------+--------------------------------+
- Amount of far blur.
- ----
- .. _class_Environment_property_dof_blur_far_distance:
- - :ref:`float<class_float>` **dof_blur_far_distance**
- +----------+----------------------------------+
- | *Setter* | set_dof_blur_far_distance(value) |
- +----------+----------------------------------+
- | *Getter* | get_dof_blur_far_distance() |
- +----------+----------------------------------+
- Distance from the camera where the far blur effect affects the rendering.
- ----
- .. _class_Environment_property_dof_blur_far_enabled:
- - :ref:`bool<class_bool>` **dof_blur_far_enabled**
- +----------+---------------------------------+
- | *Setter* | set_dof_blur_far_enabled(value) |
- +----------+---------------------------------+
- | *Getter* | is_dof_blur_far_enabled() |
- +----------+---------------------------------+
- Enables the far blur effect.
- ----
- .. _class_Environment_property_dof_blur_far_quality:
- - :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` **dof_blur_far_quality**
- +----------+---------------------------------+
- | *Setter* | set_dof_blur_far_quality(value) |
- +----------+---------------------------------+
- | *Getter* | get_dof_blur_far_quality() |
- +----------+---------------------------------+
- Quality of the far blur quality.
- ----
- .. _class_Environment_property_dof_blur_far_transition:
- - :ref:`float<class_float>` **dof_blur_far_transition**
- +----------+------------------------------------+
- | *Setter* | set_dof_blur_far_transition(value) |
- +----------+------------------------------------+
- | *Getter* | get_dof_blur_far_transition() |
- +----------+------------------------------------+
- Transition between no-blur area and far blur.
- ----
- .. _class_Environment_property_dof_blur_near_amount:
- - :ref:`float<class_float>` **dof_blur_near_amount**
- +----------+---------------------------------+
- | *Setter* | set_dof_blur_near_amount(value) |
- +----------+---------------------------------+
- | *Getter* | get_dof_blur_near_amount() |
- +----------+---------------------------------+
- Amount of near blur.
- ----
- .. _class_Environment_property_dof_blur_near_distance:
- - :ref:`float<class_float>` **dof_blur_near_distance**
- +----------+-----------------------------------+
- | *Setter* | set_dof_blur_near_distance(value) |
- +----------+-----------------------------------+
- | *Getter* | get_dof_blur_near_distance() |
- +----------+-----------------------------------+
- Distance from the camera where the near blur effect affects the rendering.
- ----
- .. _class_Environment_property_dof_blur_near_enabled:
- - :ref:`bool<class_bool>` **dof_blur_near_enabled**
- +----------+----------------------------------+
- | *Setter* | set_dof_blur_near_enabled(value) |
- +----------+----------------------------------+
- | *Getter* | is_dof_blur_near_enabled() |
- +----------+----------------------------------+
- Enables the near blur effect.
- ----
- .. _class_Environment_property_dof_blur_near_quality:
- - :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` **dof_blur_near_quality**
- +----------+----------------------------------+
- | *Setter* | set_dof_blur_near_quality(value) |
- +----------+----------------------------------+
- | *Getter* | get_dof_blur_near_quality() |
- +----------+----------------------------------+
- Quality of the near blur quality.
- ----
- .. _class_Environment_property_dof_blur_near_transition:
- - :ref:`float<class_float>` **dof_blur_near_transition**
- +----------+-------------------------------------+
- | *Setter* | set_dof_blur_near_transition(value) |
- +----------+-------------------------------------+
- | *Getter* | get_dof_blur_near_transition() |
- +----------+-------------------------------------+
- Transition between near blur and no-blur area.
- ----
- .. _class_Environment_property_fog_color:
- - :ref:`Color<class_Color>` **fog_color**
- +----------+----------------------+
- | *Setter* | set_fog_color(value) |
- +----------+----------------------+
- | *Getter* | get_fog_color() |
- +----------+----------------------+
- Fog's :ref:`Color<class_Color>`.
- ----
- .. _class_Environment_property_fog_depth_begin:
- - :ref:`float<class_float>` **fog_depth_begin**
- +----------+----------------------------+
- | *Setter* | set_fog_depth_begin(value) |
- +----------+----------------------------+
- | *Getter* | get_fog_depth_begin() |
- +----------+----------------------------+
- Fog's depth starting distance from the camera.
- ----
- .. _class_Environment_property_fog_depth_curve:
- - :ref:`float<class_float>` **fog_depth_curve**
- +----------+----------------------------+
- | *Setter* | set_fog_depth_curve(value) |
- +----------+----------------------------+
- | *Getter* | get_fog_depth_curve() |
- +----------+----------------------------+
- Value defining the fog depth intensity.
- ----
- .. _class_Environment_property_fog_depth_enabled:
- - :ref:`bool<class_bool>` **fog_depth_enabled**
- +----------+------------------------------+
- | *Setter* | set_fog_depth_enabled(value) |
- +----------+------------------------------+
- | *Getter* | is_fog_depth_enabled() |
- +----------+------------------------------+
- Enables the fog depth.
- ----
- .. _class_Environment_property_fog_depth_end:
- - :ref:`float<class_float>` **fog_depth_end**
- +----------+--------------------------+
- | *Setter* | set_fog_depth_end(value) |
- +----------+--------------------------+
- | *Getter* | get_fog_depth_end() |
- +----------+--------------------------+
- ----
- .. _class_Environment_property_fog_enabled:
- - :ref:`bool<class_bool>` **fog_enabled**
- +----------+------------------------+
- | *Setter* | set_fog_enabled(value) |
- +----------+------------------------+
- | *Getter* | is_fog_enabled() |
- +----------+------------------------+
- Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
- ----
- .. _class_Environment_property_fog_height_curve:
- - :ref:`float<class_float>` **fog_height_curve**
- +----------+-----------------------------+
- | *Setter* | set_fog_height_curve(value) |
- +----------+-----------------------------+
- | *Getter* | get_fog_height_curve() |
- +----------+-----------------------------+
- Value defining the fog height intensity.
- ----
- .. _class_Environment_property_fog_height_enabled:
- - :ref:`bool<class_bool>` **fog_height_enabled**
- +----------+-------------------------------+
- | *Setter* | set_fog_height_enabled(value) |
- +----------+-------------------------------+
- | *Getter* | is_fog_height_enabled() |
- +----------+-------------------------------+
- Enables the fog height.
- ----
- .. _class_Environment_property_fog_height_max:
- - :ref:`float<class_float>` **fog_height_max**
- +----------+---------------------------+
- | *Setter* | set_fog_height_max(value) |
- +----------+---------------------------+
- | *Getter* | get_fog_height_max() |
- +----------+---------------------------+
- Maximum height of fog.
- ----
- .. _class_Environment_property_fog_height_min:
- - :ref:`float<class_float>` **fog_height_min**
- +----------+---------------------------+
- | *Setter* | set_fog_height_min(value) |
- +----------+---------------------------+
- | *Getter* | get_fog_height_min() |
- +----------+---------------------------+
- Minimum height of fog.
- ----
- .. _class_Environment_property_fog_sun_amount:
- - :ref:`float<class_float>` **fog_sun_amount**
- +----------+---------------------------+
- | *Setter* | set_fog_sun_amount(value) |
- +----------+---------------------------+
- | *Getter* | get_fog_sun_amount() |
- +----------+---------------------------+
- Amount of sun that affects the fog rendering.
- ----
- .. _class_Environment_property_fog_sun_color:
- - :ref:`Color<class_Color>` **fog_sun_color**
- +----------+--------------------------+
- | *Setter* | set_fog_sun_color(value) |
- +----------+--------------------------+
- | *Getter* | get_fog_sun_color() |
- +----------+--------------------------+
- Sun :ref:`Color<class_Color>`.
- ----
- .. _class_Environment_property_fog_transmit_curve:
- - :ref:`float<class_float>` **fog_transmit_curve**
- +----------+-------------------------------+
- | *Setter* | set_fog_transmit_curve(value) |
- +----------+-------------------------------+
- | *Getter* | get_fog_transmit_curve() |
- +----------+-------------------------------+
- Amount of light that the fog transmits.
- ----
- .. _class_Environment_property_fog_transmit_enabled:
- - :ref:`bool<class_bool>` **fog_transmit_enabled**
- +----------+---------------------------------+
- | *Setter* | set_fog_transmit_enabled(value) |
- +----------+---------------------------------+
- | *Getter* | is_fog_transmit_enabled() |
- +----------+---------------------------------+
- Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.
- ----
- .. _class_Environment_property_glow_bicubic_upscale:
- - :ref:`bool<class_bool>` **glow_bicubic_upscale**
- +----------+-----------------------------------+
- | *Setter* | set_glow_bicubic_upscale(value) |
- +----------+-----------------------------------+
- | *Getter* | is_glow_bicubic_upscale_enabled() |
- +----------+-----------------------------------+
- ----
- .. _class_Environment_property_glow_blend_mode:
- - :ref:`GlowBlendMode<enum_Environment_GlowBlendMode>` **glow_blend_mode**
- +----------+----------------------------+
- | *Setter* | set_glow_blend_mode(value) |
- +----------+----------------------------+
- | *Getter* | get_glow_blend_mode() |
- +----------+----------------------------+
- Glow blending mode.
- ----
- .. _class_Environment_property_glow_bloom:
- - :ref:`float<class_float>` **glow_bloom**
- +----------+-----------------------+
- | *Setter* | set_glow_bloom(value) |
- +----------+-----------------------+
- | *Getter* | get_glow_bloom() |
- +----------+-----------------------+
- Bloom value (global glow).
- ----
- .. _class_Environment_property_glow_enabled:
- - :ref:`bool<class_bool>` **glow_enabled**
- +----------+-------------------------+
- | *Setter* | set_glow_enabled(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_enabled() |
- +----------+-------------------------+
- Enables glow rendering.
- ----
- .. _class_Environment_property_glow_hdr_luminance_cap:
- - :ref:`float<class_float>` **glow_hdr_luminance_cap**
- +----------+-----------------------------------+
- | *Setter* | set_glow_hdr_luminance_cap(value) |
- +----------+-----------------------------------+
- | *Getter* | get_glow_hdr_luminance_cap() |
- +----------+-----------------------------------+
- ----
- .. _class_Environment_property_glow_hdr_scale:
- - :ref:`float<class_float>` **glow_hdr_scale**
- +----------+---------------------------------+
- | *Setter* | set_glow_hdr_bleed_scale(value) |
- +----------+---------------------------------+
- | *Getter* | get_glow_hdr_bleed_scale() |
- +----------+---------------------------------+
- Bleed scale of the HDR glow.
- ----
- .. _class_Environment_property_glow_hdr_threshold:
- - :ref:`float<class_float>` **glow_hdr_threshold**
- +----------+-------------------------------------+
- | *Setter* | set_glow_hdr_bleed_threshold(value) |
- +----------+-------------------------------------+
- | *Getter* | get_glow_hdr_bleed_threshold() |
- +----------+-------------------------------------+
- Bleed threshold of the HDR glow.
- ----
- .. _class_Environment_property_glow_intensity:
- - :ref:`float<class_float>` **glow_intensity**
- +----------+---------------------------+
- | *Setter* | set_glow_intensity(value) |
- +----------+---------------------------+
- | *Getter* | get_glow_intensity() |
- +----------+---------------------------+
- Glow intensity.
- ----
- .. _class_Environment_property_glow_levels/1:
- - :ref:`bool<class_bool>` **glow_levels/1**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- First level of glow (most local).
- ----
- .. _class_Environment_property_glow_levels/2:
- - :ref:`bool<class_bool>` **glow_levels/2**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- Second level of glow.
- ----
- .. _class_Environment_property_glow_levels/3:
- - :ref:`bool<class_bool>` **glow_levels/3**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- Third level of glow.
- ----
- .. _class_Environment_property_glow_levels/4:
- - :ref:`bool<class_bool>` **glow_levels/4**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- Fourth level of glow.
- ----
- .. _class_Environment_property_glow_levels/5:
- - :ref:`bool<class_bool>` **glow_levels/5**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- Fifth level of glow.
- ----
- .. _class_Environment_property_glow_levels/6:
- - :ref:`bool<class_bool>` **glow_levels/6**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- Sixth level of glow.
- ----
- .. _class_Environment_property_glow_levels/7:
- - :ref:`bool<class_bool>` **glow_levels/7**
- +----------+-------------------------+
- | *Setter* | set_glow_level(value) |
- +----------+-------------------------+
- | *Getter* | is_glow_level_enabled() |
- +----------+-------------------------+
- Seventh level of glow (most global).
- ----
- .. _class_Environment_property_glow_strength:
- - :ref:`float<class_float>` **glow_strength**
- +----------+--------------------------+
- | *Setter* | set_glow_strength(value) |
- +----------+--------------------------+
- | *Getter* | get_glow_strength() |
- +----------+--------------------------+
- Glow strength.
- ----
- .. _class_Environment_property_ss_reflections_depth_tolerance:
- - :ref:`float<class_float>` **ss_reflections_depth_tolerance**
- +----------+--------------------------------+
- | *Setter* | set_ssr_depth_tolerance(value) |
- +----------+--------------------------------+
- | *Getter* | get_ssr_depth_tolerance() |
- +----------+--------------------------------+
- ----
- .. _class_Environment_property_ss_reflections_enabled:
- - :ref:`bool<class_bool>` **ss_reflections_enabled**
- +----------+------------------------+
- | *Setter* | set_ssr_enabled(value) |
- +----------+------------------------+
- | *Getter* | is_ssr_enabled() |
- +----------+------------------------+
- ----
- .. _class_Environment_property_ss_reflections_fade_in:
- - :ref:`float<class_float>` **ss_reflections_fade_in**
- +----------+------------------------+
- | *Setter* | set_ssr_fade_in(value) |
- +----------+------------------------+
- | *Getter* | get_ssr_fade_in() |
- +----------+------------------------+
- ----
- .. _class_Environment_property_ss_reflections_fade_out:
- - :ref:`float<class_float>` **ss_reflections_fade_out**
- +----------+-------------------------+
- | *Setter* | set_ssr_fade_out(value) |
- +----------+-------------------------+
- | *Getter* | get_ssr_fade_out() |
- +----------+-------------------------+
- ----
- .. _class_Environment_property_ss_reflections_max_steps:
- - :ref:`int<class_int>` **ss_reflections_max_steps**
- +----------+--------------------------+
- | *Setter* | set_ssr_max_steps(value) |
- +----------+--------------------------+
- | *Getter* | get_ssr_max_steps() |
- +----------+--------------------------+
- ----
- .. _class_Environment_property_ss_reflections_roughness:
- - :ref:`bool<class_bool>` **ss_reflections_roughness**
- +----------+----------------------+
- | *Setter* | set_ssr_rough(value) |
- +----------+----------------------+
- | *Getter* | is_ssr_rough() |
- +----------+----------------------+
- ----
- .. _class_Environment_property_ssao_ao_channel_affect:
- - :ref:`float<class_float>` **ssao_ao_channel_affect**
- +----------+-----------------------------------+
- | *Setter* | set_ssao_ao_channel_affect(value) |
- +----------+-----------------------------------+
- | *Getter* | get_ssao_ao_channel_affect() |
- +----------+-----------------------------------+
- ----
- .. _class_Environment_property_ssao_bias:
- - :ref:`float<class_float>` **ssao_bias**
- +----------+----------------------+
- | *Setter* | set_ssao_bias(value) |
- +----------+----------------------+
- | *Getter* | get_ssao_bias() |
- +----------+----------------------+
- ----
- .. _class_Environment_property_ssao_blur:
- - :ref:`SSAOBlur<enum_Environment_SSAOBlur>` **ssao_blur**
- +----------+----------------------+
- | *Setter* | set_ssao_blur(value) |
- +----------+----------------------+
- | *Getter* | get_ssao_blur() |
- +----------+----------------------+
- ----
- .. _class_Environment_property_ssao_color:
- - :ref:`Color<class_Color>` **ssao_color**
- +----------+-----------------------+
- | *Setter* | set_ssao_color(value) |
- +----------+-----------------------+
- | *Getter* | get_ssao_color() |
- +----------+-----------------------+
- ----
- .. _class_Environment_property_ssao_edge_sharpness:
- - :ref:`float<class_float>` **ssao_edge_sharpness**
- +----------+--------------------------------+
- | *Setter* | set_ssao_edge_sharpness(value) |
- +----------+--------------------------------+
- | *Getter* | get_ssao_edge_sharpness() |
- +----------+--------------------------------+
- ----
- .. _class_Environment_property_ssao_enabled:
- - :ref:`bool<class_bool>` **ssao_enabled**
- +----------+-------------------------+
- | *Setter* | set_ssao_enabled(value) |
- +----------+-------------------------+
- | *Getter* | is_ssao_enabled() |
- +----------+-------------------------+
- ----
- .. _class_Environment_property_ssao_intensity:
- - :ref:`float<class_float>` **ssao_intensity**
- +----------+---------------------------+
- | *Setter* | set_ssao_intensity(value) |
- +----------+---------------------------+
- | *Getter* | get_ssao_intensity() |
- +----------+---------------------------+
- ----
- .. _class_Environment_property_ssao_intensity2:
- - :ref:`float<class_float>` **ssao_intensity2**
- +----------+----------------------------+
- | *Setter* | set_ssao_intensity2(value) |
- +----------+----------------------------+
- | *Getter* | get_ssao_intensity2() |
- +----------+----------------------------+
- ----
- .. _class_Environment_property_ssao_light_affect:
- - :ref:`float<class_float>` **ssao_light_affect**
- +----------+-------------------------------------+
- | *Setter* | set_ssao_direct_light_affect(value) |
- +----------+-------------------------------------+
- | *Getter* | get_ssao_direct_light_affect() |
- +----------+-------------------------------------+
- ----
- .. _class_Environment_property_ssao_quality:
- - :ref:`SSAOQuality<enum_Environment_SSAOQuality>` **ssao_quality**
- +----------+-------------------------+
- | *Setter* | set_ssao_quality(value) |
- +----------+-------------------------+
- | *Getter* | get_ssao_quality() |
- +----------+-------------------------+
- ----
- .. _class_Environment_property_ssao_radius:
- - :ref:`float<class_float>` **ssao_radius**
- +----------+------------------------+
- | *Setter* | set_ssao_radius(value) |
- +----------+------------------------+
- | *Getter* | get_ssao_radius() |
- +----------+------------------------+
- ----
- .. _class_Environment_property_ssao_radius2:
- - :ref:`float<class_float>` **ssao_radius2**
- +----------+-------------------------+
- | *Setter* | set_ssao_radius2(value) |
- +----------+-------------------------+
- | *Getter* | get_ssao_radius2() |
- +----------+-------------------------+
- ----
- .. _class_Environment_property_tonemap_exposure:
- - :ref:`float<class_float>` **tonemap_exposure**
- +----------+-----------------------------+
- | *Setter* | set_tonemap_exposure(value) |
- +----------+-----------------------------+
- | *Getter* | get_tonemap_exposure() |
- +----------+-----------------------------+
- Default exposure for tonemap.
- ----
- .. _class_Environment_property_tonemap_mode:
- - :ref:`ToneMapper<enum_Environment_ToneMapper>` **tonemap_mode**
- +----------+-----------------------+
- | *Setter* | set_tonemapper(value) |
- +----------+-----------------------+
- | *Getter* | get_tonemapper() |
- +----------+-----------------------+
- Tonemapping mode.
- ----
- .. _class_Environment_property_tonemap_white:
- - :ref:`float<class_float>` **tonemap_white**
- +----------+--------------------------+
- | *Setter* | set_tonemap_white(value) |
- +----------+--------------------------+
- | *Getter* | get_tonemap_white() |
- +----------+--------------------------+
- White reference value for tonemap.
|