Version: 2021.2
LanguageEnglish
  • C#

Camera.SetStereoViewMatrix

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

Switch to Manual

Declaration

public void SetStereoViewMatrix(Camera.StereoscopicEye eye, Matrix4x4 matrix);

Parameters

eye Specifies the stereoscopic view matrix to set.
matrix The matrix to be set.

Description

Sets a custom view matrix for a specific stereoscopic eye.

In most cases you should use the view matrices provided by the VR SDK to ensure accurate stereoscopic rendering. However, in some scenarios it can be useful to override the view matrices to achieve specific effects. For example, custom view matrices would be required to implement binoculars in VR.

If custom view matrices have been set, then the Camera will analyze the view matrices 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.

Calling Camera.ResetStereoViewMatrices will revert the camera to using view matrices provided by the VR SDK. Note that the Camera.stereoSeparation will not be applied until you call Camera.ResetStereoViewMatrices.

See Also: Camera.ResetStereoViewMatrices, Camera.stereoSeparation, Camera.areVRStereoViewMatricesWithinSingleCullTolerance

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); } }