Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Camera.worldToCameraMatrix

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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
public var worldToCameraMatrix: Matrix4x4;
public Matrix4x4 worldToCameraMatrix;
public worldToCameraMatrix as Matrix4x4

Description

Matrix that transforms from world to camera space.

Use this to calculate the camera space position of objects or to provide custom camera's location that is not based on the transform.

Note that camera space matches OpenGL convention: camera's forward is the negative Z axis. This is different from Unity's convention, where forward is the positive Z axis.

If you change this matrix, the camera no longer updates its rendering based on its Transform. This lasts until you call ResetWorldToCameraMatrix.

	// Offsets camera's rendering from the transform's position.

var offset : Vector3 = Vector3 (0,1,0); function LateUpdate () { // Construct a matrix that offsets and mirrors along // Z axis. Because camera space has mirrored Z with respect // to the rest of Unity. var camoffset : Vector3 = Vector3 (-offset.x, -offset.y, offset.z); var m : Matrix4x4 = Matrix4x4.TRS (camoffset, Quaternion.identity, Vector3 (1,1,-1)); // Override worldToCameraMatrix to be offset/mirrored // transform's matrix. camera.worldToCameraMatrix = m * transform.worldToLocalMatrix; }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Vector3 offset = new Vector3(0, 1, 0);
    void LateUpdate() {
        Vector3 camoffset = new Vector3(-offset.x, -offset.y, offset.z);
        Matrix4x4 m = Matrix4x4.TRS(camoffset, Quaternion.identity, new Vector3(1, 1, -1));
        camera.worldToCameraMatrix = m * transform.worldToLocalMatrix;
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public offset as Vector3 = Vector3(0, 1, 0)

	def LateUpdate() as void:
		camoffset as Vector3 = Vector3(-offset.x, -offset.y, offset.z)
		m as Matrix4x4 = Matrix4x4.TRS(camoffset, Quaternion.identity, Vector3(1, 1, -1))
		camera.worldToCameraMatrix = (m * transform.worldToLocalMatrix)