class_openxrcompositionlayerequirect.rst 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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/OpenXRCompositionLayerEquirect.xml.
  6. .. _class_OpenXRCompositionLayerEquirect:
  7. OpenXRCompositionLayerEquirect
  8. ==============================
  9. **Inherits:** :ref:`OpenXRCompositionLayer<class_OpenXRCompositionLayer>` **<** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. An OpenXR composition layer that is rendered as an internal slice of a sphere.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. An OpenXR composition layer that allows rendering a :ref:`SubViewport<class_SubViewport>` on an internal slice of a sphere.
  15. .. rst-class:: classref-reftable-group
  16. Properties
  17. ----------
  18. .. table::
  19. :widths: auto
  20. +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
  21. | :ref:`float<class_float>` | :ref:`central_horizontal_angle<class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle>` | ``1.5708`` |
  22. +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
  23. | :ref:`int<class_int>` | :ref:`fallback_segments<class_OpenXRCompositionLayerEquirect_property_fallback_segments>` | ``10`` |
  24. +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
  25. | :ref:`float<class_float>` | :ref:`lower_vertical_angle<class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle>` | ``0.785398`` |
  26. +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
  27. | :ref:`float<class_float>` | :ref:`radius<class_OpenXRCompositionLayerEquirect_property_radius>` | ``1.0`` |
  28. +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
  29. | :ref:`float<class_float>` | :ref:`upper_vertical_angle<class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle>` | ``0.785398`` |
  30. +---------------------------+---------------------------------------------------------------------------------------------------------+--------------+
  31. .. rst-class:: classref-section-separator
  32. ----
  33. .. rst-class:: classref-descriptions-group
  34. Property Descriptions
  35. ---------------------
  36. .. _class_OpenXRCompositionLayerEquirect_property_central_horizontal_angle:
  37. .. rst-class:: classref-property
  38. :ref:`float<class_float>` **central_horizontal_angle** = ``1.5708``
  39. .. rst-class:: classref-property-setget
  40. - |void| **set_central_horizontal_angle**\ (\ value\: :ref:`float<class_float>`\ )
  41. - :ref:`float<class_float>` **get_central_horizontal_angle**\ (\ )
  42. The central horizontal angle of the sphere. Used to set the width.
  43. .. rst-class:: classref-item-separator
  44. ----
  45. .. _class_OpenXRCompositionLayerEquirect_property_fallback_segments:
  46. .. rst-class:: classref-property
  47. :ref:`int<class_int>` **fallback_segments** = ``10``
  48. .. rst-class:: classref-property-setget
  49. - |void| **set_fallback_segments**\ (\ value\: :ref:`int<class_int>`\ )
  50. - :ref:`int<class_int>` **get_fallback_segments**\ (\ )
  51. The number of segments to use in the fallback mesh.
  52. .. rst-class:: classref-item-separator
  53. ----
  54. .. _class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle:
  55. .. rst-class:: classref-property
  56. :ref:`float<class_float>` **lower_vertical_angle** = ``0.785398``
  57. .. rst-class:: classref-property-setget
  58. - |void| **set_lower_vertical_angle**\ (\ value\: :ref:`float<class_float>`\ )
  59. - :ref:`float<class_float>` **get_lower_vertical_angle**\ (\ )
  60. The lower vertical angle of the sphere. Used (together with :ref:`upper_vertical_angle<class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle>`) to set the height.
  61. .. rst-class:: classref-item-separator
  62. ----
  63. .. _class_OpenXRCompositionLayerEquirect_property_radius:
  64. .. rst-class:: classref-property
  65. :ref:`float<class_float>` **radius** = ``1.0``
  66. .. rst-class:: classref-property-setget
  67. - |void| **set_radius**\ (\ value\: :ref:`float<class_float>`\ )
  68. - :ref:`float<class_float>` **get_radius**\ (\ )
  69. The radius of the sphere.
  70. .. rst-class:: classref-item-separator
  71. ----
  72. .. _class_OpenXRCompositionLayerEquirect_property_upper_vertical_angle:
  73. .. rst-class:: classref-property
  74. :ref:`float<class_float>` **upper_vertical_angle** = ``0.785398``
  75. .. rst-class:: classref-property-setget
  76. - |void| **set_upper_vertical_angle**\ (\ value\: :ref:`float<class_float>`\ )
  77. - :ref:`float<class_float>` **get_upper_vertical_angle**\ (\ )
  78. The upper vertical angle of the sphere. Used (together with :ref:`lower_vertical_angle<class_OpenXRCompositionLayerEquirect_property_lower_vertical_angle>`) to set the height.
  79. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  80. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  81. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  82. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  83. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  84. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  85. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  86. .. |void| replace:: :abbr:`void (No return value.)`