Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


SetStereoViewMatrix(StereoscopicEye, Matrix4x4)

Sets a custom view matrix for a specific stereoscopic eye.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public void SetStereoViewMatrix(Camera.StereoscopicEye eye, Matrix4x4 matrix)

Parameters

Specifies the stereoscopic view matrix to set.

matrix

The matrix to be set.

Remarks

In general, you should use the view matrices provided by the XRDisplaySubsystem for accurate stereoscopic rendering. However, when needed for specific scenarios, you can override the view matrices to achieve specific effects. For example, you would need to set custom projection and view matrices to implement binoculars in VR.
When you set custom view matrices, the Camera analyzes them to determine whether it is safe to use a single cull pass or if it must separately cull each eye. Use Camera.areVRStereoViewMatricesWithinSingleCullTolerance to find out which will be used.
Call Camera.ResetStereoViewMatrices to revert the camera back to using the view matrices provided by the XRDisplaySubsystem. Note that the Camera.stereoSeparation is not applied until you call Camera.ResetStereoViewMatrices.

Examples

using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ // Use this for initialization void Start() { } // Update is called once per frame void Update() { Camera cam = GetComponent<Camera>(); Matrix4x4 viewL = cam.worldToCameraMatrix; Matrix4x4 viewR = cam.worldToCameraMatrix; viewL[12] += 0.011f; viewR[12] -= 0.011f; cam.SetStereoViewMatrix(Camera.StereoscopicEye.Left, viewL); cam.SetStereoViewMatrix(Camera.StereoscopicEye.Right, viewR); }}