Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

fullScreen

Enables full-screen mode for the application.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public static bool fullScreen { get; set; }

Remarks

Use this property to toggle full-screen mode. The following example toggles between the application's current full-screen mode and windowed mode.
using UnityEngine;public class Example : MonoBehaviour{    void Start()    {        // Toggle fullscreen        Screen.fullScreen = !Screen.fullScreen;    }}
A full-screen switch doesn't happen immediately. The change takes effect when the current frame is finished.
Screen.fullScreen
is a simplified, Boolean alternative to Screen.fullScreenMode. Setting it to true switches the application to the default full-screen mode configured in PlayerSettings.fullScreenMode. If no valid default is set, Unity uses FullScreenMode.FullScreenWindow. Setting it to false switches the application to FullScreenMode.Windowed. Reading the property returns true for full-screen modes. It returns false for FullScreenMode.Windowed, and might also return false for FullScreenMode.MaximizedWindow depending on the platform. To choose a specific full-screen mode, such as FullScreenMode.ExclusiveFullScreen or FullScreenMode.MaximizedWindow, use Screen.fullScreenMode instead. To change the resolution and full-screen mode together, use Screen.SetResolution.
Notes:
  • Screen.fullScreen
    is read-only on iOS.
  • When Stage Manager is enabled on iPadOS, the 
    Screen.fullScreen
    remains true for the application built with full-screen display mode. The application maintains the full-screen resolution in supported orientations even when the Stage Manager scales the application.