Update 3D lights and shadows documentation for 4.0

godotengine · Feb 24, 2023 · f89ffb2 · f89ffb2
1 parent c8d0af5
commit f89ffb2
Show file tree

Hide file tree

Showing 29 changed files with 359 additions and 113 deletions.
diff --git a/tutorials/3d/3d_antialiasing.rst b/tutorials/3d/3d_antialiasing.rst
@@ -73,6 +73,8 @@ Note that alpha antialiasing is not used here:
 
 .. image:: img/antialiasing_msaa_8x.webp
 
+.. _doc_3d_antialiasing_taa:
+
 Temporal antialiasing (TAA)
 ---------------------------
 
@@ -103,6 +105,8 @@ Comparison between no antialiasing (left) and TAA (right):
 
 .. image:: img/antialiasing_taa.webp
 
+.. _doc_3d_antialiasing_fxaa:
+
 Fast approximate antialiasing (FXAA)
 ------------------------------------
 

diff --git a/tutorials/3d/img/lights_and_shadows_acne.webp b/tutorials/3d/img/lights_and_shadows_acne.webp
diff --git a/tutorials/3d/img/lights_and_shadows_blur.webp b/tutorials/3d/img/lights_and_shadows_blur.webp
diff --git a/tutorials/3d/img/lights_and_shadows_directional_mode.webp b/tutorials/3d/img/lights_and_shadows_directional_mode.webp
diff --git a/tutorials/3d/img/lights_and_shadows_directional_shadow_params.webp b/tutorials/3d/img/lights_and_shadows_directional_shadow_params.webp
diff --git a/tutorials/3d/img/lights_and_shadows_dual_parabolid_vs_cubemap.webp b/tutorials/3d/img/lights_and_shadows_dual_parabolid_vs_cubemap.webp
diff --git a/tutorials/3d/img/lights_and_shadows_filter_quality.webp b/tutorials/3d/img/lights_and_shadows_filter_quality.webp
diff --git a/tutorials/3d/img/lights_and_shadows_omni_projector.webp b/tutorials/3d/img/lights_and_shadows_omni_projector.webp
diff --git a/tutorials/3d/img/lights_and_shadows_omni_projector_example.webp b/tutorials/3d/img/lights_and_shadows_omni_projector_example.webp
diff --git a/tutorials/3d/img/lights_and_shadows_pcss.webp b/tutorials/3d/img/lights_and_shadows_pcss.webp
diff --git a/tutorials/3d/img/lights_and_shadows_peter_panning.webp b/tutorials/3d/img/lights_and_shadows_peter_panning.webp
diff --git a/tutorials/3d/img/lights_and_shadows_pssm_explained.webp b/tutorials/3d/img/lights_and_shadows_pssm_explained.webp
diff --git a/tutorials/3d/img/lights_and_shadows_shadow_quadrants.webp b/tutorials/3d/img/lights_and_shadows_shadow_quadrants.webp
diff --git a/tutorials/3d/img/lights_and_shadows_shadow_quadrants2.webp b/tutorials/3d/img/lights_and_shadows_shadow_quadrants2.webp
diff --git a/tutorials/3d/img/lights_and_shadows_spot_projector.webp b/tutorials/3d/img/lights_and_shadows_spot_projector.webp
diff --git a/tutorials/3d/img/lights_and_shadows_spot_projector_example.webp b/tutorials/3d/img/lights_and_shadows_spot_projector_example.webp
diff --git a/tutorials/3d/img/pssm_explained.png b/tutorials/3d/img/pssm_explained.png
diff --git a/tutorials/3d/img/shadow_atlas.png b/tutorials/3d/img/shadow_atlas.png
diff --git a/tutorials/3d/img/shadow_bias.png b/tutorials/3d/img/shadow_bias.png
diff --git a/tutorials/3d/img/shadow_blocky.png b/tutorials/3d/img/shadow_blocky.png
diff --git a/tutorials/3d/img/shadow_contact.png b/tutorials/3d/img/shadow_contact.png
diff --git a/tutorials/3d/img/shadow_omni_dp_cm.png b/tutorials/3d/img/shadow_omni_dp_cm.png
diff --git a/tutorials/3d/img/shadow_pcf1.png b/tutorials/3d/img/shadow_pcf1.png
diff --git a/tutorials/3d/img/shadow_pcf2.png b/tutorials/3d/img/shadow_pcf2.png
diff --git a/tutorials/3d/img/shadow_pssm.png b/tutorials/3d/img/shadow_pssm.png
diff --git a/tutorials/3d/img/shadow_quadrants.png b/tutorials/3d/img/shadow_quadrants.png
diff --git a/tutorials/3d/img/shadow_quadrants2.png b/tutorials/3d/img/shadow_quadrants2.png
diff --git a/tutorials/3d/introduction_to_3d.rst b/tutorials/3d/introduction_to_3d.rst
@@ -230,5 +230,24 @@ each viewport:
 Lights
 ------
 
-There is no limitation on the number of lights, nor of types of lights, in
-Godot. As many as desired can be added (as long as performance allows).
+When using the Forward Plus renderer, there is no limitation on the number of
+lights you can use in a scene. This is made by possible by using a *clustering*
+approach for real-time lighting. As many lights as desired can be added (as long
+as performance allows).
+
+When using the Forward Mobile renderer, there is a limitation of 8 OmniLights +
+8 SpotLights per mesh resource. Additionally, only one DirectionalLight can be
+visible at a time.
+
+When using the Compatibility renderer, only one OmniLight and one SpotLight can
+be rendered with shadows enabled per mesh resource. Additionally, only one
+DirectionalLight can be visible at a time. Up to 32 OmniLights + 32 SpotLights
+*without shadows* can be rendered per mesh resource. This limit can be increased
+in the Project Settings at the cost of performance and longer shader compilation
+times. The limit can also be decreased to reduce shader compilation times and
+improve performance slightly.
+
+If you need to render more lights than possible in a given rendering backend,
+consider using baked :ref:`doc_baked_lightmaps` with lights' bake mode set to
+**Static**. This allows lights to be fully baked, which also makes them much
+faster to render.
diff --git a/tutorials/3d/lights_and_shadows.rst b/tutorials/3d/lights_and_shadows.rst