Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

Camera.ScreenToViewportPoint

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
public function ScreenToViewportPoint(position: Vector3): Vector3;
public Vector3 ScreenToViewportPoint(Vector3 position);

Description

Transforms position from screen space into viewport space.

Screenspace is defined in pixels. The bottom-left of the screen is (0,0); the right-top is (pixelWidth,pixelHeight). The z position is in world units from the camera.

Viewport space is normalized and relative to the camera. The bottom-left of the camera is (0,0); the top-right is (1,1). The z position is in world units from the camera.

// When attached to a GUITexture object, this will
// move the texture around with the mouse.

function Update () { transform.position = Camera.main.ScreenToViewportPoint(Input.mousePosition); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Update() { transform.position = Camera.main.ScreenToViewportPoint(Input.mousePosition); } }