class_occluder3d.rst 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Occluder3D.xml.
  6. .. _class_Occluder3D:
  7. Occluder3D
  8. ==========
  9. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`ArrayOccluder3D<class_ArrayOccluder3D>`, :ref:`BoxOccluder3D<class_BoxOccluder3D>`, :ref:`PolygonOccluder3D<class_PolygonOccluder3D>`, :ref:`QuadOccluder3D<class_QuadOccluder3D>`, :ref:`SphereOccluder3D<class_SphereOccluder3D>`
  11. Occluder shape resource for use with occlusion culling in :ref:`OccluderInstance3D<class_OccluderInstance3D>`.
  12. Description
  13. -----------
  14. ``Occluder3D`` stores an occluder shape that can be used by the engine's occlusion culling system.
  15. See :ref:`OccluderInstance3D<class_OccluderInstance3D>`'s documentation for instructions on setting up occlusion culling.
  16. Methods
  17. -------
  18. +-----------------------------------------------------+-------------------------------------------------------------------------------+
  19. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_indices<class_Occluder3D_method_get_indices>` **(** **)** |const| |
  20. +-----------------------------------------------------+-------------------------------------------------------------------------------+
  21. | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`get_vertices<class_Occluder3D_method_get_vertices>` **(** **)** |const| |
  22. +-----------------------------------------------------+-------------------------------------------------------------------------------+
  23. Method Descriptions
  24. -------------------
  25. .. _class_Occluder3D_method_get_indices:
  26. - :ref:`PackedInt32Array<class_PackedInt32Array>` **get_indices** **(** **)** |const|
  27. Returns the occluder shape's vertex indices.
  28. ----
  29. .. _class_Occluder3D_method_get_vertices:
  30. - :ref:`PackedVector3Array<class_PackedVector3Array>` **get_vertices** **(** **)** |const|
  31. Returns the occluder shape's vertex positions.
  32. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  33. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  34. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  35. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  36. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  37. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`