class_openxrcompositionlayerquad.rst 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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/modules/openxr/doc_classes/OpenXRCompositionLayerQuad.xml.
  6. .. _class_OpenXRCompositionLayerQuad:
  7. OpenXRCompositionLayerQuad
  8. ==========================
  9. **Experimental:** This class may be changed or removed in future versions.
  10. **Inherits:** :ref:`OpenXRCompositionLayer<class_OpenXRCompositionLayer>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  11. An OpenXR composition layer that is rendered as a quad.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. An OpenXR composition layer that allows rendering a :ref:`SubViewport<class_SubViewport>` on a quad.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +-------------------------------+-----------------------------------------------------------------------+-------------------+
  22. | :ref:`Vector2<class_Vector2>` | :ref:`quad_size<class_OpenXRCompositionLayerQuad_property_quad_size>` | ``Vector2(1, 1)`` |
  23. +-------------------------------+-----------------------------------------------------------------------+-------------------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_OpenXRCompositionLayerQuad_property_quad_size:
  30. .. rst-class:: classref-property
  31. :ref:`Vector2<class_Vector2>` **quad_size** = ``Vector2(1, 1)`` :ref:`🔗<class_OpenXRCompositionLayerQuad_property_quad_size>`
  32. .. rst-class:: classref-property-setget
  33. - |void| **set_quad_size**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
  34. - :ref:`Vector2<class_Vector2>` **get_quad_size**\ (\ )
  35. The dimensions of the quad.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  40. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  41. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  42. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  43. .. |void| replace:: :abbr:`void (No return value.)`