summaryrefslogtreecommitdiff
path: root/doc/classes/ReflectionProbe.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-02-28 07:54:19 +0100
committerGitHub <noreply@github.com>2020-02-28 07:54:19 +0100
commit4ff84cbfb32e4ca7f4804c5d8f4c5267eb6a3e38 (patch)
treef379ab4681aa6f227e35667a2e6a92a9e63ad9dd /doc/classes/ReflectionProbe.xml
parent498ab639341c7fc83422fbb13dd8f86a38573ec5 (diff)
parent3e299aa2251b6d11e3786a8bc6fae51eedf6974e (diff)
Merge pull request #36588 from clayjohn/VULKAN-env-filter
Basic fast filtering implementation
Diffstat (limited to 'doc/classes/ReflectionProbe.xml')
-rw-r--r--doc/classes/ReflectionProbe.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/ReflectionProbe.xml b/doc/classes/ReflectionProbe.xml
index 9c7a645fec..e138af6841 100644
--- a/doc/classes/ReflectionProbe.xml
+++ b/doc/classes/ReflectionProbe.xml
@@ -4,7 +4,7 @@
Captures its surroundings to create reflections.
</brief_description>
<description>
- Capture its surroundings as a dual parabolid image, and stores versions of it with increasing levels of blur to simulate different material roughnesses.
+ Captures its surroundings as a cubemap, and stores versions of it with increasing levels of blur to simulate different material roughnesses.
The [ReflectionProbe] is used to create high-quality reflections at the cost of performance. It can be combined with [GIProbe]s and Screen Space Reflections to achieve high quality reflections. [ReflectionProbe]s render all objects within their [member cull_mask], so updating them can be quite expensive. It is best to update them once with the important static objects and then leave them.
</description>
<tutorials>
@@ -52,7 +52,7 @@
</members>
<constants>
<constant name="UPDATE_ONCE" value="0" enum="UpdateMode">
- Update the probe once on the next frame.
+ Update the probe once on the next frame. The corresponding radiance map will be generated over the following six frames. This is slower to update than [constant UPDATE_ALWAYS] but can result in higher quality reflections.
</constant>
<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.