diff options
| author | David Snopek <dsnopek@gmail.com> | 2024-01-30 10:30:54 -0600 |
|---|---|---|
| committer | David Snopek <dsnopek@gmail.com> | 2024-01-31 12:58:22 -0600 |
| commit | 5935bfa8603b7c22df4ea777a688723a408e6c5d (patch) | |
| tree | 5cb3c3453fbb5a2e74442e7902b93e5d3cd35191 /doc | |
| parent | 51991e20143a39e9ef0107163eaf283ca0a761ea (diff) | |
| download | redot-engine-5935bfa8603b7c22df4ea777a688723a408e6c5d.tar.gz | |
OpenXR: Allow changing play area mode during active session
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/XRInterface.xml | 1 | ||||
| -rw-r--r-- | doc/classes/XRServer.xml | 6 |
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 29a5b75672..00ce6e2a8b 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -141,6 +141,7 @@ <param index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> <description> Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface. + [b]Note:[/b] Changing this after the interface has already been initialized can be jarring for the player, so it's recommended to recenter on the HMD with [method XRServer.center_on_hmd] (if switching to [constant XRInterface.XR_PLAY_AREA_STAGE]) or make the switch during a scene change. </description> </method> <method name="start_passthrough"> diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index e98b6f3780..2f106af340 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -37,6 +37,12 @@ You should call this method after a few seconds have passed. For example, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, or when implementing a teleport mechanism. </description> </method> + <method name="clear_reference_frame" qualifiers="const"> + <return type="Transform3D" /> + <description> + Clears the reference frame that was set by previous calls to [method center_on_hmd]. + </description> + </method> <method name="find_interface" qualifiers="const"> <return type="XRInterface" /> <param index="0" name="name" type="String" /> |