Skip to content

Commit a90b6fd

Browse files
dsnopekdsnopek
authored
Finish filling in all of the API docs (#165)
1 parent 8332d2a commit a90b6fd

24 files changed

+174
-8
lines changed

‎common/src/main/cpp/extensions/openxr_fb_passthrough_extension_wrapper.cpp

-1
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ void OpenXRFbPassthroughExtensionWrapper::_bind_methods() {
9393

9494
ClassDB::bind_method(D_METHOD("set_color_lut", "weight", "color_lut"), &OpenXRFbPassthroughExtensionWrapper::set_color_lut);
9595
ClassDB::bind_method(D_METHOD("set_interpolated_color_lut", "weight", "source_color_lut", "target_color_lut"), &OpenXRFbPassthroughExtensionWrapper::set_interpolated_color_lut);
96-
ClassDB::bind_method(D_METHOD("destroy_color_lut", "color_lut"), &OpenXRFbPassthroughExtensionWrapper::destroy_color_lut);
9796
ClassDB::bind_method(D_METHOD("get_max_color_lut_resolution"), &OpenXRFbPassthroughExtensionWrapper::get_max_color_lut_resolution);
9897

9998
ADD_SIGNAL(MethodInfo("openxr_fb_projected_passthrough_layer_created"));

‎doc_classes/KhronosEditorExportPlugin.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="KhronosEditorExportPlugin" inherits="OpenXREditorExportPlugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Editor export plugin for the Khronos OpenXR loader.
45
</brief_description>
56
<description>
7+
Editor export plugin for the Khronos OpenXR loader.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/KhronosEditorPlugin.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="KhronosEditorPlugin" inherits="EditorPlugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Editor plugin for the Khronos OpenXR loader.
45
</brief_description>
56
<description>
7+
Editor plugin for the Khronos OpenXR loader.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/LynxEditorPlugin.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="LynxEditorPlugin" inherits="EditorPlugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Editor plugin for the Lynx OpenXR loader.
45
</brief_description>
56
<description>
7+
Editor plugin for the Lynx OpenXR loader.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/MetaEditorExportPlugin.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="MetaEditorExportPlugin" inherits="OpenXREditorExportPlugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Editor export plugin for the Meta OpenXR loader.
45
</brief_description>
56
<description>
7+
Editor export plugin for the Meta OpenXR loader.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/MetaEditorPlugin.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="MetaEditorPlugin" inherits="EditorPlugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Editor plugin for the Meta OpenXR loader.
45
</brief_description>
56
<description>
7+
Editor plugin for the Meta OpenXR loader.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/OpenXREditorExportPlugin.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXREditorExportPlugin" inherits="EditorExportPlugin" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Common parent for editor export plugins for all OpenXR loaders.
45
</brief_description>
56
<description>
7+
Common parent for editor export plugins for all OpenXR loaders.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/OpenXRFbBodyTrackingExtensionWrapper.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbBodyTrackingExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_body_tracking[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_body_tracking[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/OpenXRFbCompositionLayerAlphaBlendExtensionWrapper.xml

+8
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbCompositionLayerAlphaBlendExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_composition_layer_alpha_blend[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_composition_layer_alpha_blend[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>
911
<constants>
1012
<constant name="BLEND_FACTOR_ZERO" value="0" enum="BlendFactor">
13+
Blending factor set to zero, resulting in no contribution from the source.
1114
</constant>
1215
<constant name="BLEND_FACTOR_ONE" value="1" enum="BlendFactor">
16+
Blending factor set to one, resulting in full contribution from the source.
1317
</constant>
1418
<constant name="BLEND_FACTOR_SRC_ALPHA" value="2" enum="BlendFactor">
19+
Blending factor using the source alpha value.
1520
</constant>
1621
<constant name="BLEND_FACTOR_ONE_MINUS_SRC_ALPHA" value="3" enum="BlendFactor">
22+
Blending factor using one minus the source alpha value.
1723
</constant>
1824
<constant name="BLEND_FACTOR_DST_ALPHA" value="4" enum="BlendFactor">
25+
Blending factor using the destination alpha value.
1926
</constant>
2027
<constant name="BLEND_FACTOR_ONE_MINUS_DST_ALPHA" value="5" enum="BlendFactor">
28+
Blending factor using one minus the destination alpha value.
2129
</constant>
2230
</constants>
2331
</class>

‎doc_classes/OpenXRFbCompositionLayerSecureContentExtensionWrapper.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbCompositionLayerSecureContentExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_composition_layer_secure_content[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_composition_layer_secure_content[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/OpenXRFbCompositionLayerSettingsExtensionWrapper.xml

+8
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbCompositionLayerSettingsExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_composition_layer_settings[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_composition_layer_settings[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>
911
<constants>
1012
<constant name="SUPERSAMPLING_MODE_DISABLED" value="0" enum="SupersamplingMode">
13+
Disable supersampling.
1114
</constant>
1215
<constant name="SUPERSAMPLING_MODE_NORMAL" value="1" enum="SupersamplingMode">
16+
Normal supersampling.
1317
</constant>
1418
<constant name="SUPERSAMPLING_MODE_QUALITY" value="2" enum="SupersamplingMode">
19+
Quality supersampling.
1520
</constant>
1621
<constant name="SHARPENING_MODE_DISABLED" value="0" enum="SharpeningMode">
22+
Disable sharpening.
1723
</constant>
1824
<constant name="SHARPENING_MODE_NORMAL" value="1" enum="SharpeningMode">
25+
Normal sharpening.
1926
</constant>
2027
<constant name="SHARPENING_MODE_QUALITY" value="2" enum="SharpeningMode">
28+
Quality sharpening.
2129
</constant>
2230
</constants>
2331
</class>

‎doc_classes/OpenXRFbFaceTrackingExtensionWrapper.xml

+2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbFaceTrackingExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_face_tracking2[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_face_tracking2[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>

‎doc_classes/OpenXRFbHandTrackingAimExtensionWrapper.xml

+3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbHandTrackingAimExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_hand_tracking_aim[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_hand_tracking_aim[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>
911
<methods>
1012
<method name="is_enabled">
1113
<return type="bool" />
1214
<description>
15+
Checks if the extension is enabled or not.
1316
</description>
1417
</method>
1518
</methods>

‎doc_classes/OpenXRFbHandTrackingCapsulesExtensionWrapper.xml

+8
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,56 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbHandTrackingCapsulesExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_hand_tracking_capsules[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_hand_tracking_capsules[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>
911
<methods>
1012
<method name="get_hand_capsule_count" qualifiers="const">
1113
<return type="int" />
1214
<description>
15+
Gets the total number of hand capsules.
1316
</description>
1417
</method>
1518
<method name="get_hand_capsule_height" qualifiers="const">
1619
<return type="float" />
1720
<param index="0" name="hand_index" type="int" />
1821
<param index="1" name="capsule_index" type="int" />
1922
<description>
23+
Gets the height of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
2024
</description>
2125
</method>
2226
<method name="get_hand_capsule_joint" qualifiers="const">
2327
<return type="int" enum="XRHandTracker.HandJoint" />
2428
<param index="0" name="hand_index" type="int" />
2529
<param index="1" name="capsule_index" type="int" />
2630
<description>
31+
Gets the joint that drives the transform of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
2732
</description>
2833
</method>
2934
<method name="get_hand_capsule_radius" qualifiers="const">
3035
<return type="float" />
3136
<param index="0" name="hand_index" type="int" />
3237
<param index="1" name="capsule_index" type="int" />
3338
<description>
39+
Gets the radius of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
3440
</description>
3541
</method>
3642
<method name="get_hand_capsule_transform" qualifiers="const">
3743
<return type="Transform3D" />
3844
<param index="0" name="hand_index" type="int" />
3945
<param index="1" name="capsule_index" type="int" />
4046
<description>
47+
Gets the transform of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
4148
</description>
4249
</method>
4350
<method name="is_enabled">
4451
<return type="bool" />
4552
<description>
53+
Checks if the extension is enabled or not.
4654
</description>
4755
</method>
4856
</methods>

‎doc_classes/OpenXRFbHandTrackingMesh.xml

+14
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,46 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbHandTrackingMesh" inherits="Skeleton3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
A skinned mesh representing the player's hand (retreived using the [code]XR_FB_hand_tracking_mesh[/code] extension).
45
</brief_description>
56
<description>
7+
A skinned mesh representing the player's hand.
8+
The mesh will be retreived using the [code]XR_FB_hand_tracking_mesh[/code] extension (if supported by the OpenXR runtime and headset) sometime after the OpenXR session has begun.
9+
It can be animated using [XRHandModifier3D].
610
</description>
711
<tutorials>
812
</tutorials>
913
<methods>
1014
<method name="get_mesh_instance" qualifiers="const">
1115
<return type="MeshInstance3D" />
1216
<description>
17+
Gets the [MeshInstance3D] node, if it has been created.
1318
</description>
1419
</method>
1520
</methods>
1621
<members>
1722
<member name="hand" type="int" setter="set_hand" getter="get_hand" enum="OpenXRFbHandTrackingMesh.Hand" default="0">
23+
The hand to retrieve the mesh for.
1824
</member>
1925
<member name="material" type="Material" setter="set_material" getter="get_material">
26+
The material assigned to the hand mesh.
2027
</member>
2128
<member name="scale_override" type="float" setter="set_scale_override" getter="get_scale_override">
29+
A scale multiplier to apply to the mesh.
30+
Only used if [member use_scale_override] is [code]true[/code].
31+
[b]Note: This is a global value that applies to all [OpenXRFbHandTrackingMesh] nodes, which is only provided here for convenience.[/b]
2232
</member>
2333
<member name="use_scale_override" type="bool" setter="set_use_scale_override" getter="get_use_scale_override">
34+
Indicates whether or not [member scale_override] should be used.
35+
[b]Note: This is a global value that applies to all [OpenXRFbHandTrackingMesh] nodes, which is only provided here for convenience.[/b]
2436
</member>
2537
</members>
2638
<constants>
2739
<constant name="Hand::HAND_LEFT" value="0" enum="Hand">
40+
Left hand.
2841
</constant>
2942
<constant name="Hand::HAND_RIGHT" value="1" enum="Hand">
43+
Right hand.
3044
</constant>
3145
</constants>
3246
</class>

‎doc_classes/OpenXRFbHandTrackingMeshExtensionWrapper.xml

+3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="OpenXRFbHandTrackingMeshExtensionWrapper" inherits="OpenXRExtensionWrapperExtension" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4+
Wraps the [code]XR_FB_hand_tracking_mesh[/code] extension.
45
</brief_description>
56
<description>
7+
Wraps the [code]XR_FB_hand_tracking_mesh[/code] extension.
68
</description>
79
<tutorials>
810
</tutorials>
911
<signals>
1012
<signal name="openxr_fb_hand_tracking_mesh_data_fetched">
1113
<param index="0" name="hand_index" type="int" />
1214
<description>
15+
Emitted when the mesh data has been fetched for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
1316
</description>
1417
</signal>
1518
</signals>

0 commit comments

Comments
 (0)