Files
godot-docs/classes/class_occluder3d.rst
2022-02-22 10:06:27 +01:00

57 lines
2.8 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Occluder3D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Occluder3D:
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>`.
Description
-----------
``Occluder3D`` stores an occluder shape that can be used by the engine's occlusion culling system.
See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
Methods
-------
+-----------------------------------------------------+-------------------------------------------------------------------------------+
| :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| |
+-----------------------------------------------------+-------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_Occluder3D_method_get_indices:
- :ref:`PackedInt32Array<class_PackedInt32Array>` **get_indices** **(** **)** |const|
Returns the occluder shape's vertex indices.
----
.. _class_Occluder3D_method_get_vertices:
- :ref:`PackedVector3Array<class_PackedVector3Array>` **get_vertices** **(** **)** |const|
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.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`