Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Display.Activate

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

public function Activate(): void;
public void Activate();

Description

Activate an external display. Eg. Secondary Monitors connected to the System.

The function Activate() will create a window of Screen width, Screen height and default Refresh Rates. This function is available on Windows, Linux and Mac platforms. The default primary Monitor is always indexed 0. Secondary Monitors range from 1 to 7. Ensure an external monitor is connected before Activating it.

// 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();

public function Activate(width: int, height: int, refreshRate: int): void;
public void Activate(int width, int height, int refreshRate);

Parameters

width Desired Width of the Window (for Windows only. On Linux and Mac uses Screen Width).
height Desired Height of the Window (for Windows only. On Linux and Mac uses Screen Height).
refreshRate Desired Refresh Rate.

Description

This overloaded function available for Windows allows specifying desired Window Width, Height and Refresh Rate.

The default primary Monitor is always indexed 0. Secondary Monitors range from 1 to 7. Ensure an external monitor is connected before Activating it.

// 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, 60);