summaryrefslogtreecommitdiffstats
path: root/modules/openxr/doc_classes
diff options
context:
space:
mode:
authorBastiaan Olij <mux213@gmail.com>2024-03-21 18:58:24 +1100
committerBastiaan Olij <mux213@gmail.com>2024-05-01 14:24:41 +1000
commitcbab7dc04942ccb07a2ca0bc942498a319e57e35 (patch)
treecbdea1856b04a1e1b6f0c9eb388dd73246306490 /modules/openxr/doc_classes
parentd282e4f0e6b6ebcf3bd6e05cd62f2a8fe1f9a238 (diff)
downloadredot-engine-cbab7dc04942ccb07a2ca0bc942498a319e57e35.tar.gz
OpenXR: Change timing of xrWaitFrame and add thread safety features to OpenXR
Diffstat (limited to 'modules/openxr/doc_classes')
-rw-r--r--modules/openxr/doc_classes/OpenXRAPIExtension.xml8
-rw-r--r--modules/openxr/doc_classes/OpenXRInterface.xml10
2 files changed, 17 insertions, 1 deletions
diff --git a/modules/openxr/doc_classes/OpenXRAPIExtension.xml b/modules/openxr/doc_classes/OpenXRAPIExtension.xml
index f737f3b642..4419d24dd3 100644
--- a/modules/openxr/doc_classes/OpenXRAPIExtension.xml
+++ b/modules/openxr/doc_classes/OpenXRAPIExtension.xml
@@ -54,7 +54,7 @@
<method name="get_next_frame_time">
<return type="int" />
<description>
- Returns the timing for the next frame.
+ Returns the predicted display timing for the next frame.
</description>
</method>
<method name="get_play_space">
@@ -63,6 +63,12 @@
Returns the play space, which is an [url=https://registry.khronos.org/OpenXR/specs/1.0/man/html/XrSpace.html]XrSpace[/url] cast to an integer.
</description>
</method>
+ <method name="get_predicted_display_time">
+ <return type="int" />
+ <description>
+ Returns the predicted display timing for the current frame.
+ </description>
+ </method>
<method name="get_session">
<return type="int" />
<description>
diff --git a/modules/openxr/doc_classes/OpenXRInterface.xml b/modules/openxr/doc_classes/OpenXRInterface.xml
index 05dff7d6ae..9ae59a12af 100644
--- a/modules/openxr/doc_classes/OpenXRInterface.xml
+++ b/modules/openxr/doc_classes/OpenXRInterface.xml
@@ -147,6 +147,11 @@
</member>
</members>
<signals>
+ <signal name="instance_exiting">
+ <description>
+ Informs our OpenXR instance is exiting.
+ </description>
+ </signal>
<signal name="pose_recentered">
<description>
Informs the user queued a recenter of the player position.
@@ -169,6 +174,11 @@
Informs our OpenXR session now has focus.
</description>
</signal>
+ <signal name="session_loss_pending">
+ <description>
+ Informs our OpenXR session is in the process of being lost.
+ </description>
+ </signal>
<signal name="session_stopping">
<description>
Informs our OpenXR session is stopping.