Document occlusion culling classes and settings

This commit is contained in:
Hugo Locurcio 2022-02-10 00:25:46 +01:00
parent 2c28729122
commit dee43ea650
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
9 changed files with 48 additions and 2 deletions

View file

@ -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>