class_environment.rst 60 KB

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