UnityEngine.VRModule

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

Enumeration 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.

Renders both eyes of the XR device side-by-side in the Game view or in the main window on a host PC.

Renders the left eye of the XR device in the Game View window or in main window on a host PC.

Renders both eyes (motion vectors) of the XR device side-by-side in the Game view or in the main window on a host PC. Only works if the motion vector texture is in-use.

Disables rendering of any new frames from the eyes in the Game view or in the main window on a host PC.

Renders both eyes of the XR device, and the occlusion mesh, side-by-side in the Game view or in the main window on a host PC.

Renders the right eye of the XR device in the Game View window or in main window on a host PC.

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.

Contains all functionality related to a XR device.

Subscribe a delegate to this event to get notified when an XRDevice is successfully loaded.

Zooms the XR projection.

Successfully detected a XR device in working order.

Refresh rate of the display in Hertz.

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.

Recreates the XR platform's eye texture swap chain with the appropriate anti-aliasing sample count. The reallocation of the eye texture will only occur if the MSAA quality setting's sample count is different from the sample count of the current eye texture. Reallocations of the eye textures will happen at the beginning of the next frame. This is an expensive operation and should only be used when necessary.

Nothing.

Global XR related settings.

Fetch the device eye texture dimension from the active stereo device.

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.

Sets the render mode for the XR device. The render mode controls how the view of the XR device renders in the Game view and in the main window on a host PC.

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.

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

This property has been deprecated. Use XRSettings.gameViewRenderMode instead.

The stereo rendering mode that is currently in use.

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.

Enum type signifying the different stereo rendering modes available.

This is the reference stereo rendering path for VR.

This is a faster rendering path for VR than XRSettings.StereoRenderingMode.MultiPass.

This is an optimized version of the XRSettings.StereoRenderingMode.SinglePass mode.

This is a OpenGL optimized version of the XRSettings.StereoRenderingMode.SinglePassInstanced mode.

Timing and other statistics from 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.