summaryrefslogtreecommitdiff
path: root/doc/classes/QuadOccluder3D.xml
diff options
context:
space:
mode:
authorJFonS <JFonS@users.noreply.github.com>2022-02-10 20:35:38 +0100
committerGitHub <noreply@github.com>2022-02-10 20:35:38 +0100
commitb2da1a5c204e2ed396f2afe5c4dc58d6ae4ca6d5 (patch)
tree08a2b97524b7acac01b78f06912a8d00ca998046 /doc/classes/QuadOccluder3D.xml
parent38c851a3fa14983e60f74703fea2178d52358b92 (diff)
parentdee43ea6501a51a7a2353d04d6376931a3278a33 (diff)
Merge pull request #57889 from Calinou/doc-occlusion-culling
Document occlusion culling classes and settings
Diffstat (limited to 'doc/classes/QuadOccluder3D.xml')
-rw-r--r--doc/classes/QuadOccluder3D.xml4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/QuadOccluder3D.xml b/doc/classes/QuadOccluder3D.xml
index c1b89149f5..44cbfb88ff 100644
--- a/doc/classes/QuadOccluder3D.xml
+++ b/doc/classes/QuadOccluder3D.xml
@@ -1,13 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="QuadOccluder3D" inherits="Occluder3D" version="4.0">
<brief_description>
+ Flat plane shape for use with occlusion culling in [OccluderInstance3D].
</brief_description>
<description>
+ [QuadOccluder3D] stores a flat plane shape that can be used by the engine's occlusion culling system. See also [PolygonOccluder3D] if you need to customize the quad's shape.
+ See [OccluderInstance3D]'s documentation for instructions on setting up occlusion culling.
</description>
<tutorials>
</tutorials>
<members>
<member name="size" type="Vector2" setter="set_size" getter="get_size" default="Vector2(1, 1)">
+ The quad's size in 3D units.
</member>
</members>
</class>