UnityEngine.VRModule

A collection of methods and properties for interacting with the XR tracking system.

Disables positional tracking in XR. This takes effect the next time the head pose is sampled. If set to true the camera only tracks headset rotation state.

Called when a tracked node is added to the underlying XR system.

Describes the node that has been added.

Called when a tracked node is removed from the underlying XR system.

Describes the node that has been removed.

Called when a tracked node begins reporting tracking information.

Describes the node that has begun being tracked.

Called when a tracked node stops reporting tracking information.

Describes the node that has lost tracking.

Gets the position of a specific node.

Specifies which node's position should be returned. The position of the node in its local tracking space.

Gets the rotation of a specific node.

Specifies which node's rotation should be returned. The rotation of the node in its local tracking space.

Accepts the unique identifier for a tracked node and returns a friendly name for it.

The unique identifier for the Node index. The name of the tracked node if the given 64-bit identifier maps to a currently tracked node. Empty string otherwise.

Describes all presently connected XR nodes and provides available tracking state.

A list that is populated with XR.XRNodeState objects.

Center tracking to the current position and orientation of the HMD.

Represents the size of physical space available for XR.

Represents a space large enough for free movement.

Represents a small space where movement may be constrained or positional tracking is unavailable.

Represents the current user presence state detected by the device.

The device does not detect that the user is present.

The device detects that the user is present.

The device is currently in a state where it cannot determine user presence.

The device does not support detecting user presence.

The Holographic Settings contain functions which effect the performance and presentation of Holograms on Windows Holographic platforms.

Option to allow developers to achieve higher framerate at the cost of high latency. By default this option is off.

True to enable or false to disable Low Latent Frame Presentation.

Represents the kind of reprojection an app is requesting to stabilize its holographic rendering relative to the user's head motion.

The image should not be stabilized for the user's head motion, instead remaining fixed in the display. This is generally discouraged, as it is only comfortable for users when used sparingly, such as when the only visible content is a small cursor.

The image should be stabilized only for changes to the user's head orientation, ignoring positional changes. This is best for body-locked content that should tag along with the user as they walk around, such as 360-degree video.

The image should be stabilized for changes to both the user's head position and orientation. This is best for world-locked content that should remain physically stationary as the user walks around.

Whether the app is displaying protected content.

This method returns whether or not the display associated with the main camera reports as opaque.

Returns true if Holographic rendering is currently running with Latent Frame Presentation. Default value is false.

The kind of reprojection the app is requesting to stabilize its holographic rendering relative to the user's head motion.

Sets a point in 3d space that is the focal point of the scene for the user for this frame. This helps improve the visual fidelity of content around this point. This must be set every frame.

The position of the focal point in the scene, relative to the camera. Surface normal of the plane being viewed at the focal point. A vector that describes how the focus point is moving in the scene at this point in time. This allows the HoloLens to compensate for both your head movement and the movement of the object in the scene.

Sets a point in 3d space that is the focal point of the scene for the user for this frame. This helps improve the visual fidelity of content around this point. This must be set every frame.

The position of the focal point in the scene, relative to the camera. Surface normal of the plane being viewed at the focal point. A vector that describes how the focus point is moving in the scene at this point in time. This allows the HoloLens to compensate for both your head movement and the movement of the object in the scene.

Sets a point in 3d space that is the focal point of the scene for the user for this frame. This helps improve the visual fidelity of content around this point. This must be set every frame.

The position of the focal point in the scene, relative to the camera. Surface normal of the plane being viewed at the focal point. A vector that describes how the focus point is moving in the scene at this point in time. This allows the HoloLens to compensate for both your head movement and the movement of the object in the scene.

Contains fields that are relevant during an error event.

A readable error string (when possible).

The HRESULT code from the platform.

Manager class with API for recognizing user gestures.

Cancels any pending gesture events. Additionally this will call StopCapturingGestures.

Create a GestureRecognizer.

Disposes the resources used by gesture recognizer.

Fires when Microsoft's gesture-recognition system encounters a warning or error.

Callback indicating an error or warning occurred.

A readable error string (when possible). The HRESULT code from the platform.

Fired when a warning or error is emitted by the GestureRecognizer.

Delegate to be triggered to report warnings and errors.

Retrieve a mask of the currently enabled gestures.

A mask indicating which Gestures are currently recognizable.

Fires when Microsoft's gesture-recognition system recognizers that a user has canceled a hold gesture.

Fired when the user does a cancel event either using their hands or in speech.

Delegate to be triggered when a cancel event is triggered.

Callback indicating a cancel event.

Indicates which input medium triggered this event. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizers that a user has completed a hold gesture.

Fired when users complete a hold gesture.

Delegate to be triggered when the user completes a hold gesture.

Callback indicating a hold completed event.

Indicates which input medium triggered this event. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a user has started a hold gesture.

Fired when users start a hold gesture.

The delegate to be triggered when a user starts a hold gesture.

Callback indicating a hold started event.

Indicates which input medium triggered this event. Ray (with normalized direction) from user at the time this gesture began.

Used to query if the GestureRecognizer is currently receiving Gesture events.

True if the GestureRecognizer is receiving events or false otherwise.

Fires when Microsoft's gesture-recognition system recognizes that a user has canceled a manipulation gesture.

Fires when a Manipulation gesture is canceled.

Delegate to be triggered when a cancel event is triggered.

Callback indicating a cancel event.

Indicates which input medium triggered this event. Total distance moved since the beginning of the manipulation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a user has completed a manipulation gesture.

Fires when a Manipulation gesture is completed.

Delegate to be triggered when a completed event is triggered.

Callback indicating a completed event.

Indicates which input medium triggered this event. Total distance moved since the beginning of the manipulation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a user has started a manipulation gesture.

Fires when an interaction becomes a Manipulation gesture.

Delegate to be triggered when a started event is triggered.

Callback indicating a started event.

Indicates which input medium triggered this event. Total distance moved since the beginning of the manipulation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a user has updated a manipulation gesture.

Fires when a Manipulation gesture is updated due to hand movement.

Delegate to be triggered when a updated event is triggered.

Callback indicating a updated event.

Indicates which input medium triggered this event. Total distance moved since the beginning of the manipulation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a user has canceled a navigation gesture.

Fires when a Navigation gesture is canceled.

Delegate to be triggered when a cancel event is triggered.

Callback indicating a cancel event.

Indicates which input medium triggered this event. The last known normalized offset of the input within the unit cube for the navigation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a navigation gesture completes.

Fires when a Navigation gesture is completed.

Delegate to be triggered when a complete event is triggered.

Callback indicating a completed event.

Indicates which input medium triggered this event. The last known normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that a user has started a navigation gesture.

Fires when an interaction becomes a Navigation gesture.

Delegate to be triggered when a started event is triggered.

Callback indicating a started event.

Indicates which input medium triggered this event. The normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when Microsoft's gesture-recognition system recognizes that navigation gesture has updated.

Fires when a Navigation gesture is updated due to hand or controller movement.

Delegate to be triggered when a update event is triggered.

Callback indicating a update event.

Indicates which input medium triggered this event. The last known normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture. Ray (with normalized direction) from user at the time this gesture began.

Fires when recognition of gestures is done, either due to completion of a gesture or cancellation.

Fires when recognition of gestures is done, either due to completion of a gesture or cancellation.

Delegate to be triggered when an end event is triggered.

Callback indicating the gesture event has completed.

Indicates which input medium triggered this event. Ray (with normalized direction) from user at the time a gesture began.

Fires when recognition of gestures begins.

Fires when recognition of gestures begins.

Delegate to be triggered when a start event is triggered.

Callback indicating the gesture event has started.

Indicates which input medium triggered this event. Ray (with normalized direction) from user at the time a gesture began.

Set the recognizable gestures to the ones specified in newMaskValues and return the old settings.

A mask indicating which gestures are now recognizable. The previous value.

Call to begin receiving gesture events on this recognizer. No events will be received until this method is called.

Call to stop receiving gesture events on this recognizer.

Fires when Microsoft's gesture-recognition system recognizes that a user has done a tap gesture and after the system voice command "Select" has been processed. For controllers, this event fires when the primary button is released after it was pressed.

Occurs when a Tap gesture is recognized.

Delegate to be triggered when a tap event is triggered.

Callback indicating a tap event.

Indicates which input medium triggered this event. The count of taps (1 for single tap, 2 for double tap). Ray (with normalized direction) from user at the time this event interaction began.

This enumeration represents the set of gestures that may be recognized by GestureRecognizer.

Enable support for the double-tap gesture.

Enable support for the hold gesture.

Enable support for the manipulation gesture which tracks changes to the hand's position. This gesture is relative to the start position of the gesture and measures an absolute movement through the world.

Enable support for the navigation gesture, in the horizontal axis using rails (guides).

Enable support for the navigation gesture, in the vertical axis using rails (guides).

Enable support for the navigation gesture, in the depth axis using rails (guides).

Enable support for the navigation gesture, in the horizontal axis.

Enable support for the navigation gesture, in the vertical axis.

Enable support for the navigation gesture, in the depth axis.

Disable support for gestures.

Enable support for the tap gesture.

Contains fields that are relevant when a user cancels a hold gesture.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that canceled the hold gesture.

Represents pose data of the input source, such as a hand or controller, when the gesture occurred.

Contains fields that are relevant when a hold gesture completes.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that completed the hold gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a hold gesture starts.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that started the hold gesture.

Pose data of the interaction source at the time of the gesture.

Provides access to user input from hands, controllers, and system voice commands.

(Read Only) The number of InteractionSourceState snapshots available for reading with InteractionManager.GetCurrentReading.

Get the current SourceState.

An array of InteractionSourceState snapshots.

Allows retrieving the current source states without allocating an array. The number of retrieved source states will be returned, up to a maximum of the size of the array.

An array for storing InteractionSourceState snapshots. The number of snapshots stored in the array, up to the size of the array.

Occurs when a new hand, controller, or source of voice commands has been detected.

Occurs when a new hand, controller, or source of voice commands has been detected.

Occurs when a hand, controller, or source of voice commands is no longer available.

Occurs when a hand, controller, or source of voice commands is no longer available.

Occurs when a hand or controller has entered the pressed state.

Occurs when a hand or controller has entered the pressed state.

Occurs when a hand or controller has exited the pressed state.

Occurs when a hand or controller has exited the pressed state.

Occurs when a hand or controller has experienced a change to its SourceState.

Occurs when a hand or controller has experienced a change to its SourceState.

Callback to handle InteractionManager events.

Represents one detected instance of an interaction source (hand, controller, or user's voice) that can cause interactions and gestures.

Denotes which hand was used as the input source.

The identifier for the interaction source (hand, controller, or user's voice).

Specifies the kind of an interaction source.

Following the make and model nomenclature of cars, this equates to the model number.

Following the make and model nomenclature of cars, this would be a minor update to the model.

This property returns true when the interaction source has at least one grasp button, and false if otherwise.

This property returns true when the interaction source has a menu button, and false if otherwise.

This property returns true if the interaction source has a separate pose for the pointer, and false if otherwise.

Returns true if the interaction source has a thumbstick, and false if otherwise.

Returns true if the interaction source has a touchpad, and false if otherwise.

All interaction sources developed by the same company will have the same vendor ID.

Contains fields that are relevent when an interaction source is detected.

The current state of the reported interaction source that was just detected.

Denotes which hand was used as the input source.

Specifies the kind of an interaction source.

The interaction source is of a kind not known in this version of the API.

The interaction source is one of the user's hands.

The interaction source is of a kind not known in this version of the API.

The interaction source is the user's speech.

Represents the position and velocity of a hand or controller - this has been deprecated. Use InteractionSourcePose instead.

Get the position of the interaction - this has been deprecated. Use InteractionSourcePose instead.

Supplied Vector3 to be populated with interaction position. True if the position is successfully returned.

Get the velocity of the interaction - this has been deprecated. Use InteractionSourcePose instead.

Supplied Vector3 to be populated with interaction velocity. True if the velocity is successfully returned.

Contains fields that are relevent when an interaction source is lost.

The current state of the reported interaction source that was just lost.

Specifies which part of the controller to query pose information for.

The grip of the controller.

The pointer of the controller.

Pose data of the interaction source at the time of either the gesture or interaction.

The position-tracking accuracy of the interaction source.

Attempts to retrieve a Vector3 representing the current angular velocity of the tracked node.

If the function returns true, this will be filled out with the angular velocity of the interaction source. If the function returns false, the value filled out should not be used. True if the angular velocity was set in the output parameter. False if the angular velocity is not available due to limitations of the underlying platform or if the node is not presently tracked.

Gets the forward vector of the interaction source, assuming rotation is valid.

The forward vector of the interaction source, if the function returns true. Specifies which part of the controller to query for its forward vector. This method returns true when the rotation is valid and the Vector3 passed in was filled out correctly, and false if otherwise.

Gets the position of the interaction source, assuming the backing data is valid.

The position of the interaction source, is the function returns true. Specifies which part of the controller to query for its position. This method returns true when the Vector3 passed in was filled out correctly, and false if otherwise.

Gets the right vector of the interaction source, assuming rotation is valid.

The right vector of the interaction source, if the function returns true. Specifies which part of the controller to query for its right vector. This method returns true if rotation is valid and the Vector3 passed in was filled out correctly, and false if otherwise.

Gets the rotation of the interaction source, assuming the backing data is valid.

Specifies which part of the controller to query for its rotation. The rotation of the interaction source, if the function returns true. This method returns true if the Quaternion passed in was filled out correctly, and false if otherwise.

Gets the up vector of the interaction source, assuming rotation is valid.

The up vector of the interaction source, if the function returns true. Specifies which part of the controller to query for its up vector. Returns true if the rotation is valid and the Vector3 passed in was filled out correctly, and false if otherwise.

Gets the velocity of the interaction source, assuming the backing data is valid.

The velocity of the interaction source, if the function returns true. Returns true if the Vector3 passed in was filled out correctly, and false if otherwise.

Denotes the accuracy of tracking on the interaction source.

A position accuracy of Approximate reports that you may not want to fully trust the positions reported, as the position is inferred or synthesized in some way, such as the controller leaving the sensors' field of view and forcing the API to rely on the device's IMU instead of visual tracking.

A position accuracy of High reports that you can fully trust the position, as the interaction source is within the sensors' visual field of view.

A position accuracy of None reports that there is no position accuracy, as the interaction source unlocatable.

Contains fields that are relevent when an interaction source enters the pressed state for one of its buttons.

Denotes the type of button that was just pressed.

The current state of the reported interaction source that just had one of its buttons enter the pressed state.

The type of button or controller feature pressed, if any.

These buttons are generally found on the side of the controller. Some hardware has more than one grasp button.

This button is marked with three horizontal lines, same as you would fine on an Xbox One controller.

Depending on the InteractionSourceType of the interaction source, this could be a number of equivalent things: main button on a blicker, air-tap on a hand, and the trigger on a motion controller.

Similar to the touchpad, moving the thumbstick won't count as pressing it - a press will occur when pressing down on the thumbstick enough.

A touchpad only counts as pressed when it's held down enough - otherwise, it's just touched, and will give a reading of the position through InteractionSourceState.touchpadPosition.

Represents the set of properties available to explore the current state of a hand or controller.

The position and velocity of the hand, expressed in the specified coordinate system - this has been deprecated. Use InteractionSourcePose instead.

The direction you should suggest that the user move their hand if it is nearing the edge of the detection area.

Gets the risk that detection of the hand will be lost as a value from 0.0 to 1.0.

Contains fields that are relevent when an interaction source exits the pressed state for one of its buttons.

Denotes the type of button that was just released.

The current state of the reported interaction source that just had one of its buttons exit the pressed state.

Represents a snapshot of the state of a spatial interaction source (hand, voice or controller) at a given time.

True if the source is in the pressed state.

Whether the controller is grasped.

Head pose of the user at the time of the interaction.

The Ray at the time represented by this InteractionSourceState.

Whether or not the menu button is pressed.

True if the source is in the pressed state, false otherwise.

Additional properties to explore the state of the interaction source.

Depending on the InteractionSourceType of the interaction source, this returning true could represent a number of equivalent things: main button on a clicker, air-tap on a hand, and the trigger on a motion controller. For hands, a select-press represents the user's index finger in the down position. For motion controllers, a select-press represents the controller's index-finger trigger (or primary face button, if no trigger) being fully pressed. Note that a voice command of "Select" causes an instant press and release, so you cannot poll for a voice press using this property - instead, you must use GestureRecognizer and subscribe to the Tapped event, or subscribe to the InteractionSourcePressed event from InteractionManager.

Normalized amount ([0, 1]) representing how much select is pressed.

The interaction source that this state describes.

Pose data of the interaction source at the time of the interaction.

Normalized coordinates for the position of a thumbstick.

Whether or not the thumbstick is pressed.

Normalized coordinates for the position of a touchpad interaction.

Whether or not the touchpad is pressed, as if a button.

Whether or not the touchpad is touched.

Contains fields that are relevent when an interaction source updates.

The current state of the reported interaction source that just updated.

Contains fields that are relevant when a manipulation gesture is canceled.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that canceled the manipulation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a manipulation gesture completes.

Total distance moved since the beginning of the manipulation gesture.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that completed the manipulation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields relevant when a manipulation gesture starts.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that started the manipulation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a manipulation gesture gets updated.

Total distance moved since the beginning of the manipulation gesture.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) being used for the manipulation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a navigation gesture is canceled.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that canceled the navigation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a navigation gesture completes.

Head pose of the user at the time of the gesture.

The normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture.

The InteractionSource (hand, controller, or user's voice) that completed the navigation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a navigation gesture starts.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that started the navigation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a navigation gesture updates.

Head pose of the user at the time of the gesture.

The normalized offset, since the navigation gesture began, of the input within the unit cube for the navigation gesture.

The InteractionSource (hand, controller, or user's voice) being used for the navigation gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when recognition of a gesture event ends.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that ended the gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when recognition of a gesture event begins.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that started the gesture.

Pose data of the interaction source at the time of the gesture.

Contains fields that are relevant when a tap gesture occurs.

Head pose of the user at the time of the gesture.

The InteractionSource (hand, controller, or user's voice) that initiated the tap gesture.

Pose data of the interaction source at the time of the gesture.

The number of taps (1 for single-tap, 2 for double-tap).

The storage object for persisted WorldAnchors.

(Read Only) Gets the number of persisted world anchors in this WorldAnchorStore.

Clears all persisted WorldAnchors.

Deletes a persisted WorldAnchor from the store.

The identifier of the WorldAnchor to delete. Whether or not the WorldAnchor was found and deleted.

Gets all of the identifiers of the currently persisted WorldAnchors.

An array of string identifiers.

Gets all of the identifiers of the currently persisted WorldAnchors.

A target array to receive the identifiers of the currently persisted world anchors. The number of identifiers stored in the target array.

Gets the WorldAnchorStore instance.

The handler to be called when the WorldAnchorStore is loaded.

The handler for when getting the WorldAnchorStore from GetAsync.

The instance of the WorldAnchorStore once loaded.

Loads a WorldAnchor from disk for given identifier and attaches it to the GameObject. If the GameObject has a WorldAnchor, that WorldAnchor will be updated. If the anchor is not found, null will be returned and the GameObject and any existing WorldAnchor attached to it will not be modified.

The identifier of the WorldAnchor to load. The object to attach the WorldAnchor to if found. The WorldAnchor loaded by the identifier or null if not found.

Saves the provided WorldAnchor with the provided identifier. If the identifier is already in use, the method will return false.

The identifier to save the anchor with. This needs to be unique for your app. The anchor to save. Whether or not the save was successful. Will return false if the id conflicts with another already saved anchor's id.

Indicates the lifecycle state of the device's spatial location system.

The device is reporting its orientation and is preparing to locate its position in the user's surroundings.

The device is reporting its orientation and position in the user's surroundings.

The device is reporting its orientation but cannot locate its position in the user's surroundings due to external factors like poor lighting conditions.

The device is reporting its orientation and has not been asked to report its position in the user's surroundings.

The device's spatial location system is not available.

This enum represents the result of a WorldAnchorTransferBatch operation.

The operation has failed because access was denied. This occurs typically because the transfer batch was not readable when deserializing or writable when serializing.

The operation has failed because it was not supported.

The operation has completed successfully.

The operation has failed in an unexpected way.

A batch of WorldAnchors which can be exported and imported between apps.

(Read Only) Gets the number of world anchors in this WorldAnchorTransferBatch.

Adds a WorldAnchor to the batch with the specified identifier.

The identifier associated with this anchor in the batch. This must be unique per batch. The anchor to add to the batch. Whether or not the anchor was added successfully.

The handler for when deserialization has completed.

The reason the deserialization completed (success or failure reason). The resulting transfer batch which is empty on error.

Cleans up the WorldAnchorTransferBatch and releases memory.

Exports the input WorldAnchorTransferBatch into a byte array which can be passed to WorldAnchorTransferBatch.ImportAsync to restore the original WorldAnchorTransferBatch.

The WorldAnchorTransferBatch to export into a byte buffer. The callback when some data is available. The callback after the last bit of data was provided via onDataAvailable with a completion reason (success or failure reason).

Gets all of the identifiers currently mapped in this WorldAnchorTransferBatch.

The identifiers of all of the WorldAnchors in this WorldAnchorTransferBatch.

Gets all of the identifiers currently mapped in this WorldAnchorTransferBatch. If the target array is not large enough to contain all the identifiers, then only those identifiers that fit within the array will be stored and the return value will equal the size of the array. You can detect this condition by checking for a return value less than WorldAnchorTransferBatch.anchorCount.

A target array to receive the identifiers of the currently mapped world anchors. The number of identifiers stored in the target array.

Imports the provided bytes into a WorldAnchorTransferBatch.

The complete data to import. The handler when the data import is complete. The offset in the array from which to start reading. The length of the data in the array.

Imports the provided bytes into a WorldAnchorTransferBatch.

The complete data to import. The handler when the data import is complete. The offset in the array from which to start reading. The length of the data in the array.

Locks the provided GameObject to the world by loading and applying the WorldAnchor from the TransferBatch for the provided id.

The identifier for the WorldAnchor to load and apply to the GameObject. The GameObject to apply the WorldAnchor to. If the GameObject already has a WorldAnchor, it will be updated. The loaded WorldAnchor or null if the id does not map to a WorldAnchor.

The handler for when serialization is completed.

Why the serialization completed (success or failure reason).

The handler for when some data is available from serialization.

A set of bytes from the exported transfer batch.

Enumeration of the different types of SurfaceChange events.

Surface was Added.

Surface was removed.

Surface was updated.

SurfaceData is a container struct used for requesting baked spatial mapping data and receiving that data once baked.

Set this field to true when requesting data to bake collider data. This field will be set to true when receiving baked data if it was requested. Setting this field to true requires that a valid outputCollider is also specified.

This is the ID for the surface to be baked or the surface that was baked and being returned to the user.

This WorldAnchor is used to lock the surface into place relative to real world objects. It will be filled in when calling RequestMeshAsync to generate data for a surface and returned with the SurfaceDataReadyDelegate.

This MeshCollider will receive the baked physics mesh prepared by the system when requesting baked surface data through RequestMeshAsync. The MeshCollider is returned in the SurfaceDataReadyDelegate for those users requiring advanced workflows.

This MeshFilter will receive the baked mesh prepared by the system when requesting baked surface data. The MeshFilter is returned in the SurfaceDataReadyDelegate for those users requiring advanced workflows.

This value controls the basic resolution of baked mesh data and is returned with the SurfaceDataReadyDelegate. The device will deliver up to this number of triangles per cubic meter.

Constructor for conveniently filling out a SurfaceData struct.

ID for the surface in question. MeshFilter to write Mesh data to. WorldAnchor receiving the anchor point for the surface. MeshCollider to write baked physics data to (optional). Requested resolution for the computed Mesh. Actual resolution may be less than this value. Set to true if collider baking is/has been requested.

SurfaceId is a structure wrapping the unique ID used to denote Surfaces. SurfaceIds are provided through the onSurfaceChanged callback in Update and returned after a RequestMeshAsync call has completed. SurfaceIds are guaranteed to be unique though Surfaces are sometimes replaced with a new Surface in the same location with a different ID.

The actual integer ID referring to a single surface.

SurfaceObserver is the main API portal for spatial mapping functionality in Unity.

Basic constructor for SurfaceObserver.

Call Dispose when the SurfaceObserver is no longer needed. This will ensure that the object is cleaned up appropriately but will not affect any Meshes, components, or objects returned by RequestMeshAsync.

Call RequestMeshAsync to start the process of baking mesh data for the specified surface. This data may take several frames to create. Baked data will be delivered through the specified SurfaceDataReadyDelegate. This method will throw ArgumentNullExcpetion and ArgumentException if parameters specified in the dataRequest are invalid.

Bundle of request data used to bake the specified surface. Callback called when the baking of this surface is complete. Returns false if the request has failed, typically due to specifying a bad surface ID.

This method sets the observation volume as an axis aligned box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. Extents are the distance from the center of the box to its edges along each axis.

The origin of the requested observation volume. The extents in meters of the requested observation volume.

This method sets the observation volume as a frustum at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed.

Planes defining the frustum as returned from GeometryUtility.CalculateFrustumPlanes.

This method sets the observation volume as an oriented box at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed. Extents are the distance from the center of the box to its edges along each axis.

The origin of the requested observation volume. The extents in meters of the requested observation volume. The orientation of the requested observation volume.

This method sets the observation volume as a sphere at the requested location. Successive calls can be used to reshape the observation volume and/or to move it in the scene as needed.

The origin of the requested observation volume. The radius in meters of the requested observation volume.

The SurfaceChanged delegate handles SurfaceChanged events as generated by calling Update on a SurfaceObserver. Applications can use the bounds, changeType, and updateTime to selectively generate mesh data for the set of known surfaces.

The ID of the surface that has changed. The type of change this event represents (Added, Updated, Removed). The bounds of the surface as reported by the device. The update time of the surface as reported by the device.

The SurfaceDataReadyDelegate handles events generated when the engine has completed generating a mesh. Mesh generation is requested through GetMeshAsync and may take many frames to complete.

Struct containing output data. Set to true if output has been written and false otherwise. Elapsed seconds between mesh bake request and propagation of this event.

Update generates SurfaceChanged events which are propagated through the specified callback. If no callback is specified, the system will throw an ArgumentNullException. Generated callbacks are synchronous with this call. Scenes containing multiple SurfaceObservers should consider using different callbacks so that events can be properly routed.

Callback called when SurfaceChanged events are detected.

When calling PhotoCapture.StartPhotoModeAsync, you must pass in a CameraParameters object that contains the various settings that the web camera will use.

A valid height resolution for use with the web camera.

A valid width resolution for use with the web camera.

The framerate at which to capture video. This is only for use with VideoCapture.

The opacity of captured holograms.

The pixel format used to capture and record your image data.

The encoded image or video pixel format to use for PhotoCapture and VideoCapture.

8 bits per channel (blue, green, red, and alpha).

Encode photo in JPEG format.

8-bit Y plane followed by an interleaved U/V plane with 2x2 subsampling.

Portable Network Graphics Format.

Captures a photo from the web camera and stores it in memory or on disk.

Contains the result of the capture request.

Specifies that the desired operation was successful.

Specifies that an unknown error occurred.

Asynchronously creates an instance of a PhotoCapture object that can be used to capture photos.

Will allow you to capture holograms in your photo. This callback will be invoked when the PhotoCapture instance is created and ready to be used.

Dispose must be called to shutdown the PhotoCapture instance.

Provides a COM pointer to the native IVideoDeviceController.

A native COM pointer to the IVideoDeviceController.

Called when a photo has been saved to the file system.

Indicates whether or not the photo was successfully saved to the file system.

Called when a photo has been captured to memory.

Indicates whether or not the photo was successfully captured to memory. Contains the target texture. If available, the spatial information will be accessible through this structure as well.

Called when a PhotoCapture resource has been created.

The PhotoCapture instance.

Called when photo mode has been started.

Indicates whether or not photo mode was successfully activated.

Called when photo mode has been stopped.

Indicates whether or not photo mode was successfully deactivated.

A data container that contains the result information of a photo capture operation.

The specific HResult value.

A generic result that indicates whether or not the PhotoCapture operation succeeded.

Indicates whether or not the operation was successful.

Asynchronously starts photo mode.

The various settings that should be applied to the web camera. This callback will be invoked once photo mode has been activated.

Asynchronously stops photo mode.

This callback will be invoked once photo mode has been deactivated.

A list of all the supported device resolutions for taking pictures.

Asynchronously captures a photo from the web camera and saves it to disk.

The location where the photo should be saved. The filename must end with a png or jpg file extension. The encoding format that should be used. Invoked once the photo has been saved to disk. Invoked once the photo has been copied to the target texture.

Asynchronously captures a photo from the web camera and saves it to disk.

The location where the photo should be saved. The filename must end with a png or jpg file extension. The encoding format that should be used. Invoked once the photo has been saved to disk. Invoked once the photo has been copied to the target texture.

Image Encoding Format.

JPEG Encoding.

PNG Encoding.

Contains information captured from the web camera.

The length of the raw IMFMediaBuffer which contains the image captured.

Specifies whether or not spatial data was captured.

The raw image data pixel format.

Will copy the raw IMFMediaBuffer image data into a byte list.

The destination byte list to which the raw captured image data will be copied to.

Disposes the PhotoCaptureFrame and any resources it uses.

Provides a COM pointer to the native IMFMediaBuffer that contains the image data.

A native COM pointer to the IMFMediaBuffer which contains the image data.

This method will return the camera to world matrix at the time the photo was captured if location data if available.

A matrix to be populated by the Camera to world Matrix. True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data.

This method will return the projection matrix at the time the photo was captured if location data if available.

The near clip plane distance. The far clip plane distance. A matrix to be populated by the Projection Matrix. True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data.

This method will return the projection matrix at the time the photo was captured if location data if available.

The near clip plane distance. The far clip plane distance. A matrix to be populated by the Projection Matrix. True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data.

This method will copy the captured image data into a user supplied texture for use in Unity.

The target texture that the captured image data will be copied to.

Records a video from the web camera directly to disk.

Specifies what audio sources should be recorded while recording the video.

Include both the application audio as well as the mic audio in the video recording.

Only include the application audio in the video recording.

Only include the mic audio in the video recording.

Do not include any audio in the video recording.

Contains the result of the capture request.

Specifies that the desired operation was successful.

Specifies that an unknown error occurred.

Asynchronously creates an instance of a VideoCapture object that can be used to record videos from the web camera to disk.

Will allow you to capture holograms in your video. This callback will be invoked when the VideoCapture instance is created and ready to be used.

Dispose must be called to shutdown the PhotoCapture instance.

Returns the supported frame rates at which a video can be recorded given a resolution.

A recording resolution. The frame rates at which the video can be recorded.

Provides a COM pointer to the native IVideoDeviceController.

A native COM pointer to the IVideoDeviceController.

Indicates whether or not the VideoCapture instance is currently recording video.

Called when the web camera begins recording the video.

Indicates whether or not video recording started successfully.

Called when the video recording has been saved to the file system.

Indicates whether or not video recording was saved successfully to the file system.

Called when a VideoCapture resource has been created.

The VideoCapture instance.

Called when video mode has been started.

Indicates whether or not video mode was successfully activated.

Called when video mode has been stopped.

Indicates whether or not video mode was successfully deactivated.

Asynchronously records a video from the web camera to the file system.

The name of the video to be recorded to. Invoked as soon as the video recording begins.

Asynchronously starts video mode.

The various settings that should be applied to the web camera. Indicates how audio should be recorded. This callback will be invoked once video mode has been activated.

Asynchronously stops recording a video from the web camera to the file system.

Invoked as soon as video recording has finished.

Asynchronously stops video mode.

This callback will be invoked once video mode has been deactivated.

A list of all the supported device resolutions for recording videos.

A data container that contains the result information of a video recording operation.

The specific HResult value.

A generic result that indicates whether or not the VideoCapture operation succeeded.

Indicates whether or not the operation was successful.

Contains general information about the current state of the web camera.

Specifies what mode the Web Camera is currently in.

Describes the active mode of the Web Camera resource.

Resource is not in use.

Resource is in Photo Mode.

Resource is in Video Mode.

The WorldAnchor component allows a GameObject's position to be locked in physical space.

Returns true if this WorldAnchor is located (read only). A return of false typically indicates a loss of tracking.

Retrieve a native pointer to the <a href="https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM object. This function calls <a href=" https:msdn.microsoft.comen-uslibrarywindowsdesktopms691379.aspx">IUnknown::AddRef<a> on the pointer before returning it. The pointer must be released by calling <a href=" https:msdn.microsoft.comen-uslibrarywindowsdesktopms682317.aspx">IUnknown::Release<a>.

The native pointer to the <a href=" https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM object.

OnTrackingChanged notifies listeners when this object's tracking state changes.

Event that fires when this object's tracking state changes.

Event that is fired when this object's tracking state changes.

Set to true if the object is locatable. The WorldAnchor reporting the tracking state change.

Assigns the <a href="https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM pointer maintained by this WorldAnchor.

A live <a href="https:msdn.microsoft.comen-uslibrarywindowsappswindows.perception.spatial.spatialanchor.aspx">Windows.Perception.Spatial.SpatialAnchor<a> COM pointer.

This class represents the state of the real world tracking system.

The current state of the world tracking systems.

Return the native pointer to Windows::Perception::Spatial::ISpatialCoordinateSystem which was retrieved from an Windows::Perception::Spatial::ISpatialStationaryFrameOfReference object underlying the Unity World Origin.

Pointer to Windows::Perception::Spatial::ISpatialCoordinateSystem.

Event fired when the world tracking systems state has changed.

Callback on when the world tracking systems state has changed.

The previous state of the world tracking systems. The new state of the world tracking systems.

Contains all functionality related to a XR device.

The name of the family of the loaded XR device.

Zooms the XR projection.

Successfully detected a XR device in working order.

Specific model of loaded XR device.

Refresh rate of the display in Hertz.

Indicates whether the user is present and interacting with the device.

Sets whether the camera passed in the first parameter is controlled implicitly by the XR Device

The camera that we wish to change behavior on True if the camera's transform is set externally. False if the camera is to be driven implicitly by XRDevice, Nothing.

This method returns an IntPtr representing the native pointer to the XR device if one is available, otherwise the value will be IntPtr.Zero.

The native pointer to the XR device.

Returns the device's current TrackingSpaceType. This value determines how the camera is positioned relative to its starting position. For more, see the section "Understanding the camera" in.

The device's current TrackingSpaceType.

Sets the device's current TrackingSpaceType. Returns true on success. Returns false if the given TrackingSpaceType is not supported or the device fails to switch.

The TrackingSpaceType the device should switch to. True on success. False if the given TrackingSpaceType is not supported or the device fails to switch.

Enumeration of tracked XR nodes which can be updated by XR input.

Node representing a point between the left and right eyes.

Represents a tracked game Controller not associated with a specific hand.

Represents a physical device that provides tracking data for objects to which it is attached.

Node representing the user's head.

Node representing the left eye.

Node representing the left hand.

Node representing the right eye.

Node representing the right hand.

Represents a stationary physical device that can be used as a point of reference in the tracked area.

Sets the vector representing the current acceleration of the tracked node.

Sets the vector representing the current angular acceleration of the tracked node.

Sets the vector representing the current angular velocity of the tracked node.

The type of the tracked node as specified in XR.XRNode.

Sets the vector representing the current position of the tracked node.

Sets the quaternion representing the current rotation of the tracked node.

Set to true if the node is presently being tracked by the underlying XR system, and false if the node is not presently being tracked by the underlying XR system.

The unique identifier of the tracked node.

Sets the vector representing the current velocity of the tracked node.

Attempt to retrieve a vector representing the current acceleration of the tracked node.

True if the acceleration was set in the output parameter. False if the acceleration is not available due to limitations of the underlying platform or if the node is not presently tracked.

Attempt to retrieve a Vector3 representing the current angular acceleration of the tracked node.

True if the angular acceleration was set in the output parameter. False if the angular acceleration is not available due to limitations of the underlying platform or if the node is not presently tracked.

Attempt to retrieve a Vector3 representing the current angular velocity of the tracked node.

True if the angular velocity was set in the output parameter. False if the angular velocity is not available due to limitations of the underlying platform or if the node is not presently tracked.

Attempt to retrieve a vector representing the current position of the tracked node.

True if the position was set in the output parameter. False if the position is not available due to limitations of the underlying platform or if the node is not presently tracked.

Attempt to retrieve a quaternion representing the current rotation of the tracked node.

True if the rotation was set in the output parameter. False if the rotation is not available due to limitations of the underlying platform or if the node is not presently tracked.

Attempt to retrieve a vector representing the current velocity of the tracked node.

True if the velocity was set in the output parameter. False if the velocity is not available due to limitations of the underlying platform or if the node is not presently tracked.

Global XR related settings.

Globally enables or disables XR for the application.

Fetch the eye texture RenderTextureDescriptor from the active stereo device.

The current height of an eye texture for the loaded device.

Controls the actual size of eye textures as a multiplier of the device's default resolution.

The current width of an eye texture for the loaded device.

Read-only value that can be used to determine if the XR device is active.

Type of XR device that is currently loaded.

A scale applied to the standard occulsion mask for each platform.

This field has been deprecated. Use XRSettings.eyeTextureResolutionScale instead.

Controls how much of the allocated eye texture should be used for rendering.

Mirror what is shown on the device to the main display, if possible.

Returns a list of supported XR devices that were included at build time.

Specifies whether or not the occlusion mesh should be used when rendering. Enabled by default.

Loads the requested device at the beginning of the next frame.

Name of the device from XRSettings.supportedDevices. Prioritized list of device names from XRSettings.supportedDevices.

Loads the requested device at the beginning of the next frame.

Name of the device from XRSettings.supportedDevices. Prioritized list of device names from XRSettings.supportedDevices.

Timing and other statistics from the XR subsystem.

Total GPU time utilized last frame as measured by the XR subsystem.

Retrieves the number of dropped frames reported by the XR SDK.

Outputs the number of frames dropped since the last update. True if the dropped frame count is available, false otherwise.

Retrieves the number of times the current frame has been drawn to the device as reported by the XR SDK.

Outputs the number of times the current frame has been presented. True if the frame present count is available, false otherwise.

Retrieves the time spent by the GPU last frame, in seconds, as reported by the XR SDK.

Outputs the time spent by the GPU last frame. True if the GPU time spent last frame is available, false otherwise.