diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-02-03 23:19:24 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-02-03 23:19:24 +0100 |
| commit | 673f1614c4def695df28e0e2dc2efba785ef0ad2 (patch) | |
| tree | 3f4a07e4b95449e3a6b5fd9a2b783329b32b2345 /doc | |
| parent | 04650278789bfd23ec0f01755f96e5c02883a291 (diff) | |
| parent | e74a0f4b0986bb6054e4ebad05fb793f64a105e1 (diff) | |
| download | redot-engine-673f1614c4def695df28e0e2dc2efba785ef0ad2.tar.gz | |
Merge pull request #87630 from dsnopek/openxr-passthrough-from-gdextension
OpenXR: Allow moving vendor passthrough extensions to GDExtension
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/XRInterface.xml | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 00ce6e2a8b..6fb43d77d9 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -102,16 +102,18 @@ Is [code]true[/code] if this interface has been initialized. </description> </method> - <method name="is_passthrough_enabled"> + <method name="is_passthrough_enabled" is_deprecated="true"> <return type="bool" /> <description> Is [code]true[/code] if passthrough is enabled. + [i]Deprecated.[/i] Check if [member environment_blend_mode] is [constant XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND], instead. </description> </method> - <method name="is_passthrough_supported"> + <method name="is_passthrough_supported" is_deprecated="true"> <return type="bool" /> <description> Is [code]true[/code] if this interface supports passthrough. + [i]Deprecated.[/i] Check that [constant XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND] is supported using [method get_supported_environment_blend_modes], instead. </description> </method> <method name="set_environment_blend_mode"> @@ -144,17 +146,19 @@ [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"> + <method name="start_passthrough" is_deprecated="true"> <return type="bool" /> <description> Starts passthrough, will return [code]false[/code] if passthrough couldn't be started. [b]Note:[/b] The viewport used for XR must have a transparent background, otherwise passthrough may not properly render. + [i]Deprecated.[/i] Set the [member environment_blend_mode] to [constant XRInterface.XR_ENV_BLEND_MODE_ALPHA_BLEND], instead. </description> </method> - <method name="stop_passthrough"> + <method name="stop_passthrough" is_deprecated="true"> <return type="void" /> <description> Stops passthrough. + [i]Deprecated.[/i] Set the [member environment_blend_mode] to [constant XRInterface.XR_ENV_BLEND_MODE_OPAQUE], instead. </description> </method> <method name="supports_play_area_mode"> |