diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-09-28 10:08:15 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-09-28 10:08:15 +0200 |
| commit | 45d003318863fdb1db634941657f89ef66ddb931 (patch) | |
| tree | 6ede0058004b3a32f810dcb3bda8f72b9749554e /doc | |
| parent | 92bcd3c01d5188480793c03b2b50e97363ceb624 (diff) | |
| parent | 72203a4da40abbf9fbbdca9f9a55b0199b061991 (diff) | |
Merge pull request #65898 from konczg/add_passthrough_extension_wrapper
Add passthrough extension wrapper
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/XRInterface.xml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/classes/XRInterface.xml b/doc/classes/XRInterface.xml index 6296b95e6c..3e48b8284a 100644 --- a/doc/classes/XRInterface.xml +++ b/doc/classes/XRInterface.xml @@ -69,6 +69,18 @@ Is [code]true[/code] if this interface has been initialised. </description> </method> + <method name="is_passthrough_enabled"> + <return type="bool" /> + <description> + Is [code]true[/code] if passthrough is enabled. + </description> + </method> + <method name="is_passthrough_supported"> + <return type="bool" /> + <description> + Is [code]true[/code] if this interface supports passthrough. + </description> + </method> <method name="set_play_area_mode"> <return type="bool" /> <param index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> @@ -76,6 +88,19 @@ Sets the active play area mode, will return [code]false[/code] if the mode can't be used with this interface. </description> </method> + <method name="start_passthrough"> + <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. + </description> + </method> + <method name="stop_passthrough"> + <return type="void" /> + <description> + Stops passthrough. + </description> + </method> <method name="supports_play_area_mode"> <return type="bool" /> <param index="0" name="mode" type="int" enum="XRInterface.PlayAreaMode" /> |