Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Activate

Activates an external display. For example, a secondary monitor connected to the system.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

Activate()

Activates an external display. For example, a secondary monitor connected to the system.
public void Activate()

Remarks

Creates a window with screen width and screen height, and with the default refresh rate.
Displays have the following indices in the Display.displays array:
  • The primary display is 
    0
    .
  • Secondary displays are 
    1
    to 
    7
    .
Make sure an external display is connected before you activate it.
This method works only on desktop platforms.

Examples

using UnityEngine;public class Example : MonoBehaviour{    void Start()    {        // Check the number of monitors connected.        if (Display.displays.Length > 1)        {            // Activate the display 1 (second monitor connected to the system).            Display.displays[1].Activate();        }    }}

Activate(int, int, RefreshRate)

Windows platforms only. Activates an external display with a specific width, height and refresh rate. For example, a secondary monitor connected to the system.
public void Activate(int width, int height, RefreshRate refreshRate)

Parameters

width

int
Windows platforms only. Width of the window to open.

height

int
Windows platforms only. Height of the window to open.

refreshRate

RefreshRate
Refresh Rate of the window to open.

Remarks

This method only works fully on Windows platforms. If you use this method on Linux or macOS platforms, the display uses the screen width and height.
Displays have the following indices in the Display.displays array:
  • The primary display is 
    0
    .
  • Secondary displays are 
    1
    to 
    7
    .
Make sure an external display is connected before you activate it.

Examples

using UnityEngine;public class Example : MonoBehaviour{    void Start()    {        // Check the number of monitors connected.        if (Display.displays.Length > 1)        {            // Activate the display 1 (second monitor connected to the system).            Display.displays[1].Activate(0, 0, new RefreshRate() { numerator = 60, denominator = 1 });        }    }}