Skip to content

Commit b35060e

Browse files
authored
Merge pull request godotengine#8059 from Calinou/decal-reflection-probe-cluster-limits
Document Forward+ limitations with decal and reflection probe rendering
2 parents a766184 + 72e6c29 commit b35060e

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

tutorials/3d/global_illumination/reflection_probes.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Reflection probes
44
=================
55

6+
.. note::
7+
8+
Reflection probes are only supported in the Clustered Forward and Forward
9+
Mobile rendering backends, not the Compatibility backend.
10+
611
As stated in the :ref:`doc_standard_material_3d`, objects can show reflected and/or
712
diffuse light. Reflection probes are used as a source of reflected *and* ambient
813
light for objects inside their area of influence. They can be used to provide
@@ -166,3 +171,19 @@ To make several ReflectionProbes blend with each other, you need to have part of
166171
each ReflectionProbe overlap each other's area. The extents should only overlap
167172
as little possible with other reflection probes to improve rendering performance
168173
(typically a few units in 3D space).
174+
175+
Limitations
176+
-----------
177+
178+
When using the Forward+ renderer, Godot uses a *clustering* approach for
179+
reflection probe rendering. As many reflection probes as desired can be added (as long as
180+
performance allows). However, there's still a default limit of 512 *clustered
181+
elements* that can be present in the current camera view. A clustered element is
182+
an omni light, a spot light, a :ref:`decal <doc_using_decals>` or a
183+
:ref:`reflection probe <doc_reflection_probes>`. This limit can be increased by
184+
adjusting the **Rendering > Limits > Cluster Builder > Max Clustered Elements**
185+
advanced project setting.
186+
187+
When using the Forward Mobile backend, only 8 reflection probes can be applied on each
188+
individual Mesh *resource*. If there are more reflection probes affecting a single mesh,
189+
not all of them will be rendered on the mesh.

tutorials/3d/using_decals.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,15 @@ decals cannot use custom shaders. However, custom shaders on the projected
229229
surfaces are able to read the information that is overridden by decals on top of
230230
them, such as roughness and metallic.
231231

232+
When using the Forward+ renderer, Godot uses a *clustering* approach for
233+
decal rendering. As many decals as desired can be added (as long as
234+
performance allows). However, there's still a default limit of 512 *clustered
235+
elements* that can be present in the current camera view. A clustered element is
236+
an omni light, a spot light, a :ref:`decal <doc_using_decals>` or a
237+
:ref:`reflection probe <doc_reflection_probes>`. This limit can be increased by
238+
adjusting the **Rendering > Limits > Cluster Builder > Max Clustered Elements**
239+
advanced project setting.
240+
232241
When using the Forward Mobile backend, only 8 decals can be applied on each
233242
individual Mesh *resource*. If there are more decals affecting a single mesh,
234243
not all of them will be rendered on the mesh.

0 commit comments

Comments
 (0)