Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

GUILayoutUtility.GetRect

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 method GetRect(content: GUIContent, style: GUIStyle): Rect;
public static Rect GetRect(GUIContent content, GUIStyle style);
public static method GetRect(content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(GUIContent content, GUIStyle style, params GUILayoutOption[] options);

Parameters

contentThe content to make room for displaying.
styleThe GUIStyle to layout for.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Rect A rectangle that is large enough to contain content when rendered in style.

Description

Reserve layout space for a rectangle for displaying some contents with a specific style.

    // Shows the button rect properties in a label when the mouse is over it
    var buttonText : GUIContent = new GUIContent("some button");
    var buttonStyle : GUIStyle = GUIStyle.none;

    function OnGUI() {
        var rt : Rect = GUILayoutUtility.GetRect(buttonText, buttonStyle);
        if (rt.Contains(Event.current.mousePosition)) {
            GUI.Label(Rect(0,20,200,70), "PosX: " + rt.x + "\nPosY: " + rt.y +
                  "\nWidth: " + rt.width + "\nHeight: " + rt.height);
        }
        GUI.Button(rt, buttonText, buttonStyle);
    }

no example available in C#
public static method GetRect(width: float, height: float): Rect;
public static Rect GetRect(float width, float height);
public static method GetRect(width: float, height: float, style: GUIStyle): Rect;
public static Rect GetRect(float width, float height, GUIStyle style);
public static method GetRect(width: float, height: float, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(float width, float height, params GUILayoutOption[] options);
public static method GetRect(width: float, height: float, style: GUIStyle, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(float width, float height, GUIStyle style, params GUILayoutOption[] options);

Parameters

widthThe width of the area you want.
heightThe height of the area you want.
styleAn optional GUIStyle to layout for. If specified, the style's padding value will be added to your sizes & its margin value will be used for spacing.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Rect The rectanlge to put your control in.

Description

Reserve layout space for a rectangle with a fixed content area.

public static method GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float): Rect;
public static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight);
public static method GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float, style: GUIStyle): Rect;
public static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight, GUIStyle style);
public static method GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight, params GUILayoutOption[] options);
public static method GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float, style: GUIStyle, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight, GUIStyle style, params GUILayoutOption[] options);

Parameters

minWidthThe minimum width of the area passed back.
maxWidthThe maximum width of the area passed back.
minHeightThe minimum width of the area passed back.
maxHeightThe maximum width of the area passed back.
styleAn optional style. If specified, the style's padding value will be added to the sizes requested & the style's margin values will be used for spacing.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Rect A rectangle with size between minWidth & maxWidth on both axes.

Description

Reserve layout space for a flexible rect.

The rectangle's size will be between the min & max values.

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 © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information