XRInterfaceExtension.xml 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="XRInterfaceExtension" inherits="XRInterface" version="4.0">
  3. <brief_description>
  4. Base class for XR interface extensions (plugins).
  5. </brief_description>
  6. <description>
  7. External XR interface plugins should inherit from this class.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. <method name="_commit_views" qualifiers="virtual">
  13. <return type="void" />
  14. <argument index="0" name="render_target" type="RID" />
  15. <argument index="1" name="screen_rect" type="Rect2" />
  16. <description>
  17. </description>
  18. </method>
  19. <method name="_get_anchor_detection_is_enabled" qualifiers="virtual const">
  20. <return type="bool" />
  21. <description>
  22. </description>
  23. </method>
  24. <method name="_get_camera_feed_id" qualifiers="virtual const">
  25. <return type="int" />
  26. <description>
  27. </description>
  28. </method>
  29. <method name="_get_camera_transform" qualifiers="virtual">
  30. <return type="Transform3D" />
  31. <description>
  32. </description>
  33. </method>
  34. <method name="_get_capabilities" qualifiers="virtual const">
  35. <return type="int" />
  36. <description>
  37. </description>
  38. </method>
  39. <method name="_get_name" qualifiers="virtual const">
  40. <return type="StringName" />
  41. <description>
  42. </description>
  43. </method>
  44. <method name="_get_play_area" qualifiers="virtual const">
  45. <return type="PackedVector3Array" />
  46. <description>
  47. </description>
  48. </method>
  49. <method name="_get_play_area_mode" qualifiers="virtual const">
  50. <return type="int" />
  51. <description>
  52. </description>
  53. </method>
  54. <method name="_get_projection_for_view" qualifiers="virtual">
  55. <return type="PackedFloat64Array" />
  56. <argument index="0" name="view" type="int" />
  57. <argument index="1" name="aspect" type="float" />
  58. <argument index="2" name="z_near" type="float" />
  59. <argument index="3" name="z_far" type="float" />
  60. <description>
  61. </description>
  62. </method>
  63. <method name="_get_render_target_size" qualifiers="virtual">
  64. <return type="Vector2" />
  65. <description>
  66. </description>
  67. </method>
  68. <method name="_get_suggested_pose_names" qualifiers="virtual const">
  69. <return type="PackedStringArray" />
  70. <argument index="0" name="tracker_name" type="StringName" />
  71. <description>
  72. </description>
  73. </method>
  74. <method name="_get_suggested_tracker_names" qualifiers="virtual const">
  75. <return type="PackedStringArray" />
  76. <description>
  77. </description>
  78. </method>
  79. <method name="_get_tracking_status" qualifiers="virtual const">
  80. <return type="int" />
  81. <description>
  82. </description>
  83. </method>
  84. <method name="_get_transform_for_view" qualifiers="virtual">
  85. <return type="Transform3D" />
  86. <argument index="0" name="view" type="int" />
  87. <argument index="1" name="cam_transform" type="Transform3D" />
  88. <description>
  89. </description>
  90. </method>
  91. <method name="_get_view_count" qualifiers="virtual">
  92. <return type="int" />
  93. <description>
  94. </description>
  95. </method>
  96. <method name="_initialize" qualifiers="virtual">
  97. <return type="bool" />
  98. <description>
  99. </description>
  100. </method>
  101. <method name="_is_initialized" qualifiers="virtual const">
  102. <return type="bool" />
  103. <description>
  104. </description>
  105. </method>
  106. <method name="_notification" qualifiers="virtual">
  107. <return type="void" />
  108. <argument index="0" name="what" type="int" />
  109. <description>
  110. </description>
  111. </method>
  112. <method name="_process" qualifiers="virtual">
  113. <return type="void" />
  114. <description>
  115. </description>
  116. </method>
  117. <method name="_set_anchor_detection_is_enabled" qualifiers="virtual">
  118. <return type="void" />
  119. <argument index="0" name="enabled" type="bool" />
  120. <description>
  121. </description>
  122. </method>
  123. <method name="_set_play_area_mode" qualifiers="virtual const">
  124. <return type="bool" />
  125. <argument index="0" name="mode" type="int" />
  126. <description>
  127. </description>
  128. </method>
  129. <method name="_supports_play_area_mode" qualifiers="virtual const">
  130. <return type="bool" />
  131. <argument index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" />
  132. <description>
  133. </description>
  134. </method>
  135. <method name="_trigger_haptic_pulse" qualifiers="virtual">
  136. <return type="void" />
  137. <argument index="0" name="action_name" type="String" />
  138. <argument index="1" name="tracker_name" type="StringName" />
  139. <argument index="2" name="frequency" type="float" />
  140. <argument index="3" name="amplitude" type="float" />
  141. <argument index="4" name="duration_sec" type="float" />
  142. <argument index="5" name="delay_sec" type="float" />
  143. <description>
  144. </description>
  145. </method>
  146. <method name="_uninitialize" qualifiers="virtual">
  147. <return type="void" />
  148. <description>
  149. </description>
  150. </method>
  151. <method name="add_blit">
  152. <return type="void" />
  153. <argument index="0" name="render_target" type="RID" />
  154. <argument index="1" name="src_rect" type="Rect2" />
  155. <argument index="2" name="dst_rect" type="Rect2i" />
  156. <argument index="3" name="use_layer" type="bool" />
  157. <argument index="4" name="layer" type="int" />
  158. <argument index="5" name="apply_lens_distortion" type="bool" />
  159. <argument index="6" name="eye_center" type="Vector2" />
  160. <argument index="7" name="k1" type="float" />
  161. <argument index="8" name="k2" type="float" />
  162. <argument index="9" name="upscale" type="float" />
  163. <argument index="10" name="aspect_ratio" type="float" />
  164. <description>
  165. Blits our render results to screen optionally applying lens distortion. This can only be called while processing [code]_commit_views[/code].
  166. </description>
  167. </method>
  168. <method name="get_render_target_texture">
  169. <return type="RID" />
  170. <argument index="0" name="render_target" type="RID" />
  171. <description>
  172. </description>
  173. </method>
  174. </methods>
  175. </class>