Instance Propertymigueldeicaza.swiftgodot 0.45.0SwiftGodot
environmentBlendMode
Specify how XR should blend in the environment. This is specific to certain AR and passthrough devices where camera images are blended in by the XR compositor.
XRInterface.swift:149final var environmentBlendMode: XRInterface.EnvironmentBlendMode { get set }Other members in extension
Types
enum Capabilitiesenum EnvironmentBlendModeenum PlayAreaModeclass Signal1Signal support.
enum TrackingStatus
Type members
Instance members
var arIsAnchorDetectionEnabled: BoolOn an AR interface,
trueif anchor detection is enabled.var interfaceIsPrimary: Booltrueif this is the primary interface.var playAreaChanged: Signal1Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation.
var xrPlayAreaMode: XRInterface.PlayAreaModeThe play area mode for this interface.
func getCameraFeedId() -> Int32 If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the
CameraServerfor this interface.func getCapabilities() -> UInt32 Returns a combination of
Capabilitiesflags providing information about the capabilities of this interface.func getName() -> StringName Returns the name of this interface (OpenXR, OpenVR, OpenHMD, ARKit, etc).
func getPlayArea() -> PackedVector3Array Returns an array of vectors that denotes the physical play area mapped to the virtual space around the
XROrigin3Dpoint. The points form a convex polygon that can be used to react to or visualize the play area. This returns an empty array if this feature is not supported or if the information is not yet available.func getProjectionForView(UInt32, aspect: Double, near: Double, far: Double) -> Projection Returns the projection matrix for a view/eye.
func getRenderTargetSize() -> Vector2 Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.
func getSupportedEnvironmentBlendModes() -> GArray Returns the an array of supported environment blend modes, see
XRInterface.EnvironmentBlendMode.func getSystemInfo() -> GDictionary Returns a
GDictionarywith extra system info. Interfaces are expected to returnXRRuntimeNameandXRRuntimeVersionproviding info about the used XR runtime. Additional entries may be provided specific to an interface.func getTrackingStatus() -> XRInterface.TrackingStatus If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.
func getTransformForView(UInt32, camTransform: Transform3D) -> Transform3D Returns the transform for a view/eye.
func getViewCount() -> UInt32 Returns the number of views that need to be rendered for this device. 1 for Monoscopic, 2 for Stereoscopic.
func initialize() -> Bool Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output.
func isInitialized() -> Bool Is
trueif this interface has been initialized.func isPassthroughEnabled() -> Bool Is
trueif passthrough is enabled.func isPassthroughSupported() -> Bool Is
trueif this interface supports passthrough.func startPassthrough() -> Bool Starts passthrough, will return
falseif passthrough couldn’t be started.func stopPassthrough() Stops passthrough.
func supportsPlayAreaMode(XRInterface.PlayAreaMode) -> Bool Call this to find out if a given play area mode is supported by this interface.
func triggerHapticPulse(actionName: String, trackerName: StringName, frequency: Double, amplitude: Double, durationSec: Double, delaySec: Double) Triggers a haptic pulse on a device associated with this interface.
func uninitialize() Turns the interface off.