Version: 5.5 (switch to 5.4)
LanguageEnglish
  • C#
  • JS

Script language

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

GUI

class in UnityEngine

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

The GUI class is the interface for Unity's GUI with manual positioning.


See Also: GUI tutorial.

Static Variables

backgroundColorGlobal tinting color for all background elements rendered by the GUI.
changedReturns true if any controls changed the value of the input data.
colorGlobal tinting color for the GUI.
contentColorTinting color for all text rendered by the GUI.
depthThe sorting depth of the currently executing GUI behaviour.
enabledIs the GUI enabled?
matrixThe GUI transform matrix.
skinThe global skin to use.
tooltipThe tooltip of the control the mouse is currently over, or which has keyboard focus. (Read Only).

Static Functions

BeginGroupBegin a group. Must be matched with a call to EndGroup.
BeginScrollViewBegin a scrolling view inside your GUI.
BoxCreate a Box on the GUI Layer. A Box can contain text, an image, or a combination of these along with an optional tooltip, through using a GUIContent parameter. You may also use a GUIStyle to adjust the layout of items in a box, text colour and other properties.
BringWindowToBackBring a specific window to back of the floating windows.
BringWindowToFrontBring a specific window to front of the floating windows.
ButtonMake a single press button. The user clicks them and something happens immediately.
DragWindowMake a window draggable.
DrawTextureDraw a texture within a rectangle.
DrawTextureWithTexCoordsDraw a texture within a rectangle with the given texture coordinates. Use this function for clipping or tiling the image within the given rectangle.
EndGroupEnd a group.
EndScrollViewEnds a scrollview started with a call to BeginScrollView.
FocusControlMove keyboard focus to a named control.
FocusWindowMake a window become the active window.
GetNameOfFocusedControlGet the name of named control that has focus.
HorizontalScrollbarMake a horizontal scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead.
HorizontalSliderA horizontal slider the user can drag to change a value between a min and a max.
LabelMake a text or texture label on screen.
ModalWindowShow a Modal Window.
PasswordFieldMake a text field where the user can enter a password.
RepeatButtonMake a button that is active as long as the user holds it down.
ScrollToScrolls all enclosing scrollviews so they try to make position visible.
SelectionGridMake a grid of buttons.
SetNextControlNameSet the name of the next control.
TextAreaMake a Multi-line text area where the user can edit a string.
TextFieldMake a single-line text field where the user can edit a string.
ToggleMake an on/off toggle button.
ToolbarMake a toolbar.
UnfocusWindowRemove focus from all windows.
VerticalScrollbarMake a vertical scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead.
VerticalSliderA vertical slider the user can drag to change a value between a min and a max.
WindowMake a popup window.

Delegates

WindowFunctionCallback to draw GUI within a window (used with GUI.Window).