stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with latest 4.0-alpha

Browse Source
This commit is contained in:
Rémi Verschelde
2022-02-22 10:06:27 +01:00
parent 2ef8d8df34
commit 19fca2678c
128 changed files with 4153 additions and 2432 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_occluder3d.rst
+24 -27
View File
@@ -11,45 +11,42 @@ Occluder3D
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`ArrayOccluder3D<class_ArrayOccluder3D>`, :ref:`BoxOccluder3D<class_BoxOccluder3D>`, :ref:`PolygonOccluder3D<class_PolygonOccluder3D>`, :ref:`QuadOccluder3D<class_QuadOccluder3D>`, :ref:`SphereOccluder3D<class_SphereOccluder3D>`
Occluder shape resource for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
Properties
----------
Description
-----------
+-----------------------------------------------------+-----------------------------------------------------+--------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`indices<class_Occluder3D_property_indices>` | ``PackedInt32Array()`` |
+-----------------------------------------------------+-----------------------------------------------------+--------------------------+
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`vertices<class_Occluder3D_property_vertices>` | ``PackedVector3Array()`` |
+-----------------------------------------------------+-----------------------------------------------------+--------------------------+
``Occluder3D`` stores an occluder shape that can be used by the engine's occlusion culling system.
Property Descriptions
---------------------
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
.. _class_Occluder3D_property_indices:
Methods
-------
- :ref:`PackedInt32Array<class_PackedInt32Array>` **indices**
+-----------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_indices<class_Occluder3D_method_get_indices>` **(** **)** |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------+
| :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_vertices<class_Occluder3D_method_get_vertices>` **(** **)** |const| |
+-----------------------------------------------------+-------------------------------------------------------------------------------+
+-----------+------------------------+
| *Default* | ``PackedInt32Array()`` |
+-----------+------------------------+
| *Setter* | set_indices(value) |
+-----------+------------------------+
| *Getter* | get_indices() |
+-----------+------------------------+
Method Descriptions
-------------------
.. _class_Occluder3D_method_get_indices:
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_indices** **(** **)** |const|
Returns the occluder shape's vertex indices.
----
.. _class_Occluder3D_property_vertices:
.. _class_Occluder3D_method_get_vertices:
- :ref:`PackedVector3Array<class_PackedVector3Array>` **vertices**
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_vertices** **(** **)** |const|
+-----------+--------------------------+
| *Default* | ``PackedVector3Array()`` |
+-----------+--------------------------+
| *Setter* | set_vertices(value) |
+-----------+--------------------------+
| *Getter* | get_vertices() |
+-----------+--------------------------+
Returns the occluder shape's vertex positions.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`