Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

GUI.ModalWindow

Other Versions
Leave feedback
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 static Rect ModalWindow(int id, Rect clientRect, GUI.WindowFunction func, string text);
public static Rect ModalWindow(int id, Rect clientRect, GUI.WindowFunction func, Texture image);
public static Rect ModalWindow(int id, Rect clientRect, GUI.WindowFunction func, GUIContent content);
public static Rect ModalWindow(int id, Rect clientRect, GUI.WindowFunction func, string text, GUIStyle style);
public static Rect ModalWindow(int id, Rect clientRect, GUI.WindowFunction func, Texture image, GUIStyle style);
public static Rect ModalWindow(int id, Rect clientRect, GUI.WindowFunction func, GUIContent content, GUIStyle style);

Parameters

idA unique id number.
clientRectPosition and size of the window.
funcA function which contains the immediate mode GUI code to draw the contents of your window.
textText to appear in the title-bar area of the window, if any.
imageAn image to appear in the title bar of the window, if any.
contentGUIContent to appear in the title bar of the window, if any.
styleStyle to apply to the window.

Description

Show a Modal Window.

Similar to GUI.Window, however the window will always be on top of all other GUI, and while displayed, is guaranteed to be sole recipient of all GUI input and events. While a ModalWindow is being displayed, other controls will not be processing input. Note that only one ModalWindow can be displayed at a time.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset Store