Instance Propertymigueldeicaza.swiftgodot 0.45.0SwiftGodot
sessionMode
The session mode used by initialize when setting up the WebXR session.
final var sessionMode: String { get set }This doesn’t have any effect on the interface when already initialized.
Possible values come from WebXR’s XRSessionMode, including: "immersive-vr", "immersive-ar", and "inline".
Other members in extension
Types
class Signal1Signal support.
class Signal2Signal support.
class Signal3Signal support.
class Signal4Signal support.
class Signal5Signal support.
class Signal6Signal support.
class Signal7Signal support.
class Signal8Signal support.
enum TargetRayMode
Type members
Instance members
var displayRefreshRateChanged: SimpleSignalEmitted after the display’s refresh rate has changed.
var optionalFeatures: StringA comma-seperated list of optional features used by
initializewhen setting up the WebXR session.var referenceSpaceReset: SimpleSignalEmitted to indicate that the reference space has been reset or reconfigured.
var referenceSpaceType: StringThe reference space type (from the list of requested types set in the
requestedReferenceSpaceTypesproperty), that was ultimately used byinitializewhen setting up the WebXR session.var requestedReferenceSpaceTypes: StringA comma-seperated list of reference space types used by
initializewhen setting up the WebXR session.var requiredFeatures: StringA comma-seperated list of required features used by
initializewhen setting up the WebXR session.var select: Signal4Emitted after one of the input sources has finished its “primary action”.
var selectend: Signal5Emitted when one of the input sources has finished its “primary action”.
var selectstart: Signal3Emitted when one of the input source has started its “primary action”.
var sessionEnded: SimpleSignalEmitted when the user ends the WebXR session (which can be done using UI from the browser or device).
var sessionFailed: Signal2Emitted by
initializeif the session fails to start.var sessionStarted: SimpleSignalEmitted by
initializeif the session is successfully started.var sessionSupported: Signal1Emitted by
isSessionSupported(sessionMode:)to indicate if the givensessionModeis supported or not.var squeeze: Signal7Emitted after one of the input sources has finished its “primary squeeze action”.
var squeezeend: Signal8Emitted when one of the input sources has finished its “primary squeeze action”.
var squeezestart: Signal6Emitted when one of the input sources has started its “primary squeeze action”.
var visibilityState: StringIndicates if the WebXR session’s imagery is visible to the user.
var visibilityStateChanged: SimpleSignalEmitted when
visibilityStatehas changed.func getAvailableDisplayRefreshRates() -> GArray Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the web browser and after the interface has been initialized.
func getDisplayRefreshRate() -> Double Returns the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It may not report an accurate value until after using
setDisplayRefreshRate(_:).func getInputSourceTargetRayMode(inputSourceId: Int32) -> WebXRInterface.TargetRayMode Returns the target ray mode for the given
inputSourceId.func getInputSourceTracker(inputSourceId: Int32) -> XRPositionalTracker? Gets an
XRPositionalTrackerfor the giveninputSourceId.func isInputSourceActive(inputSourceId: Int32) -> Bool Returns
trueif there is an active input source with the giveninputSourceId.func isSessionSupported(sessionMode: String) Checks if the given
sessionModeis supported by the user’s browser.func setDisplayRefreshRate(Double) Sets the display refresh rate for the current HMD. Not supported on all HMDs and browsers. It won’t take effect right away until after [signal display_refresh_rate_changed] is emitted.