Version: 2021.3
  • C#


class in UnityEditor


Inherits from:GUIUtility

Suggest a change


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.


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.




Miscellaneous helper stuff for EditorGUI.

Static Properties

currentViewWidthThe width of the GUI area for the current EditorWindow or other view. This Property should only be accessed within an OnGUI call.
editingTextFieldIs a text field currently editing text?
fieldWidthThe minimum width in pixels reserved for the fields of Editor GUI controls.
hierarchyModeIs the Editor GUI in hierarchy mode?
isProSkinIs the user currently using the pro skin? (Read Only)
labelWidthThe width in pixels reserved for labels of Editor GUI controls.
pixelsPerPointThe scale of GUI points relative to screen pixels for the current viewThis value is the number of screen pixels per point of interface space. For instance, 2.0 on retina displays. Note that the value may differ from one view to the next if the views are on monitors with different UI scales.
singleLineHeightGet the height used for a single Editor control such as a one-line EditorGUI.TextField or EditorGUI.Popup.
standardVerticalSpacingGet the height used by default for vertical spacing between controls.
systemCopyBufferThe system copy buffer.
textFieldHasSelectionTrue if a text field currently has focused and the text in it is selected.
whiteTextureGet a white texture.
wideModeIs the Editor GUI currently in wide mode?

Static Methods

AddCursorRectAdd a custom mouse pointer to a control.
CommandEventCreates an event that can be sent to another window.
DrawColorSwatchDraw a color swatch.
DrawCurveSwatchDraw a curve swatch.
DrawRegionSwatchDraw swatch with a filled region between two SerializedProperty curves.
FindTextureGet a texture from its source filename.
GetBuiltinSkinGet one of the built-in GUI skins, which can be the game view, inspector or Scene view skin as chosen by the parameter.
GetFlowLayoutedRectsLayout list of string items left to right, top to bottom in the given area.
GetIconForObjectGets the custom icon associated with an object. Only GameObjects and MonoScripts have associated custom icons.
GetIconSizeGet the size that has been set using SetIconSize.
GetMainWindowPositionReturns position of Unity Editor's main window.
GetObjectPickerControlIDThe controlID of the currently showing object picker.
GetObjectPickerObjectThe object currently selected in the object picker.
HasObjectThumbnailDoes a given class have per-object thumbnails?
IconContentFetch the GUIContent from the Unity builtin resources with the given name.
IsDisplayReferencedByCamerasCheck if any enabled camera can render to a particular display.
LoadLoad a built-in resource.
LoadRequiredLoad a required built-in resource.
LookLikeControlsMake all EditorGUI look like regular controls.
ObjectContentReturn a GUIContent object with the name and icon of an Object.
PingObjectPing an object in the Scene like clicking it in an inspector.
PixelsToPointsConvert from pixel space to point space.
PointsToPixelsConvert from point space to pixel space.
QueueGameViewInputEventSend an input event into the game.
SetIconForObjectSets a custom icon to associate with a GameObject or MonoScript. The custom icon is displayed in the Scene view and the Inspector.
SetIconSizeSet icons rendered as part of GUIContent to be rendered at a specific size.
SetMainWindowPositionSets position of Unity Editor's main window.
ShowObjectPickerShow the object picker from code.

Inherited Members

Static Properties

hasModalWindowA global property, which is true if a ModalWindow is being displayed, false otherwise.
hotControlThe controlID of the current hot control.
keyboardControlThe controlID of the control that has keyboard focus.
systemCopyBufferGet access to the system-wide clipboard.

Static Methods

AlignRectToDeviceAlign a local space rectangle to the pixel grid.
ExitGUIPuts the GUI in a state that will prevent all subsequent immediate mode GUI functions from evaluating for the remainder of the GUI loop by throwing an ExitGUIException.
GetControlIDGet a unique ID for a control.
GetStateObjectGet a state object from a controlID.
GUIToScreenPointConvert a point from GUI position to screen space.
GUIToScreenRectConvert a rect from GUI position to screen space.
QueryStateObjectGet an existing state object from a controlID.
RotateAroundPivotHelper function to rotate the GUI around a point.
ScaleAroundPivotHelper function to scale the GUI around a point.
ScreenToGUIPointConvert a point from screen space to GUI position.
ScreenToGUIRectConvert a rect from screen space to GUI position.