summaryrefslogtreecommitdiff
path: root/modules/openxr/doc_classes/OpenXRInteractionProfile.xml
diff options
context:
space:
mode:
Diffstat (limited to 'modules/openxr/doc_classes/OpenXRInteractionProfile.xml')
-rw-r--r--modules/openxr/doc_classes/OpenXRInteractionProfile.xml35
1 files changed, 35 insertions, 0 deletions
diff --git a/modules/openxr/doc_classes/OpenXRInteractionProfile.xml b/modules/openxr/doc_classes/OpenXRInteractionProfile.xml
new file mode 100644
index 0000000000..71c0db44ed
--- /dev/null
+++ b/modules/openxr/doc_classes/OpenXRInteractionProfile.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="OpenXRInteractionProfile" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
+ <brief_description>
+ Suggested bindings object for OpenXR.
+ </brief_description>
+ <description>
+ This object stores suggested bindings for an interaction profile. Interaction profiles define the meta data for a tracked XR device such as an XR controller.
+ For more information see the [url=https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-interaction-profiles]interaction profiles info in the OpenXR specification[/url].
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ <method name="get_binding" qualifiers="const">
+ <return type="OpenXRIPBinding" />
+ <argument index="0" name="index" type="int" />
+ <description>
+ Retrieve the binding at this index.
+ </description>
+ </method>
+ <method name="get_binding_count" qualifiers="const">
+ <return type="int" />
+ <description>
+ Get the number of bindings in this interaction profile.
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="bindings" type="Array" setter="set_bindings" getter="get_bindings" default="[]">
+ Action bindings for this interaction profile.
+ </member>
+ <member name="interaction_profile_path" type="String" setter="set_interaction_profile_path" getter="get_interaction_profile_path" default="&quot;&quot;">
+ The interaction profile path identifying the XR device.
+ </member>
+ </members>
+</class>