Version: 1.10
LanguageEnglish
  • C#

GameWindowCreationSettings

class in UnityEngine.Windowing

/

Implemented in:UnityEngine.CoreModule

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

Settings used to configure the properties of a new game window.

This class contains configuration parameters for creating a new window using GameWindowManager.Create. You can specify window attributes such as title, dimensions, position, display target, and fullscreen mode. This API is currently available only in EmbeddedLinux and QNX platforms.

using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Windowing;

public class CreateWindowExample : MonoBehaviour { List<DisplayInfo> displayInfos = new List<DisplayInfo>(); void Start() { DisplayInfo.GetLayout(displayInfos); var settings = new GameWindowCreationSettings( title: "Second Window", width: 600, height: 400, position: new Vector2Int(0, 0), cameraDisplayIndex: 1, fullScreenMode: FullScreenMode.Windowed, resizable: false ); var op = GameWindowManager.Create(settings); op.completed += (AsyncOperation o) => { Debug.Log("Window Created: {op.window.GetTitle()}"); }; } }

Properties

cameraDisplayIndexThe display index that the camera should render to.This value determines which display the camera associated with this window will target for rendering.
fullScreenModeThe fullscreen mode for the window.Specifies whether the window should be created in windowed, fullscreen, or borderless fullscreen mode. See FullScreenMode for available options.
heightThe height of the window in pixels.
positionThe position of the window relative to the top-left corner of the display.Specified as a Vector2Int with x and y coordinates in pixels.
resizableDetermines whether the window can be resized by the user.When set to true, the window will have resizing handles. When false, the window size is fixed.
titleThe title text displayed in the window's title bar.
widthGameWindowCreationSettings.width.