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

Script language

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

Display

class in UnityEngine

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

Description

Provides access to a display / screen for rendering operations.

Multi-display rendering is available on PC (Windows/Mac/Linux), iOS and Android.

Use the Display class to operate on the displays themselves, and Camera.targetDisplay to set up cameras for rendering to individual displays.

See Also: Camera.targetDisplay, Canvas.targetDisplay.

void Start()
{
    // GUI is rendered with last camera.
    // As we want it to end up in the main screen, make sure main camera is the last one drawn.
    extCam.depth = camera.depth - 1;

camera.SetTargetBuffers(Display.main.colorBuffer, Display.main.depthBuffer); extCam.enabled = false; }

void Update() { if(Display.displays.Length > 1 && !extCam.enabled) { Display.displays[1].SetRenderingResolution(256,256); extCam.SetTargetBuffers(Display.displays[1].colorBuffer, Display.displays[1].depthBuffer); } extCam.enabled = Display.displays.Length > 1; }

Static Variables

displaysThe list of currently connected Displays. Contains at least one (main) display.
mainMain Display.

Variables

activeGets the state of the display and returns true if the display is active and false if otherwise.
colorBufferColor RenderBuffer.
depthBufferDepth RenderBuffer.
renderingHeightVertical resolution that the display is rendering at.
renderingWidthHorizontal resolution that the display is rendering at.
systemHeightVertical native display resolution.
systemWidthHorizontal native display resolution.

Public Functions

ActivateActivate an external display. Eg. Secondary Monitors connected to the System.
SetParamsSet rendering size and position on screen (Windows only).
SetRenderingResolutionSets rendering resolution for the display.

Static Functions

RelativeMouseAtQuery relative mouse coordinates.