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

Script language

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

GUIStyle

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

Switch to Manual

Description

Styling information for GUI elements.

Most GUI functions accept an optional GUIStyle parameter to override the default style. This allows coloring, fonts and other details to be changed and switched for different states (eg, when the mouse is hovering over the control). Where a consistent look-and-feel is required over a whole GUI design, the GUISkin class is a useful way to collect a set of GUIStyle settings and apply them all at once.

Static Variables

noneShortcut for an empty GUIStyle.

Variables

activeRendering settings for when the control is pressed down.
alignmentText alignment.
borderThe borders of all background images.
clippingWhat to do when the contents to be rendered is too large to fit within the area given.
contentOffsetPixel offset to apply to the content of this GUIstyle.
fixedHeightIf non-0, any GUI elements rendered with this style will have the height specified here.
fixedWidthIf non-0, any GUI elements rendered with this style will have the width specified here.
focusedRendering settings for when the element has keyboard focus.
fontThe font to use for rendering. If null, the default font for the current GUISkin is used instead.
fontSizeThe font size to use (for dynamic fonts).
fontStyleThe font style to use (for dynamic fonts).
hoverRendering settings for when the mouse is hovering over the control.
imagePositionHow image and text of the GUIContent is combined.
lineHeightThe height of one line of text with this style, measured in pixels. (Read Only)
marginThe margins between elements rendered in this style and any other GUI elements.
nameThe name of this GUIStyle. Used for getting them based on name.
normalRendering settings for when the component is displayed normally.
onActiveRendering settings for when the element is turned on and pressed down.
onFocusedRendering settings for when the element has keyboard and is turned on.
onHoverRendering settings for when the control is turned on and the mouse is hovering it.
onNormalRendering settings for when the control is turned on.
overflowExtra space to be added to the background image.
paddingSpace from the edge of GUIStyle to the start of the contents.
richTextEnable HTML-style tags for Text Formatting Markup.
stretchHeightCan GUI elements of this style be stretched vertically for better layout?
stretchWidthCan GUI elements of this style be stretched horizontally for better layouting?
wordWrapShould the text be wordwrapped?

Constructors

GUIStyleConstructor for empty GUIStyle.

Public Functions

CalcHeightHow tall this element will be when rendered with content and a specific width.
CalcMinMaxWidthCalculate the minimum and maximum widths for this style rendered with content.
CalcScreenSizeCalculate the size of an element formatted with this style, and a given space to content.
CalcSizeCalculate the size of some content if it is rendered with this style.
DrawDraw this GUIStyle on to the screen, internal version.
DrawCursorDraw this GUIStyle with selected content.
DrawWithTextSelectionDraw this GUIStyle with selected content.
GetCursorPixelPositionGet the pixel position of a given string index.
GetCursorStringIndexGet the cursor position (indexing into contents.text) when the user clicked at cursorPixelPosition.

Operators

GUIStyleGet a named GUI style from the current skin.
Copyright © 2016 Unity Technologies. Publication 5.5-001B
Tutorials Community Answers Knowledge Base Forums Asset Store