LanguageEnglish
  • C#

UnityEngine.VRModule

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The VR module implements support for virtual reality devices in Unity.

Classes

GestureRecognizerManager class with API for recognizing user gestures.
HolographicRemotingThe Holographic Remoting interface allows you to connect an application to a remote holographic device, and stream data between the application and that device.
HolographicSettingsThe Holographic Settings contain functions which effect the performance and presentation of Holograms on Windows Holographic platforms.
InteractionManagerProvides access to user input from hands, controllers, and system voice commands.
PhotoCaptureCaptures a photo from the web camera and stores it in memory or on disk.
PhotoCaptureFrameContains information captured from the web camera.
SurfaceObserverSurfaceObserver is the main API portal for spatial mapping functionality in Unity.
VideoCaptureRecords a video from the web camera directly to disk.
WebCamContains general information about the current state of the web camera.
WorldAnchorThe WorldAnchor component allows a GameObject's position to be locked in physical space.
WorldAnchorStoreThe storage object for persisted WorldAnchors.
WorldAnchorTransferBatchA batch of WorldAnchors which can be exported and imported between apps.
WorldManagerThis class represents the state of the real world tracking system.
XRDeviceContains all functionality related to a XR device.
XRSettingsGlobal XR related settings.
XRStatsTiming and other statistics from the XR subsystem.

Structs

CameraParametersWhen calling PhotoCapture.StartPhotoModeAsync, you must pass in a CameraParameters object that contains the various settings that the web camera will use.
GestureErrorEventArgsContains fields that are relevant during an error event.
HoldCanceledEventArgsContains fields that are relevant when a user cancels a hold gesture.
HoldCompletedEventArgsContains fields that are relevant when a hold gesture completes.
HoldStartedEventArgsContains fields that are relevant when a hold gesture starts.
InteractionSourceRepresents one detected instance of an interaction source (hand, controller, or user's voice) that can cause interactions and gestures.
InteractionSourceDetectedEventArgsContains fields that are relevent when an interaction source is detected.
InteractionSourceLostEventArgsContains fields that are relevent when an interaction source is lost.
InteractionSourcePosePose data of the interaction source at the time of either the gesture or interaction.
InteractionSourcePressedEventArgsContains fields that are relevent when an interaction source enters the pressed state for one of its buttons.
InteractionSourcePropertiesRepresents the set of properties available to explore the current state of a hand or controller.
InteractionSourceReleasedEventArgsContains fields that are relevent when an interaction source exits the pressed state for one of its buttons.
InteractionSourceStateRepresents a snapshot of the state of a spatial interaction source (hand, voice or controller) at a given time.
InteractionSourceUpdatedEventArgsContains fields that are relevent when an interaction source updates.
ManipulationCanceledEventArgsContains fields that are relevant when a manipulation gesture is canceled.
ManipulationCompletedEventArgsContains fields that are relevant when a manipulation gesture completes.
ManipulationStartedEventArgsContains fields relevant when a manipulation gesture starts.
ManipulationUpdatedEventArgsContains fields that are relevant when a manipulation gesture gets updated.
NavigationCanceledEventArgsContains fields that are relevant when a navigation gesture is canceled.
NavigationCompletedEventArgsContains fields that are relevant when a navigation gesture completes.
NavigationStartedEventArgsContains fields that are relevant when a navigation gesture starts.
NavigationUpdatedEventArgsContains fields that are relevant when a navigation gesture updates.
RecognitionEndedEventArgsContains fields that are relevant when recognition of a gesture event ends.
RecognitionStartedEventArgsContains fields that are relevant when recognition of a gesture event begins.
SurfaceDataSurfaceData is a container struct used for requesting baked spatial mapping data and receiving that data once baked.
SurfaceIdSurfaceId 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.
TappedEventArgsContains fields that are relevant when a tap gesture occurs.

Enumerations

CapturePixelFormatThe encoded image or video pixel format to use for PhotoCapture and VideoCapture.
GameViewRenderModeEnumeration of available modes for XR rendering in the Game view or in the main window on a host PC. XR rendering only occurs when the Unity Editor is in Play Mode.
GestureSettingsThis enumeration represents the set of gestures that may be recognized by GestureRecognizer.
HolographicStreamerConnectionFailureReasonEnum indicating the reason why connection to remote device has failed.
HolographicStreamerConnectionStateCurrent state of the holographis streamer remote connection.
InteractionSourceHandednessDenotes which hand was used as the input source.
InteractionSourceKindSpecifies the kind of an interaction source.
InteractionSourceNodeSpecifies which part of the controller to query pose information for.
InteractionSourcePositionAccuracyDenotes the accuracy of tracking on the interaction source.
InteractionSourcePressTypeThe type of button or controller feature pressed, if any.
PhotoCaptureFileOutputFormatImage Encoding Format.
PositionalLocatorStateIndicates the lifecycle state of the device's spatial location system.
SerializationCompletionReasonThis enum represents the result of a WorldAnchorTransferBatch operation.
SurfaceChangeEnumeration of the different types of SurfaceChange events.
TrackingOriginModeRepresents how the device is reporting pose data.
TrackingSpaceTypeRepresents the size of physical space available for XR.
UserPresenceStateRepresents the current user presence state detected by the device.
WebCamModeDescribes the active mode of the Web Camera resource.
对文档有任何疑问，请移步至开发者社区提问，我们将尽快为您解答