summaryrefslogtreecommitdiff
path: root/doc/classes/ReflectionProbe.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2020-07-01 14:18:13 +0200
committerRémi Verschelde <rverschelde@gmail.com>2020-07-01 14:44:45 +0200
commit372136fe75e9f042d2284bae46d2879950f4d399 (patch)
tree9341d5a780694220105d17352d2ffe07815278bd /doc/classes/ReflectionProbe.xml
parent719609522a30fa9e3b96b028ac5a1d1a65f1678f (diff)
Environment: Refactor code for readability + more
- Makes all boolean setters/getters consistent. - Fixes bug where `glow_hdr_bleed_scale` was not used. - Split CameraEffects to their own source file. - Reorder all Environment method and properties declarations, definitions and bindings to be consistent with each other and with the order of property bindings. - Bind missing enum values added with SDFGI. - Remove unused SDFGI enhance_ssr boolean. - Sync doc changes after SDFGI merge and other misc changes.
Diffstat (limited to 'doc/classes/ReflectionProbe.xml')
-rw-r--r--doc/classes/ReflectionProbe.xml25
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml
index 84f87c3e71..07d7b646a1 100644
--- a/doc/classes/ReflectionProbe.xml
+++ b/doc/classes/ReflectionProbe.xml
@@ -13,6 +13,12 @@
<methods>
</methods>
<members>
+ <member name="ambient_color" type="Color" setter="set_ambient_color" getter="get_ambient_color" default="Color( 0, 0, 0, 1 )">
+ </member>
+ <member name="ambient_color_energy" type="float" setter="set_ambient_color_energy" getter="get_ambient_color_energy" default="1.0">
+ </member>
+ <member name="ambient_mode" type="int" setter="set_ambient_mode" getter="get_ambient_mode" enum="ReflectionProbe.AmbientMode" default="1">
+ </member>
<member name="box_projection" type="bool" setter="set_enable_box_projection" getter="is_box_projection_enabled" default="false">
If [code]true[/code], enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location.
</member>
@@ -28,17 +34,8 @@
<member name="intensity" type="float" setter="set_intensity" getter="get_intensity" default="1.0">
Defines the reflection intensity. Intensity modulates the strength of the reflection.
</member>
- <member name="interior_ambient_color" type="Color" setter="set_interior_ambient" getter="get_interior_ambient" default="Color( 0, 0, 0, 1 )">
- Sets the ambient light color to be used when this probe is set to [member interior_enable].
- </member>
- <member name="interior_ambient_contrib" type="float" setter="set_interior_ambient_probe_contribution" getter="get_interior_ambient_probe_contribution" default="0.0">
- Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to [member interior_enable]. Useful so that ambient light matches the color of the room.
- </member>
- <member name="interior_ambient_energy" type="float" setter="set_interior_ambient_energy" getter="get_interior_ambient_energy" default="1.0">
- Sets the energy multiplier for this reflection probe's ambient light contribution when set to [member interior_enable].
- </member>
- <member name="interior_enable" type="bool" setter="set_as_interior" getter="is_set_as_interior" default="false">
- If [code]true[/code], reflections will ignore sky contribution. Ambient lighting is then controlled by the [code]interior_ambient_*[/code] properties.
+ <member name="interior" type="bool" setter="set_as_interior" getter="is_set_as_interior" default="false">
+ If [code]true[/code], reflections will ignore sky contribution.
</member>
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance" default="0.0">
Sets the max distance away from the probe an object can be before it is culled.
@@ -57,5 +54,11 @@
<constant name="UPDATE_ALWAYS" value="1" enum="UpdateMode">
Update the probe every frame. This is needed when you want to capture dynamic objects. However, it results in an increased render time. Use [constant UPDATE_ONCE] whenever possible.
</constant>
+ <constant name="AMBIENT_DISABLED" value="0" enum="AmbientMode">
+ </constant>
+ <constant name="AMBIENT_ENVIRONMENT" value="1" enum="AmbientMode">
+ </constant>
+ <constant name="AMBIENT_COLOR" value="2" enum="AmbientMode">
+ </constant>
</constants>
</class>