godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #93633 from dsnopek/webxr-hand-tracking-api-docs 

Improve WebXR API docs related to hand tracking support
This commit is contained in:
Rémi Verschelde 2024-06-26 18:15:31 +02:00
parent d119e49902 ef3fbf0091
commit 374807f427
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
modules/webxr/doc_classes/WebXRInterface.xml
View File

@ -54,9 +54,10 @@
# supported. # supported.
webxr_interface.requested_reference_space_types = 'bounded-floor, local-floor, local' webxr_interface.requested_reference_space_types = 'bounded-floor, local-floor, local'
# In order to use 'local-floor' or 'bounded-floor' we must also # In order to use 'local-floor' or 'bounded-floor' we must also
# mark the features as required or optional. # mark the features as required or optional. By including 'hand-tracking'
# as an optional feature, it will be enabled if supported.
webxr_interface.required_features = 'local-floor' webxr_interface.required_features = 'local-floor'
webxr_interface.optional_features = 'bounded-floor' webxr_interface.optional_features = 'bounded-floor, hand-tracking'
# This will return false if we're unable to even request the session, # This will return false if we're unable to even request the session,
# however, it can still fail asynchronously later in the process, so we # however, it can still fail asynchronously later in the process, so we
@ -73,7 +74,10 @@
# This will be the reference space type you ultimately got, out of the # This will be the reference space type you ultimately got, out of the
# types that you requested above. This is useful if you want the game to # types that you requested above. This is useful if you want the game to
# work a little differently in 'bounded-floor' versus 'local-floor'. # work a little differently in 'bounded-floor' versus 'local-floor'.
print ("Reference space type: " + webxr_interface.reference_space_type) print("Reference space type: ", webxr_interface.reference_space_type)
# This will be the list of features that were successfully enabled
# (except on browsers that don't support this property).
print("Enabled features: ", webxr_interface.enabled_features)
func _webxr_session_ended(): func _webxr_session_ended():
$Button.visible = true $Button.visible = true
@ -155,13 +159,14 @@
<members> <members>
<member name="enabled_features" type="String" setter="" getter="get_enabled_features"> <member name="enabled_features" type="String" setter="" getter="get_enabled_features">
A comma-separated list of features that were successfully enabled by [method XRInterface.initialize] when setting up the WebXR session. A comma-separated list of features that were successfully enabled by [method XRInterface.initialize] when setting up the WebXR session.
This may include features requested by setting [member required_features] and [member optional_features]. This may include features requested by setting [member required_features] and [member optional_features], and will only be available after [signal session_started] has been emitted.
[b]Note:[/b] This may not be support by all web browsers, in which case it will be an empty string.
</member> </member>
<member name="optional_features" type="String" setter="set_optional_features" getter="get_optional_features"> <member name="optional_features" type="String" setter="set_optional_features" getter="get_optional_features">
A comma-seperated list of optional features used by [method XRInterface.initialize] when setting up the WebXR session. A comma-seperated list of optional features used by [method XRInterface.initialize] when setting up the WebXR session.
If a user's browser or device doesn't support one of the given features, initialization will continue, but you won't be able to use the requested feature. If a user's browser or device doesn't support one of the given features, initialization will continue, but you won't be able to use the requested feature.
This doesn't have any effect on the interface when already initialized. This doesn't have any effect on the interface when already initialized.
Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType]WebXR's XRReferenceSpaceType[/url]. If you want to use a particular reference space type, it must be listed in either [member required_features] or [member optional_features]. Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType]WebXR's XRReferenceSpaceType[/url], or include other features like [code]"hand-tracking"[/code] to enable hand tracking.
</member> </member>
<member name="reference_space_type" type="String" setter="" getter="get_reference_space_type"> <member name="reference_space_type" type="String" setter="" getter="get_reference_space_type">
The reference space type (from the list of requested types set in the [member requested_reference_space_types] property), that was ultimately used by [method XRInterface.initialize] when setting up the WebXR session. The reference space type (from the list of requested types set in the [member requested_reference_space_types] property), that was ultimately used by [method XRInterface.initialize] when setting up the WebXR session.
@ -177,7 +182,7 @@
A comma-seperated list of required features used by [method XRInterface.initialize] when setting up the WebXR session. A comma-seperated list of required features used by [method XRInterface.initialize] when setting up the WebXR session.
If a user's browser or device doesn't support one of the given features, initialization will fail and [signal session_failed] will be emitted. If a user's browser or device doesn't support one of the given features, initialization will fail and [signal session_failed] will be emitted.
This doesn't have any effect on the interface when already initialized. This doesn't have any effect on the interface when already initialized.
Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType]WebXR's XRReferenceSpaceType[/url]. If you want to use a particular reference space type, it must be listed in either [member required_features] or [member optional_features]. Possible values come from [url=https://developer.mozilla.org/en-US/docs/Web/API/XRReferenceSpaceType]WebXR's XRReferenceSpaceType[/url], or include other features like [code]"hand-tracking"[/code] to enable hand tracking.
</member> </member>
<member name="session_mode" type="String" setter="set_session_mode" getter="get_session_mode"> <member name="session_mode" type="String" setter="set_session_mode" getter="get_session_mode">
The session mode used by [method XRInterface.initialize] when setting up the WebXR session. The session mode used by [method XRInterface.initialize] when setting up the WebXR session.