class_environment.rst 61 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Environment.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Environment:
  6. Environment
  7. ===========
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Resource for environment nodes (like :ref:`WorldEnvironment<class_WorldEnvironment>`) that define multiple rendering options.
  13. Properties
  14. ----------
  15. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  16. | :ref:`float<class_float>` | :ref:`adjustment_brightness<class_Environment_property_adjustment_brightness>` |
  17. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  18. | :ref:`Texture<class_Texture>` | :ref:`adjustment_color_correction<class_Environment_property_adjustment_color_correction>` |
  19. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`adjustment_contrast<class_Environment_property_adjustment_contrast>` |
  21. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`adjustment_enabled<class_Environment_property_adjustment_enabled>` |
  23. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  24. | :ref:`float<class_float>` | :ref:`adjustment_saturation<class_Environment_property_adjustment_saturation>` |
  25. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  26. | :ref:`Color<class_Color>` | :ref:`ambient_light_color<class_Environment_property_ambient_light_color>` |
  27. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  28. | :ref:`float<class_float>` | :ref:`ambient_light_energy<class_Environment_property_ambient_light_energy>` |
  29. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  30. | :ref:`float<class_float>` | :ref:`ambient_light_sky_contribution<class_Environment_property_ambient_light_sky_contribution>` |
  31. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  32. | :ref:`bool<class_bool>` | :ref:`auto_exposure_enabled<class_Environment_property_auto_exposure_enabled>` |
  33. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  34. | :ref:`float<class_float>` | :ref:`auto_exposure_max_luma<class_Environment_property_auto_exposure_max_luma>` |
  35. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  36. | :ref:`float<class_float>` | :ref:`auto_exposure_min_luma<class_Environment_property_auto_exposure_min_luma>` |
  37. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  38. | :ref:`float<class_float>` | :ref:`auto_exposure_scale<class_Environment_property_auto_exposure_scale>` |
  39. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  40. | :ref:`float<class_float>` | :ref:`auto_exposure_speed<class_Environment_property_auto_exposure_speed>` |
  41. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  42. | :ref:`int<class_int>` | :ref:`background_canvas_max_layer<class_Environment_property_background_canvas_max_layer>` |
  43. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  44. | :ref:`Color<class_Color>` | :ref:`background_color<class_Environment_property_background_color>` |
  45. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  46. | :ref:`float<class_float>` | :ref:`background_energy<class_Environment_property_background_energy>` |
  47. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  48. | :ref:`BGMode<enum_Environment_BGMode>` | :ref:`background_mode<class_Environment_property_background_mode>` |
  49. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  50. | :ref:`Sky<class_Sky>` | :ref:`background_sky<class_Environment_property_background_sky>` |
  51. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  52. | :ref:`float<class_float>` | :ref:`background_sky_custom_fov<class_Environment_property_background_sky_custom_fov>` |
  53. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  54. | :ref:`Basis<class_Basis>` | :ref:`background_sky_orientation<class_Environment_property_background_sky_orientation>` |
  55. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  56. | :ref:`Vector3<class_Vector3>` | :ref:`background_sky_rotation<class_Environment_property_background_sky_rotation>` |
  57. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  58. | :ref:`Vector3<class_Vector3>` | :ref:`background_sky_rotation_degrees<class_Environment_property_background_sky_rotation_degrees>` |
  59. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  60. | :ref:`float<class_float>` | :ref:`dof_blur_far_amount<class_Environment_property_dof_blur_far_amount>` |
  61. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`dof_blur_far_distance<class_Environment_property_dof_blur_far_distance>` |
  63. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`dof_blur_far_enabled<class_Environment_property_dof_blur_far_enabled>` |
  65. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  66. | :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` | :ref:`dof_blur_far_quality<class_Environment_property_dof_blur_far_quality>` |
  67. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  68. | :ref:`float<class_float>` | :ref:`dof_blur_far_transition<class_Environment_property_dof_blur_far_transition>` |
  69. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  70. | :ref:`float<class_float>` | :ref:`dof_blur_near_amount<class_Environment_property_dof_blur_near_amount>` |
  71. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  72. | :ref:`float<class_float>` | :ref:`dof_blur_near_distance<class_Environment_property_dof_blur_near_distance>` |
  73. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  74. | :ref:`bool<class_bool>` | :ref:`dof_blur_near_enabled<class_Environment_property_dof_blur_near_enabled>` |
  75. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  76. | :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` | :ref:`dof_blur_near_quality<class_Environment_property_dof_blur_near_quality>` |
  77. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  78. | :ref:`float<class_float>` | :ref:`dof_blur_near_transition<class_Environment_property_dof_blur_near_transition>` |
  79. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  80. | :ref:`Color<class_Color>` | :ref:`fog_color<class_Environment_property_fog_color>` |
  81. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  82. | :ref:`float<class_float>` | :ref:`fog_depth_begin<class_Environment_property_fog_depth_begin>` |
  83. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  84. | :ref:`float<class_float>` | :ref:`fog_depth_curve<class_Environment_property_fog_depth_curve>` |
  85. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  86. | :ref:`bool<class_bool>` | :ref:`fog_depth_enabled<class_Environment_property_fog_depth_enabled>` |
  87. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  88. | :ref:`float<class_float>` | :ref:`fog_depth_end<class_Environment_property_fog_depth_end>` |
  89. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  90. | :ref:`bool<class_bool>` | :ref:`fog_enabled<class_Environment_property_fog_enabled>` |
  91. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  92. | :ref:`float<class_float>` | :ref:`fog_height_curve<class_Environment_property_fog_height_curve>` |
  93. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  94. | :ref:`bool<class_bool>` | :ref:`fog_height_enabled<class_Environment_property_fog_height_enabled>` |
  95. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  96. | :ref:`float<class_float>` | :ref:`fog_height_max<class_Environment_property_fog_height_max>` |
  97. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  98. | :ref:`float<class_float>` | :ref:`fog_height_min<class_Environment_property_fog_height_min>` |
  99. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  100. | :ref:`float<class_float>` | :ref:`fog_sun_amount<class_Environment_property_fog_sun_amount>` |
  101. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  102. | :ref:`Color<class_Color>` | :ref:`fog_sun_color<class_Environment_property_fog_sun_color>` |
  103. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  104. | :ref:`float<class_float>` | :ref:`fog_transmit_curve<class_Environment_property_fog_transmit_curve>` |
  105. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  106. | :ref:`bool<class_bool>` | :ref:`fog_transmit_enabled<class_Environment_property_fog_transmit_enabled>` |
  107. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  108. | :ref:`bool<class_bool>` | :ref:`glow_bicubic_upscale<class_Environment_property_glow_bicubic_upscale>` |
  109. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  110. | :ref:`GlowBlendMode<enum_Environment_GlowBlendMode>` | :ref:`glow_blend_mode<class_Environment_property_glow_blend_mode>` |
  111. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  112. | :ref:`float<class_float>` | :ref:`glow_bloom<class_Environment_property_glow_bloom>` |
  113. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  114. | :ref:`bool<class_bool>` | :ref:`glow_enabled<class_Environment_property_glow_enabled>` |
  115. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  116. | :ref:`float<class_float>` | :ref:`glow_hdr_luminance_cap<class_Environment_property_glow_hdr_luminance_cap>` |
  117. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  118. | :ref:`float<class_float>` | :ref:`glow_hdr_scale<class_Environment_property_glow_hdr_scale>` |
  119. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  120. | :ref:`float<class_float>` | :ref:`glow_hdr_threshold<class_Environment_property_glow_hdr_threshold>` |
  121. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  122. | :ref:`float<class_float>` | :ref:`glow_intensity<class_Environment_property_glow_intensity>` |
  123. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  124. | :ref:`bool<class_bool>` | :ref:`glow_levels/1<class_Environment_property_glow_levels/1>` |
  125. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  126. | :ref:`bool<class_bool>` | :ref:`glow_levels/2<class_Environment_property_glow_levels/2>` |
  127. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  128. | :ref:`bool<class_bool>` | :ref:`glow_levels/3<class_Environment_property_glow_levels/3>` |
  129. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  130. | :ref:`bool<class_bool>` | :ref:`glow_levels/4<class_Environment_property_glow_levels/4>` |
  131. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  132. | :ref:`bool<class_bool>` | :ref:`glow_levels/5<class_Environment_property_glow_levels/5>` |
  133. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  134. | :ref:`bool<class_bool>` | :ref:`glow_levels/6<class_Environment_property_glow_levels/6>` |
  135. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  136. | :ref:`bool<class_bool>` | :ref:`glow_levels/7<class_Environment_property_glow_levels/7>` |
  137. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  138. | :ref:`float<class_float>` | :ref:`glow_strength<class_Environment_property_glow_strength>` |
  139. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  140. | :ref:`float<class_float>` | :ref:`ss_reflections_depth_tolerance<class_Environment_property_ss_reflections_depth_tolerance>` |
  141. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  142. | :ref:`bool<class_bool>` | :ref:`ss_reflections_enabled<class_Environment_property_ss_reflections_enabled>` |
  143. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  144. | :ref:`float<class_float>` | :ref:`ss_reflections_fade_in<class_Environment_property_ss_reflections_fade_in>` |
  145. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  146. | :ref:`float<class_float>` | :ref:`ss_reflections_fade_out<class_Environment_property_ss_reflections_fade_out>` |
  147. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  148. | :ref:`int<class_int>` | :ref:`ss_reflections_max_steps<class_Environment_property_ss_reflections_max_steps>` |
  149. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  150. | :ref:`bool<class_bool>` | :ref:`ss_reflections_roughness<class_Environment_property_ss_reflections_roughness>` |
  151. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  152. | :ref:`float<class_float>` | :ref:`ssao_ao_channel_affect<class_Environment_property_ssao_ao_channel_affect>` |
  153. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  154. | :ref:`float<class_float>` | :ref:`ssao_bias<class_Environment_property_ssao_bias>` |
  155. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  156. | :ref:`SSAOBlur<enum_Environment_SSAOBlur>` | :ref:`ssao_blur<class_Environment_property_ssao_blur>` |
  157. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  158. | :ref:`Color<class_Color>` | :ref:`ssao_color<class_Environment_property_ssao_color>` |
  159. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  160. | :ref:`float<class_float>` | :ref:`ssao_edge_sharpness<class_Environment_property_ssao_edge_sharpness>` |
  161. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  162. | :ref:`bool<class_bool>` | :ref:`ssao_enabled<class_Environment_property_ssao_enabled>` |
  163. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  164. | :ref:`float<class_float>` | :ref:`ssao_intensity<class_Environment_property_ssao_intensity>` |
  165. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  166. | :ref:`float<class_float>` | :ref:`ssao_intensity2<class_Environment_property_ssao_intensity2>` |
  167. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  168. | :ref:`float<class_float>` | :ref:`ssao_light_affect<class_Environment_property_ssao_light_affect>` |
  169. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  170. | :ref:`SSAOQuality<enum_Environment_SSAOQuality>` | :ref:`ssao_quality<class_Environment_property_ssao_quality>` |
  171. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  172. | :ref:`float<class_float>` | :ref:`ssao_radius<class_Environment_property_ssao_radius>` |
  173. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  174. | :ref:`float<class_float>` | :ref:`ssao_radius2<class_Environment_property_ssao_radius2>` |
  175. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  176. | :ref:`float<class_float>` | :ref:`tonemap_exposure<class_Environment_property_tonemap_exposure>` |
  177. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  178. | :ref:`ToneMapper<enum_Environment_ToneMapper>` | :ref:`tonemap_mode<class_Environment_property_tonemap_mode>` |
  179. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  180. | :ref:`float<class_float>` | :ref:`tonemap_white<class_Environment_property_tonemap_white>` |
  181. +--------------------------------------------------------+----------------------------------------------------------------------------------------------------+
  182. Enumerations
  183. ------------
  184. .. _enum_Environment_BGMode:
  185. .. _class_Environment_constant_BG_KEEP:
  186. .. _class_Environment_constant_BG_CLEAR_COLOR:
  187. .. _class_Environment_constant_BG_COLOR:
  188. .. _class_Environment_constant_BG_SKY:
  189. .. _class_Environment_constant_BG_COLOR_SKY:
  190. .. _class_Environment_constant_BG_CANVAS:
  191. .. _class_Environment_constant_BG_MAX:
  192. enum **BGMode**:
  193. - **BG_KEEP** = **5** --- Keep on screen every pixel drawn in the background.
  194. - **BG_CLEAR_COLOR** = **0** --- Clear the background using the project's clear color.
  195. - **BG_COLOR** = **1** --- Clear the background using a custom clear color.
  196. - **BG_SKY** = **2** --- Display a user-defined sky in the background.
  197. - **BG_COLOR_SKY** = **3** --- Clear the background using a custom clear color and allows defining a sky for shading and reflection.
  198. - **BG_CANVAS** = **4** --- Display a :ref:`CanvasLayer<class_CanvasLayer>` in the background.
  199. - **BG_MAX** = **6** --- Represents the size of the :ref:`BGMode<enum_Environment_BGMode>` enum.
  200. ----
  201. .. _enum_Environment_GlowBlendMode:
  202. .. _class_Environment_constant_GLOW_BLEND_MODE_ADDITIVE:
  203. .. _class_Environment_constant_GLOW_BLEND_MODE_SCREEN:
  204. .. _class_Environment_constant_GLOW_BLEND_MODE_SOFTLIGHT:
  205. .. _class_Environment_constant_GLOW_BLEND_MODE_REPLACE:
  206. enum **GlowBlendMode**:
  207. - **GLOW_BLEND_MODE_ADDITIVE** = **0** --- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
  208. - **GLOW_BLEND_MODE_SCREEN** = **1** --- Screen glow blending mode. Increases brightness, used frequently with bloom.
  209. - **GLOW_BLEND_MODE_SOFTLIGHT** = **2** --- Softlight glow blending mode. Modifies contrast, exposes shadows and highlights, vivid bloom.
  210. - **GLOW_BLEND_MODE_REPLACE** = **3** --- Replace glow blending mode. Replaces all pixels' color by the glow value.
  211. ----
  212. .. _enum_Environment_ToneMapper:
  213. .. _class_Environment_constant_TONE_MAPPER_LINEAR:
  214. .. _class_Environment_constant_TONE_MAPPER_REINHARDT:
  215. .. _class_Environment_constant_TONE_MAPPER_FILMIC:
  216. .. _class_Environment_constant_TONE_MAPPER_ACES:
  217. enum **ToneMapper**:
  218. - **TONE_MAPPER_LINEAR** = **0** --- Linear tonemapper operator. Reads the linear data and performs an exposure adjustment.
  219. - **TONE_MAPPER_REINHARDT** = **1** --- Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: color = color / (1 + color).
  220. - **TONE_MAPPER_FILMIC** = **2** --- Filmic tonemapper operator.
  221. - **TONE_MAPPER_ACES** = **3** --- Academy Color Encoding System tonemapper operator.
  222. ----
  223. .. _enum_Environment_DOFBlurQuality:
  224. .. _class_Environment_constant_DOF_BLUR_QUALITY_LOW:
  225. .. _class_Environment_constant_DOF_BLUR_QUALITY_MEDIUM:
  226. .. _class_Environment_constant_DOF_BLUR_QUALITY_HIGH:
  227. enum **DOFBlurQuality**:
  228. - **DOF_BLUR_QUALITY_LOW** = **0** --- Low depth-of-field blur quality.
  229. - **DOF_BLUR_QUALITY_MEDIUM** = **1** --- Medium depth-of-field blur quality.
  230. - **DOF_BLUR_QUALITY_HIGH** = **2** --- High depth-of-field blur quality.
  231. ----
  232. .. _enum_Environment_SSAOBlur:
  233. .. _class_Environment_constant_SSAO_BLUR_DISABLED:
  234. .. _class_Environment_constant_SSAO_BLUR_1x1:
  235. .. _class_Environment_constant_SSAO_BLUR_2x2:
  236. .. _class_Environment_constant_SSAO_BLUR_3x3:
  237. enum **SSAOBlur**:
  238. - **SSAO_BLUR_DISABLED** = **0**
  239. - **SSAO_BLUR_1x1** = **1**
  240. - **SSAO_BLUR_2x2** = **2**
  241. - **SSAO_BLUR_3x3** = **3**
  242. ----
  243. .. _enum_Environment_SSAOQuality:
  244. .. _class_Environment_constant_SSAO_QUALITY_LOW:
  245. .. _class_Environment_constant_SSAO_QUALITY_MEDIUM:
  246. .. _class_Environment_constant_SSAO_QUALITY_HIGH:
  247. enum **SSAOQuality**:
  248. - **SSAO_QUALITY_LOW** = **0**
  249. - **SSAO_QUALITY_MEDIUM** = **1**
  250. - **SSAO_QUALITY_HIGH** = **2**
  251. Description
  252. -----------
  253. 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:
  254. - DOF Blur
  255. - Motion Blur
  256. - Bloom
  257. - Tonemap (auto exposure)
  258. - Adjustments
  259. Tutorials
  260. ---------
  261. - :doc:`../tutorials/3d/environment_and_post_processing`
  262. - :doc:`../tutorials/3d/high_dynamic_range`
  263. Property Descriptions
  264. ---------------------
  265. .. _class_Environment_property_adjustment_brightness:
  266. - :ref:`float<class_float>` **adjustment_brightness**
  267. +----------+----------------------------------+
  268. | *Setter* | set_adjustment_brightness(value) |
  269. +----------+----------------------------------+
  270. | *Getter* | get_adjustment_brightness() |
  271. +----------+----------------------------------+
  272. Global brightness value of the rendered scene (default value is 1).
  273. ----
  274. .. _class_Environment_property_adjustment_color_correction:
  275. - :ref:`Texture<class_Texture>` **adjustment_color_correction**
  276. +----------+----------------------------------------+
  277. | *Setter* | set_adjustment_color_correction(value) |
  278. +----------+----------------------------------------+
  279. | *Getter* | get_adjustment_color_correction() |
  280. +----------+----------------------------------------+
  281. Applies the provided :ref:`Texture<class_Texture>` resource to affect the global color aspect of the rendered scene.
  282. ----
  283. .. _class_Environment_property_adjustment_contrast:
  284. - :ref:`float<class_float>` **adjustment_contrast**
  285. +----------+--------------------------------+
  286. | *Setter* | set_adjustment_contrast(value) |
  287. +----------+--------------------------------+
  288. | *Getter* | get_adjustment_contrast() |
  289. +----------+--------------------------------+
  290. Global contrast value of the rendered scene (default value is 1).
  291. ----
  292. .. _class_Environment_property_adjustment_enabled:
  293. - :ref:`bool<class_bool>` **adjustment_enabled**
  294. +----------+------------------------------+
  295. | *Setter* | set_adjustment_enable(value) |
  296. +----------+------------------------------+
  297. | *Getter* | is_adjustment_enabled() |
  298. +----------+------------------------------+
  299. Enables the adjustment\_\* options provided by this resource. If ``false``, adjustments modifications will have no effect on the rendered scene.
  300. ----
  301. .. _class_Environment_property_adjustment_saturation:
  302. - :ref:`float<class_float>` **adjustment_saturation**
  303. +----------+----------------------------------+
  304. | *Setter* | set_adjustment_saturation(value) |
  305. +----------+----------------------------------+
  306. | *Getter* | get_adjustment_saturation() |
  307. +----------+----------------------------------+
  308. Global color saturation value of the rendered scene (default value is 1).
  309. ----
  310. .. _class_Environment_property_ambient_light_color:
  311. - :ref:`Color<class_Color>` **ambient_light_color**
  312. +----------+--------------------------------+
  313. | *Setter* | set_ambient_light_color(value) |
  314. +----------+--------------------------------+
  315. | *Getter* | get_ambient_light_color() |
  316. +----------+--------------------------------+
  317. :ref:`Color<class_Color>` of the ambient light.
  318. ----
  319. .. _class_Environment_property_ambient_light_energy:
  320. - :ref:`float<class_float>` **ambient_light_energy**
  321. +----------+---------------------------------+
  322. | *Setter* | set_ambient_light_energy(value) |
  323. +----------+---------------------------------+
  324. | *Getter* | get_ambient_light_energy() |
  325. +----------+---------------------------------+
  326. Energy of the ambient light. The higher the value, the stronger the light.
  327. ----
  328. .. _class_Environment_property_ambient_light_sky_contribution:
  329. - :ref:`float<class_float>` **ambient_light_sky_contribution**
  330. +----------+-------------------------------------------+
  331. | *Setter* | set_ambient_light_sky_contribution(value) |
  332. +----------+-------------------------------------------+
  333. | *Getter* | get_ambient_light_sky_contribution() |
  334. +----------+-------------------------------------------+
  335. 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.
  336. ----
  337. .. _class_Environment_property_auto_exposure_enabled:
  338. - :ref:`bool<class_bool>` **auto_exposure_enabled**
  339. +----------+----------------------------------+
  340. | *Setter* | set_tonemap_auto_exposure(value) |
  341. +----------+----------------------------------+
  342. | *Getter* | get_tonemap_auto_exposure() |
  343. +----------+----------------------------------+
  344. 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.
  345. ----
  346. .. _class_Environment_property_auto_exposure_max_luma:
  347. - :ref:`float<class_float>` **auto_exposure_max_luma**
  348. +----------+--------------------------------------+
  349. | *Setter* | set_tonemap_auto_exposure_max(value) |
  350. +----------+--------------------------------------+
  351. | *Getter* | get_tonemap_auto_exposure_max() |
  352. +----------+--------------------------------------+
  353. Maximum luminance value for the auto exposure.
  354. ----
  355. .. _class_Environment_property_auto_exposure_min_luma:
  356. - :ref:`float<class_float>` **auto_exposure_min_luma**
  357. +----------+--------------------------------------+
  358. | *Setter* | set_tonemap_auto_exposure_min(value) |
  359. +----------+--------------------------------------+
  360. | *Getter* | get_tonemap_auto_exposure_min() |
  361. +----------+--------------------------------------+
  362. Minimum luminance value for the auto exposure.
  363. ----
  364. .. _class_Environment_property_auto_exposure_scale:
  365. - :ref:`float<class_float>` **auto_exposure_scale**
  366. +----------+---------------------------------------+
  367. | *Setter* | set_tonemap_auto_exposure_grey(value) |
  368. +----------+---------------------------------------+
  369. | *Getter* | get_tonemap_auto_exposure_grey() |
  370. +----------+---------------------------------------+
  371. Scale of the auto exposure effect. Affects the intensity of auto exposure.
  372. ----
  373. .. _class_Environment_property_auto_exposure_speed:
  374. - :ref:`float<class_float>` **auto_exposure_speed**
  375. +----------+----------------------------------------+
  376. | *Setter* | set_tonemap_auto_exposure_speed(value) |
  377. +----------+----------------------------------------+
  378. | *Getter* | get_tonemap_auto_exposure_speed() |
  379. +----------+----------------------------------------+
  380. Speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure.
  381. ----
  382. .. _class_Environment_property_background_canvas_max_layer:
  383. - :ref:`int<class_int>` **background_canvas_max_layer**
  384. +----------+-----------------------------+
  385. | *Setter* | set_canvas_max_layer(value) |
  386. +----------+-----------------------------+
  387. | *Getter* | get_canvas_max_layer() |
  388. +----------+-----------------------------+
  389. Maximum layer id (if using Layer background mode).
  390. ----
  391. .. _class_Environment_property_background_color:
  392. - :ref:`Color<class_Color>` **background_color**
  393. +----------+---------------------+
  394. | *Setter* | set_bg_color(value) |
  395. +----------+---------------------+
  396. | *Getter* | get_bg_color() |
  397. +----------+---------------------+
  398. Color displayed for clear areas of the scene (if using Custom color or Color+Sky background modes).
  399. ----
  400. .. _class_Environment_property_background_energy:
  401. - :ref:`float<class_float>` **background_energy**
  402. +----------+----------------------+
  403. | *Setter* | set_bg_energy(value) |
  404. +----------+----------------------+
  405. | *Getter* | get_bg_energy() |
  406. +----------+----------------------+
  407. Power of light emitted by the background.
  408. ----
  409. .. _class_Environment_property_background_mode:
  410. - :ref:`BGMode<enum_Environment_BGMode>` **background_mode**
  411. +----------+-----------------------+
  412. | *Setter* | set_background(value) |
  413. +----------+-----------------------+
  414. | *Getter* | get_background() |
  415. +----------+-----------------------+
  416. Defines the mode of background.
  417. ----
  418. .. _class_Environment_property_background_sky:
  419. - :ref:`Sky<class_Sky>` **background_sky**
  420. +----------+----------------+
  421. | *Setter* | set_sky(value) |
  422. +----------+----------------+
  423. | *Getter* | get_sky() |
  424. +----------+----------------+
  425. :ref:`Sky<class_Sky>` resource defined as background.
  426. ----
  427. .. _class_Environment_property_background_sky_custom_fov:
  428. - :ref:`float<class_float>` **background_sky_custom_fov**
  429. +----------+---------------------------+
  430. | *Setter* | set_sky_custom_fov(value) |
  431. +----------+---------------------------+
  432. | *Getter* | get_sky_custom_fov() |
  433. +----------+---------------------------+
  434. :ref:`Sky<class_Sky>` resource's custom field of view.
  435. ----
  436. .. _class_Environment_property_background_sky_orientation:
  437. - :ref:`Basis<class_Basis>` **background_sky_orientation**
  438. +----------+----------------------------+
  439. | *Setter* | set_sky_orientation(value) |
  440. +----------+----------------------------+
  441. | *Getter* | get_sky_orientation() |
  442. +----------+----------------------------+
  443. :ref:`Sky<class_Sky>` resource's rotation expressed as a :ref:`Basis<class_Basis>`
  444. ----
  445. .. _class_Environment_property_background_sky_rotation:
  446. - :ref:`Vector3<class_Vector3>` **background_sky_rotation**
  447. +----------+-------------------------+
  448. | *Setter* | set_sky_rotation(value) |
  449. +----------+-------------------------+
  450. | *Getter* | get_sky_rotation() |
  451. +----------+-------------------------+
  452. :ref:`Sky<class_Sky>` resource's rotation expressed as euler angles in radians
  453. ----
  454. .. _class_Environment_property_background_sky_rotation_degrees:
  455. - :ref:`Vector3<class_Vector3>` **background_sky_rotation_degrees**
  456. +----------+---------------------------------+
  457. | *Setter* | set_sky_rotation_degrees(value) |
  458. +----------+---------------------------------+
  459. | *Getter* | get_sky_rotation_degrees() |
  460. +----------+---------------------------------+
  461. :ref:`Sky<class_Sky>` resource's rotation expressed as euler angles in degrees
  462. ----
  463. .. _class_Environment_property_dof_blur_far_amount:
  464. - :ref:`float<class_float>` **dof_blur_far_amount**
  465. +----------+--------------------------------+
  466. | *Setter* | set_dof_blur_far_amount(value) |
  467. +----------+--------------------------------+
  468. | *Getter* | get_dof_blur_far_amount() |
  469. +----------+--------------------------------+
  470. Amount of far blur.
  471. ----
  472. .. _class_Environment_property_dof_blur_far_distance:
  473. - :ref:`float<class_float>` **dof_blur_far_distance**
  474. +----------+----------------------------------+
  475. | *Setter* | set_dof_blur_far_distance(value) |
  476. +----------+----------------------------------+
  477. | *Getter* | get_dof_blur_far_distance() |
  478. +----------+----------------------------------+
  479. Distance from the camera where the far blur effect affects the rendering.
  480. ----
  481. .. _class_Environment_property_dof_blur_far_enabled:
  482. - :ref:`bool<class_bool>` **dof_blur_far_enabled**
  483. +----------+---------------------------------+
  484. | *Setter* | set_dof_blur_far_enabled(value) |
  485. +----------+---------------------------------+
  486. | *Getter* | is_dof_blur_far_enabled() |
  487. +----------+---------------------------------+
  488. Enables the far blur effect.
  489. ----
  490. .. _class_Environment_property_dof_blur_far_quality:
  491. - :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` **dof_blur_far_quality**
  492. +----------+---------------------------------+
  493. | *Setter* | set_dof_blur_far_quality(value) |
  494. +----------+---------------------------------+
  495. | *Getter* | get_dof_blur_far_quality() |
  496. +----------+---------------------------------+
  497. Quality of the far blur quality.
  498. ----
  499. .. _class_Environment_property_dof_blur_far_transition:
  500. - :ref:`float<class_float>` **dof_blur_far_transition**
  501. +----------+------------------------------------+
  502. | *Setter* | set_dof_blur_far_transition(value) |
  503. +----------+------------------------------------+
  504. | *Getter* | get_dof_blur_far_transition() |
  505. +----------+------------------------------------+
  506. Transition between no-blur area and far blur.
  507. ----
  508. .. _class_Environment_property_dof_blur_near_amount:
  509. - :ref:`float<class_float>` **dof_blur_near_amount**
  510. +----------+---------------------------------+
  511. | *Setter* | set_dof_blur_near_amount(value) |
  512. +----------+---------------------------------+
  513. | *Getter* | get_dof_blur_near_amount() |
  514. +----------+---------------------------------+
  515. Amount of near blur.
  516. ----
  517. .. _class_Environment_property_dof_blur_near_distance:
  518. - :ref:`float<class_float>` **dof_blur_near_distance**
  519. +----------+-----------------------------------+
  520. | *Setter* | set_dof_blur_near_distance(value) |
  521. +----------+-----------------------------------+
  522. | *Getter* | get_dof_blur_near_distance() |
  523. +----------+-----------------------------------+
  524. Distance from the camera where the near blur effect affects the rendering.
  525. ----
  526. .. _class_Environment_property_dof_blur_near_enabled:
  527. - :ref:`bool<class_bool>` **dof_blur_near_enabled**
  528. +----------+----------------------------------+
  529. | *Setter* | set_dof_blur_near_enabled(value) |
  530. +----------+----------------------------------+
  531. | *Getter* | is_dof_blur_near_enabled() |
  532. +----------+----------------------------------+
  533. Enables the near blur effect.
  534. ----
  535. .. _class_Environment_property_dof_blur_near_quality:
  536. - :ref:`DOFBlurQuality<enum_Environment_DOFBlurQuality>` **dof_blur_near_quality**
  537. +----------+----------------------------------+
  538. | *Setter* | set_dof_blur_near_quality(value) |
  539. +----------+----------------------------------+
  540. | *Getter* | get_dof_blur_near_quality() |
  541. +----------+----------------------------------+
  542. Quality of the near blur quality.
  543. ----
  544. .. _class_Environment_property_dof_blur_near_transition:
  545. - :ref:`float<class_float>` **dof_blur_near_transition**
  546. +----------+-------------------------------------+
  547. | *Setter* | set_dof_blur_near_transition(value) |
  548. +----------+-------------------------------------+
  549. | *Getter* | get_dof_blur_near_transition() |
  550. +----------+-------------------------------------+
  551. Transition between near blur and no-blur area.
  552. ----
  553. .. _class_Environment_property_fog_color:
  554. - :ref:`Color<class_Color>` **fog_color**
  555. +----------+----------------------+
  556. | *Setter* | set_fog_color(value) |
  557. +----------+----------------------+
  558. | *Getter* | get_fog_color() |
  559. +----------+----------------------+
  560. Fog's :ref:`Color<class_Color>`.
  561. ----
  562. .. _class_Environment_property_fog_depth_begin:
  563. - :ref:`float<class_float>` **fog_depth_begin**
  564. +----------+----------------------------+
  565. | *Setter* | set_fog_depth_begin(value) |
  566. +----------+----------------------------+
  567. | *Getter* | get_fog_depth_begin() |
  568. +----------+----------------------------+
  569. Fog's depth starting distance from the camera.
  570. ----
  571. .. _class_Environment_property_fog_depth_curve:
  572. - :ref:`float<class_float>` **fog_depth_curve**
  573. +----------+----------------------------+
  574. | *Setter* | set_fog_depth_curve(value) |
  575. +----------+----------------------------+
  576. | *Getter* | get_fog_depth_curve() |
  577. +----------+----------------------------+
  578. Value defining the fog depth intensity.
  579. ----
  580. .. _class_Environment_property_fog_depth_enabled:
  581. - :ref:`bool<class_bool>` **fog_depth_enabled**
  582. +----------+------------------------------+
  583. | *Setter* | set_fog_depth_enabled(value) |
  584. +----------+------------------------------+
  585. | *Getter* | is_fog_depth_enabled() |
  586. +----------+------------------------------+
  587. Enables the fog depth.
  588. ----
  589. .. _class_Environment_property_fog_depth_end:
  590. - :ref:`float<class_float>` **fog_depth_end**
  591. +----------+--------------------------+
  592. | *Setter* | set_fog_depth_end(value) |
  593. +----------+--------------------------+
  594. | *Getter* | get_fog_depth_end() |
  595. +----------+--------------------------+
  596. ----
  597. .. _class_Environment_property_fog_enabled:
  598. - :ref:`bool<class_bool>` **fog_enabled**
  599. +----------+------------------------+
  600. | *Setter* | set_fog_enabled(value) |
  601. +----------+------------------------+
  602. | *Getter* | is_fog_enabled() |
  603. +----------+------------------------+
  604. Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog.
  605. ----
  606. .. _class_Environment_property_fog_height_curve:
  607. - :ref:`float<class_float>` **fog_height_curve**
  608. +----------+-----------------------------+
  609. | *Setter* | set_fog_height_curve(value) |
  610. +----------+-----------------------------+
  611. | *Getter* | get_fog_height_curve() |
  612. +----------+-----------------------------+
  613. Value defining the fog height intensity.
  614. ----
  615. .. _class_Environment_property_fog_height_enabled:
  616. - :ref:`bool<class_bool>` **fog_height_enabled**
  617. +----------+-------------------------------+
  618. | *Setter* | set_fog_height_enabled(value) |
  619. +----------+-------------------------------+
  620. | *Getter* | is_fog_height_enabled() |
  621. +----------+-------------------------------+
  622. Enables the fog height.
  623. ----
  624. .. _class_Environment_property_fog_height_max:
  625. - :ref:`float<class_float>` **fog_height_max**
  626. +----------+---------------------------+
  627. | *Setter* | set_fog_height_max(value) |
  628. +----------+---------------------------+
  629. | *Getter* | get_fog_height_max() |
  630. +----------+---------------------------+
  631. Maximum height of fog.
  632. ----
  633. .. _class_Environment_property_fog_height_min:
  634. - :ref:`float<class_float>` **fog_height_min**
  635. +----------+---------------------------+
  636. | *Setter* | set_fog_height_min(value) |
  637. +----------+---------------------------+
  638. | *Getter* | get_fog_height_min() |
  639. +----------+---------------------------+
  640. Minimum height of fog.
  641. ----
  642. .. _class_Environment_property_fog_sun_amount:
  643. - :ref:`float<class_float>` **fog_sun_amount**
  644. +----------+---------------------------+
  645. | *Setter* | set_fog_sun_amount(value) |
  646. +----------+---------------------------+
  647. | *Getter* | get_fog_sun_amount() |
  648. +----------+---------------------------+
  649. Amount of sun that affects the fog rendering.
  650. ----
  651. .. _class_Environment_property_fog_sun_color:
  652. - :ref:`Color<class_Color>` **fog_sun_color**
  653. +----------+--------------------------+
  654. | *Setter* | set_fog_sun_color(value) |
  655. +----------+--------------------------+
  656. | *Getter* | get_fog_sun_color() |
  657. +----------+--------------------------+
  658. Sun :ref:`Color<class_Color>`.
  659. ----
  660. .. _class_Environment_property_fog_transmit_curve:
  661. - :ref:`float<class_float>` **fog_transmit_curve**
  662. +----------+-------------------------------+
  663. | *Setter* | set_fog_transmit_curve(value) |
  664. +----------+-------------------------------+
  665. | *Getter* | get_fog_transmit_curve() |
  666. +----------+-------------------------------+
  667. Amount of light that the fog transmits.
  668. ----
  669. .. _class_Environment_property_fog_transmit_enabled:
  670. - :ref:`bool<class_bool>` **fog_transmit_enabled**
  671. +----------+---------------------------------+
  672. | *Setter* | set_fog_transmit_enabled(value) |
  673. +----------+---------------------------------+
  674. | *Getter* | is_fog_transmit_enabled() |
  675. +----------+---------------------------------+
  676. Enables fog's light transmission. If enabled, lets reflections light to be transmitted by the fog.
  677. ----
  678. .. _class_Environment_property_glow_bicubic_upscale:
  679. - :ref:`bool<class_bool>` **glow_bicubic_upscale**
  680. +----------+-----------------------------------+
  681. | *Setter* | set_glow_bicubic_upscale(value) |
  682. +----------+-----------------------------------+
  683. | *Getter* | is_glow_bicubic_upscale_enabled() |
  684. +----------+-----------------------------------+
  685. ----
  686. .. _class_Environment_property_glow_blend_mode:
  687. - :ref:`GlowBlendMode<enum_Environment_GlowBlendMode>` **glow_blend_mode**
  688. +----------+----------------------------+
  689. | *Setter* | set_glow_blend_mode(value) |
  690. +----------+----------------------------+
  691. | *Getter* | get_glow_blend_mode() |
  692. +----------+----------------------------+
  693. Glow blending mode.
  694. ----
  695. .. _class_Environment_property_glow_bloom:
  696. - :ref:`float<class_float>` **glow_bloom**
  697. +----------+-----------------------+
  698. | *Setter* | set_glow_bloom(value) |
  699. +----------+-----------------------+
  700. | *Getter* | get_glow_bloom() |
  701. +----------+-----------------------+
  702. Bloom value (global glow).
  703. ----
  704. .. _class_Environment_property_glow_enabled:
  705. - :ref:`bool<class_bool>` **glow_enabled**
  706. +----------+-------------------------+
  707. | *Setter* | set_glow_enabled(value) |
  708. +----------+-------------------------+
  709. | *Getter* | is_glow_enabled() |
  710. +----------+-------------------------+
  711. Enables glow rendering.
  712. ----
  713. .. _class_Environment_property_glow_hdr_luminance_cap:
  714. - :ref:`float<class_float>` **glow_hdr_luminance_cap**
  715. +----------+-----------------------------------+
  716. | *Setter* | set_glow_hdr_luminance_cap(value) |
  717. +----------+-----------------------------------+
  718. | *Getter* | get_glow_hdr_luminance_cap() |
  719. +----------+-----------------------------------+
  720. ----
  721. .. _class_Environment_property_glow_hdr_scale:
  722. - :ref:`float<class_float>` **glow_hdr_scale**
  723. +----------+---------------------------------+
  724. | *Setter* | set_glow_hdr_bleed_scale(value) |
  725. +----------+---------------------------------+
  726. | *Getter* | get_glow_hdr_bleed_scale() |
  727. +----------+---------------------------------+
  728. Bleed scale of the HDR glow.
  729. ----
  730. .. _class_Environment_property_glow_hdr_threshold:
  731. - :ref:`float<class_float>` **glow_hdr_threshold**
  732. +----------+-------------------------------------+
  733. | *Setter* | set_glow_hdr_bleed_threshold(value) |
  734. +----------+-------------------------------------+
  735. | *Getter* | get_glow_hdr_bleed_threshold() |
  736. +----------+-------------------------------------+
  737. Bleed threshold of the HDR glow.
  738. ----
  739. .. _class_Environment_property_glow_intensity:
  740. - :ref:`float<class_float>` **glow_intensity**
  741. +----------+---------------------------+
  742. | *Setter* | set_glow_intensity(value) |
  743. +----------+---------------------------+
  744. | *Getter* | get_glow_intensity() |
  745. +----------+---------------------------+
  746. Glow intensity.
  747. ----
  748. .. _class_Environment_property_glow_levels/1:
  749. - :ref:`bool<class_bool>` **glow_levels/1**
  750. +----------+-------------------------+
  751. | *Setter* | set_glow_level(value) |
  752. +----------+-------------------------+
  753. | *Getter* | is_glow_level_enabled() |
  754. +----------+-------------------------+
  755. First level of glow (most local).
  756. ----
  757. .. _class_Environment_property_glow_levels/2:
  758. - :ref:`bool<class_bool>` **glow_levels/2**
  759. +----------+-------------------------+
  760. | *Setter* | set_glow_level(value) |
  761. +----------+-------------------------+
  762. | *Getter* | is_glow_level_enabled() |
  763. +----------+-------------------------+
  764. Second level of glow.
  765. ----
  766. .. _class_Environment_property_glow_levels/3:
  767. - :ref:`bool<class_bool>` **glow_levels/3**
  768. +----------+-------------------------+
  769. | *Setter* | set_glow_level(value) |
  770. +----------+-------------------------+
  771. | *Getter* | is_glow_level_enabled() |
  772. +----------+-------------------------+
  773. Third level of glow.
  774. ----
  775. .. _class_Environment_property_glow_levels/4:
  776. - :ref:`bool<class_bool>` **glow_levels/4**
  777. +----------+-------------------------+
  778. | *Setter* | set_glow_level(value) |
  779. +----------+-------------------------+
  780. | *Getter* | is_glow_level_enabled() |
  781. +----------+-------------------------+
  782. Fourth level of glow.
  783. ----
  784. .. _class_Environment_property_glow_levels/5:
  785. - :ref:`bool<class_bool>` **glow_levels/5**
  786. +----------+-------------------------+
  787. | *Setter* | set_glow_level(value) |
  788. +----------+-------------------------+
  789. | *Getter* | is_glow_level_enabled() |
  790. +----------+-------------------------+
  791. Fifth level of glow.
  792. ----
  793. .. _class_Environment_property_glow_levels/6:
  794. - :ref:`bool<class_bool>` **glow_levels/6**
  795. +----------+-------------------------+
  796. | *Setter* | set_glow_level(value) |
  797. +----------+-------------------------+
  798. | *Getter* | is_glow_level_enabled() |
  799. +----------+-------------------------+
  800. Sixth level of glow.
  801. ----
  802. .. _class_Environment_property_glow_levels/7:
  803. - :ref:`bool<class_bool>` **glow_levels/7**
  804. +----------+-------------------------+
  805. | *Setter* | set_glow_level(value) |
  806. +----------+-------------------------+
  807. | *Getter* | is_glow_level_enabled() |
  808. +----------+-------------------------+
  809. Seventh level of glow (most global).
  810. ----
  811. .. _class_Environment_property_glow_strength:
  812. - :ref:`float<class_float>` **glow_strength**
  813. +----------+--------------------------+
  814. | *Setter* | set_glow_strength(value) |
  815. +----------+--------------------------+
  816. | *Getter* | get_glow_strength() |
  817. +----------+--------------------------+
  818. Glow strength.
  819. ----
  820. .. _class_Environment_property_ss_reflections_depth_tolerance:
  821. - :ref:`float<class_float>` **ss_reflections_depth_tolerance**
  822. +----------+--------------------------------+
  823. | *Setter* | set_ssr_depth_tolerance(value) |
  824. +----------+--------------------------------+
  825. | *Getter* | get_ssr_depth_tolerance() |
  826. +----------+--------------------------------+
  827. ----
  828. .. _class_Environment_property_ss_reflections_enabled:
  829. - :ref:`bool<class_bool>` **ss_reflections_enabled**
  830. +----------+------------------------+
  831. | *Setter* | set_ssr_enabled(value) |
  832. +----------+------------------------+
  833. | *Getter* | is_ssr_enabled() |
  834. +----------+------------------------+
  835. ----
  836. .. _class_Environment_property_ss_reflections_fade_in:
  837. - :ref:`float<class_float>` **ss_reflections_fade_in**
  838. +----------+------------------------+
  839. | *Setter* | set_ssr_fade_in(value) |
  840. +----------+------------------------+
  841. | *Getter* | get_ssr_fade_in() |
  842. +----------+------------------------+
  843. ----
  844. .. _class_Environment_property_ss_reflections_fade_out:
  845. - :ref:`float<class_float>` **ss_reflections_fade_out**
  846. +----------+-------------------------+
  847. | *Setter* | set_ssr_fade_out(value) |
  848. +----------+-------------------------+
  849. | *Getter* | get_ssr_fade_out() |
  850. +----------+-------------------------+
  851. ----
  852. .. _class_Environment_property_ss_reflections_max_steps:
  853. - :ref:`int<class_int>` **ss_reflections_max_steps**
  854. +----------+--------------------------+
  855. | *Setter* | set_ssr_max_steps(value) |
  856. +----------+--------------------------+
  857. | *Getter* | get_ssr_max_steps() |
  858. +----------+--------------------------+
  859. ----
  860. .. _class_Environment_property_ss_reflections_roughness:
  861. - :ref:`bool<class_bool>` **ss_reflections_roughness**
  862. +----------+----------------------+
  863. | *Setter* | set_ssr_rough(value) |
  864. +----------+----------------------+
  865. | *Getter* | is_ssr_rough() |
  866. +----------+----------------------+
  867. ----
  868. .. _class_Environment_property_ssao_ao_channel_affect:
  869. - :ref:`float<class_float>` **ssao_ao_channel_affect**
  870. +----------+-----------------------------------+
  871. | *Setter* | set_ssao_ao_channel_affect(value) |
  872. +----------+-----------------------------------+
  873. | *Getter* | get_ssao_ao_channel_affect() |
  874. +----------+-----------------------------------+
  875. ----
  876. .. _class_Environment_property_ssao_bias:
  877. - :ref:`float<class_float>` **ssao_bias**
  878. +----------+----------------------+
  879. | *Setter* | set_ssao_bias(value) |
  880. +----------+----------------------+
  881. | *Getter* | get_ssao_bias() |
  882. +----------+----------------------+
  883. ----
  884. .. _class_Environment_property_ssao_blur:
  885. - :ref:`SSAOBlur<enum_Environment_SSAOBlur>` **ssao_blur**
  886. +----------+----------------------+
  887. | *Setter* | set_ssao_blur(value) |
  888. +----------+----------------------+
  889. | *Getter* | get_ssao_blur() |
  890. +----------+----------------------+
  891. ----
  892. .. _class_Environment_property_ssao_color:
  893. - :ref:`Color<class_Color>` **ssao_color**
  894. +----------+-----------------------+
  895. | *Setter* | set_ssao_color(value) |
  896. +----------+-----------------------+
  897. | *Getter* | get_ssao_color() |
  898. +----------+-----------------------+
  899. ----
  900. .. _class_Environment_property_ssao_edge_sharpness:
  901. - :ref:`float<class_float>` **ssao_edge_sharpness**
  902. +----------+--------------------------------+
  903. | *Setter* | set_ssao_edge_sharpness(value) |
  904. +----------+--------------------------------+
  905. | *Getter* | get_ssao_edge_sharpness() |
  906. +----------+--------------------------------+
  907. ----
  908. .. _class_Environment_property_ssao_enabled:
  909. - :ref:`bool<class_bool>` **ssao_enabled**
  910. +----------+-------------------------+
  911. | *Setter* | set_ssao_enabled(value) |
  912. +----------+-------------------------+
  913. | *Getter* | is_ssao_enabled() |
  914. +----------+-------------------------+
  915. ----
  916. .. _class_Environment_property_ssao_intensity:
  917. - :ref:`float<class_float>` **ssao_intensity**
  918. +----------+---------------------------+
  919. | *Setter* | set_ssao_intensity(value) |
  920. +----------+---------------------------+
  921. | *Getter* | get_ssao_intensity() |
  922. +----------+---------------------------+
  923. ----
  924. .. _class_Environment_property_ssao_intensity2:
  925. - :ref:`float<class_float>` **ssao_intensity2**
  926. +----------+----------------------------+
  927. | *Setter* | set_ssao_intensity2(value) |
  928. +----------+----------------------------+
  929. | *Getter* | get_ssao_intensity2() |
  930. +----------+----------------------------+
  931. ----
  932. .. _class_Environment_property_ssao_light_affect:
  933. - :ref:`float<class_float>` **ssao_light_affect**
  934. +----------+-------------------------------------+
  935. | *Setter* | set_ssao_direct_light_affect(value) |
  936. +----------+-------------------------------------+
  937. | *Getter* | get_ssao_direct_light_affect() |
  938. +----------+-------------------------------------+
  939. ----
  940. .. _class_Environment_property_ssao_quality:
  941. - :ref:`SSAOQuality<enum_Environment_SSAOQuality>` **ssao_quality**
  942. +----------+-------------------------+
  943. | *Setter* | set_ssao_quality(value) |
  944. +----------+-------------------------+
  945. | *Getter* | get_ssao_quality() |
  946. +----------+-------------------------+
  947. ----
  948. .. _class_Environment_property_ssao_radius:
  949. - :ref:`float<class_float>` **ssao_radius**
  950. +----------+------------------------+
  951. | *Setter* | set_ssao_radius(value) |
  952. +----------+------------------------+
  953. | *Getter* | get_ssao_radius() |
  954. +----------+------------------------+
  955. ----
  956. .. _class_Environment_property_ssao_radius2:
  957. - :ref:`float<class_float>` **ssao_radius2**
  958. +----------+-------------------------+
  959. | *Setter* | set_ssao_radius2(value) |
  960. +----------+-------------------------+
  961. | *Getter* | get_ssao_radius2() |
  962. +----------+-------------------------+
  963. ----
  964. .. _class_Environment_property_tonemap_exposure:
  965. - :ref:`float<class_float>` **tonemap_exposure**
  966. +----------+-----------------------------+
  967. | *Setter* | set_tonemap_exposure(value) |
  968. +----------+-----------------------------+
  969. | *Getter* | get_tonemap_exposure() |
  970. +----------+-----------------------------+
  971. Default exposure for tonemap.
  972. ----
  973. .. _class_Environment_property_tonemap_mode:
  974. - :ref:`ToneMapper<enum_Environment_ToneMapper>` **tonemap_mode**
  975. +----------+-----------------------+
  976. | *Setter* | set_tonemapper(value) |
  977. +----------+-----------------------+
  978. | *Getter* | get_tonemapper() |
  979. +----------+-----------------------+
  980. Tonemapping mode.
  981. ----
  982. .. _class_Environment_property_tonemap_white:
  983. - :ref:`float<class_float>` **tonemap_white**
  984. +----------+--------------------------+
  985. | *Setter* | set_tonemap_white(value) |
  986. +----------+--------------------------+
  987. | *Getter* | get_tonemap_white() |
  988. +----------+--------------------------+
  989. White reference value for tonemap.