Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GUI

The GUI class is the interface for Unity's GUI with manual positioning.
Read time 3 minutesLast updated 4 days ago

Definition

  • Type: Class
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule
public class GUI

Remarks

Additional Resources: GUI tutorial.

Static Properties

Property

Description

backgroundColorGlobal tinting color for all background elements rendered by the GUI.
changedReturns true if any controls changed the value of the input data.
colorApplies a global tint to the GUI. The tint affects backgrounds and text colors.
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 Methods

Method

Description

BeginGroupBegin a group. Must be matched with a call to GUI.EndGroup.
BeginScrollViewBegin a scrolling view inside your GUI.
BoxCreate a Box on the GUI Layer.
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.
DragWindowIf you want to have the entire window background to act as a drag area, use the version of DragWindow that takes no parameters and put it at the end of the window function.
DrawTextureDraw a texture within a rectangle.
DrawTextureWithTexCoordsDraw a texture within a rectangle with the given texture coordinates.
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.

Classes

Class

Description

GUI.GroupScopeDisposable helper class for managing GUI.BeginGroup / GUI.EndGroup.
GUI.ScrollViewScopeDisposable helper class for managing GUI.BeginScrollView / GUI.EndScrollView.

Enums

Enum

Description

GUI.ToolbarButtonSizeDetermines how toolbar button size is calculated.

Delegates

Delegate

Description

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