Skip to content

Commit

Permalink
Finish filling in all of the API docs (#165)
Browse files Browse the repository at this point in the history
  • Loading branch information
dsnopek authored Jun 18, 2024
1 parent 8332d2a commit a90b6fd
Show file tree
Hide file tree
Showing 24 changed files with 174 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ void OpenXRFbPassthroughExtensionWrapper::_bind_methods() {

ClassDB::bind_method(D_METHOD("set_color_lut", "weight", "color_lut"), &OpenXRFbPassthroughExtensionWrapper::set_color_lut);
ClassDB::bind_method(D_METHOD("set_interpolated_color_lut", "weight", "source_color_lut", "target_color_lut"), &OpenXRFbPassthroughExtensionWrapper::set_interpolated_color_lut);
ClassDB::bind_method(D_METHOD("destroy_color_lut", "color_lut"), &OpenXRFbPassthroughExtensionWrapper::destroy_color_lut);
ClassDB::bind_method(D_METHOD("get_max_color_lut_resolution"), &OpenXRFbPassthroughExtensionWrapper::get_max_color_lut_resolution);

ADD_SIGNAL(MethodInfo("openxr_fb_projected_passthrough_layer_created"));
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/KhronosEditorExportPlugin.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Editor export plugin for the Khronos OpenXR loader.
</brief_description>
<description>
Editor export plugin for the Khronos OpenXR loader.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/KhronosEditorPlugin.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Editor plugin for the Khronos OpenXR loader.
</brief_description>
<description>
Editor plugin for the Khronos OpenXR loader.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/LynxEditorPlugin.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Editor plugin for the Lynx OpenXR loader.
</brief_description>
<description>
Editor plugin for the Lynx OpenXR loader.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/MetaEditorExportPlugin.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Editor export plugin for the Meta OpenXR loader.
</brief_description>
<description>
Editor export plugin for the Meta OpenXR loader.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/MetaEditorPlugin.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Editor plugin for the Meta OpenXR loader.
</brief_description>
<description>
Editor plugin for the Meta OpenXR loader.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/OpenXREditorExportPlugin.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Common parent for editor export plugins for all OpenXR loaders.
</brief_description>
<description>
Common parent for editor export plugins for all OpenXR loaders.
</description>
<tutorials>
</tutorials>
Expand Down
2 changes: 2 additions & 0 deletions doc_classes/OpenXRFbBodyTrackingExtensionWrapper.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_body_tracking[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_body_tracking[/code] extension.
</description>
<tutorials>
</tutorials>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_composition_layer_alpha_blend[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_composition_layer_alpha_blend[/code] extension.
</description>
<tutorials>
</tutorials>
<constants>
<constant name="BLEND_FACTOR_ZERO" value="0" enum="BlendFactor">
Blending factor set to zero, resulting in no contribution from the source.
</constant>
<constant name="BLEND_FACTOR_ONE" value="1" enum="BlendFactor">
Blending factor set to one, resulting in full contribution from the source.
</constant>
<constant name="BLEND_FACTOR_SRC_ALPHA" value="2" enum="BlendFactor">
Blending factor using the source alpha value.
</constant>
<constant name="BLEND_FACTOR_ONE_MINUS_SRC_ALPHA" value="3" enum="BlendFactor">
Blending factor using one minus the source alpha value.
</constant>
<constant name="BLEND_FACTOR_DST_ALPHA" value="4" enum="BlendFactor">
Blending factor using the destination alpha value.
</constant>
<constant name="BLEND_FACTOR_ONE_MINUS_DST_ALPHA" value="5" enum="BlendFactor">
Blending factor using one minus the destination alpha value.
</constant>
</constants>
</class>
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_composition_layer_secure_content[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_composition_layer_secure_content[/code] extension.
</description>
<tutorials>
</tutorials>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_composition_layer_settings[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_composition_layer_settings[/code] extension.
</description>
<tutorials>
</tutorials>
<constants>
<constant name="SUPERSAMPLING_MODE_DISABLED" value="0" enum="SupersamplingMode">
Disable supersampling.
</constant>
<constant name="SUPERSAMPLING_MODE_NORMAL" value="1" enum="SupersamplingMode">
Normal supersampling.
</constant>
<constant name="SUPERSAMPLING_MODE_QUALITY" value="2" enum="SupersamplingMode">
Quality supersampling.
</constant>
<constant name="SHARPENING_MODE_DISABLED" value="0" enum="SharpeningMode">
Disable sharpening.
</constant>
<constant name="SHARPENING_MODE_NORMAL" value="1" enum="SharpeningMode">
Normal sharpening.
</constant>
<constant name="SHARPENING_MODE_QUALITY" value="2" enum="SharpeningMode">
Quality sharpening.
</constant>
</constants>
</class>
2 changes: 2 additions & 0 deletions doc_classes/OpenXRFbFaceTrackingExtensionWrapper.xml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_face_tracking2[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_face_tracking2[/code] extension.
</description>
<tutorials>
</tutorials>
Expand Down
3 changes: 3 additions & 0 deletions doc_classes/OpenXRFbHandTrackingAimExtensionWrapper.xml
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_hand_tracking_aim[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_hand_tracking_aim[/code] extension.
</description>
<tutorials>
</tutorials>
<methods>
<method name="is_enabled">
<return type="bool" />
<description>
Checks if the extension is enabled or not.
</description>
</method>
</methods>
Expand Down
8 changes: 8 additions & 0 deletions doc_classes/OpenXRFbHandTrackingCapsulesExtensionWrapper.xml
Original file line number Diff line number Diff line change
@@ -1,48 +1,56 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_hand_tracking_capsules[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_hand_tracking_capsules[/code] extension.
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_hand_capsule_count" qualifiers="const">
<return type="int" />
<description>
Gets the total number of hand capsules.
</description>
</method>
<method name="get_hand_capsule_height" qualifiers="const">
<return type="float" />
<param index="0" name="hand_index" type="int" />
<param index="1" name="capsule_index" type="int" />
<description>
Gets the height of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
</description>
</method>
<method name="get_hand_capsule_joint" qualifiers="const">
<return type="int" enum="XRHandTracker.HandJoint" />
<param index="0" name="hand_index" type="int" />
<param index="1" name="capsule_index" type="int" />
<description>
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).
</description>
</method>
<method name="get_hand_capsule_radius" qualifiers="const">
<return type="float" />
<param index="0" name="hand_index" type="int" />
<param index="1" name="capsule_index" type="int" />
<description>
Gets the radius of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
</description>
</method>
<method name="get_hand_capsule_transform" qualifiers="const">
<return type="Transform3D" />
<param index="0" name="hand_index" type="int" />
<param index="1" name="capsule_index" type="int" />
<description>
Gets the transform of the given capsule for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
</description>
</method>
<method name="is_enabled">
<return type="bool" />
<description>
Checks if the extension is enabled or not.
</description>
</method>
</methods>
Expand Down
14 changes: 14 additions & 0 deletions doc_classes/OpenXRFbHandTrackingMesh.xml
Original file line number Diff line number Diff line change
@@ -1,32 +1,46 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
A skinned mesh representing the player's hand (retreived using the [code]XR_FB_hand_tracking_mesh[/code] extension).
</brief_description>
<description>
A skinned mesh representing the player's hand.
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.
It can be animated using [XRHandModifier3D].
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_mesh_instance" qualifiers="const">
<return type="MeshInstance3D" />
<description>
Gets the [MeshInstance3D] node, if it has been created.
</description>
</method>
</methods>
<members>
<member name="hand" type="int" setter="set_hand" getter="get_hand" enum="OpenXRFbHandTrackingMesh.Hand" default="0">
The hand to retrieve the mesh for.
</member>
<member name="material" type="Material" setter="set_material" getter="get_material">
The material assigned to the hand mesh.
</member>
<member name="scale_override" type="float" setter="set_scale_override" getter="get_scale_override">
A scale multiplier to apply to the mesh.
Only used if [member use_scale_override] is [code]true[/code].
[b]Note: This is a global value that applies to all [OpenXRFbHandTrackingMesh] nodes, which is only provided here for convenience.[/b]
</member>
<member name="use_scale_override" type="bool" setter="set_use_scale_override" getter="get_use_scale_override">
Indicates whether or not [member scale_override] should be used.
[b]Note: This is a global value that applies to all [OpenXRFbHandTrackingMesh] nodes, which is only provided here for convenience.[/b]
</member>
</members>
<constants>
<constant name="Hand::HAND_LEFT" value="0" enum="Hand">
Left hand.
</constant>
<constant name="Hand::HAND_RIGHT" value="1" enum="Hand">
Right hand.
</constant>
</constants>
</class>
3 changes: 3 additions & 0 deletions doc_classes/OpenXRFbHandTrackingMeshExtensionWrapper.xml
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
Wraps the [code]XR_FB_hand_tracking_mesh[/code] extension.
</brief_description>
<description>
Wraps the [code]XR_FB_hand_tracking_mesh[/code] extension.
</description>
<tutorials>
</tutorials>
<signals>
<signal name="openxr_fb_hand_tracking_mesh_data_fetched">
<param index="0" name="hand_index" type="int" />
<description>
Emitted when the mesh data has been fetched for the given hand ([code]0[/code] is left, and [code]1[/code] is right).
</description>
</signal>
</signals>
Expand Down
Loading

0 comments on commit a90b6fd

Please sign in to comment.