summaryrefslogtreecommitdiffstats
path: root/modules
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-03-01 17:22:18 +0100
committerRémi Verschelde <rverschelde@gmail.com>2024-03-01 17:22:18 +0100
commit34effe41dc71691aaf7b802a398f7a83c640a5f1 (patch)
treeae5315db11a5fd8d0a82da048b285387bfaa7d5b /modules
parentc10463fba4e790b04481c34002ff70a60f3ce93b (diff)
parentc54e09a5a304c1578689f5b98cfee41c24d95848 (diff)
downloadredot-engine-34effe41dc71691aaf7b802a398f7a83c640a5f1.tar.gz
Merge pull request #89036 from Mickeon/documentation-uncommon-words-2
Overhaul some "uncommon" wording in class reference
Diffstat (limited to 'modules')
-rw-r--r--modules/openxr/doc_classes/OpenXRAction.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/modules/openxr/doc_classes/OpenXRAction.xml b/modules/openxr/doc_classes/OpenXRAction.xml
index 6a3529e43e..2a9f255f2f 100644
--- a/modules/openxr/doc_classes/OpenXRAction.xml
+++ b/modules/openxr/doc_classes/OpenXRAction.xml
@@ -4,7 +4,7 @@
An OpenXR action.
</brief_description>
<description>
- This resource defines an OpenXR action. Actions can be used both for inputs (buttons/joystick/trigger/etc) and outputs (haptics).
+ This resource defines an OpenXR action. Actions can be used both for inputs (buttons, joysticks, triggers, etc.) and outputs (haptics).
OpenXR performs automatic conversion between action type and input type whenever possible. An analog trigger bound to a boolean action will thus return [code]false[/code] if the trigger is depressed and [code]true[/code] if pressed fully.
Actions are not directly bound to specific devices, instead OpenXR recognizes a limited number of top level paths that identify devices by usage. We can restrict which devices an action can be bound to by these top level paths. For instance an action that should only be used for hand held controllers can have the top level paths "/user/hand/left" and "/user/hand/right" associated with them. See the [url=https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#semantic-path-reserved]reserved path section in the OpenXR specification[/url] for more info on the top level paths.
Note that the name of the resource is used to register the action with.