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

Script language

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

GUILayoutUtility.GetRect

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function GetRect(content: GUIContent, style: GUIStyle): Rect;
public static Rect GetRect(GUIContent content, GUIStyle style);
public static function GetRect(content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(GUIContent content, GUIStyle style, params GUILayoutOption[] options);

Parameters

content The content to make room for displaying.
style The GUIStyle to layout for.
options An 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); 
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public GUIContent buttonText = new GUIContent("some button");
    public GUIStyle buttonStyle = GUIStyle.none;
    void OnGUI() {
        Rect rt = GUILayoutUtility.GetRect(buttonText, buttonStyle);
        if (rt.Contains(Event.current.mousePosition))
            GUI.Label(new Rect(0, 20, 200, 70), "PosX: " + rt.x + "\nPosY: " + rt.y + "\nWidth: " + rt.width + "\nHeight: " + rt.height);
        
        GUI.Button(rt, buttonText, buttonStyle);
    }
}
public static function GetRect(width: float, height: float): Rect;
public static Rect GetRect(float width, float height);
public static function GetRect(width: float, height: float, style: GUIStyle): Rect;
public static Rect GetRect(float width, float height, GUIStyle style);
public static function GetRect(width: float, height: float, params options: GUILayoutOption[]): Rect;
public static Rect GetRect(float width, float height, params GUILayoutOption[] options);
public static function 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

width The width of the area you want.
height The height of the area you want.
style An 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.
options An 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 function GetRect(minWidth: float, maxWidth: float, minHeight: float, maxHeight: float): Rect;
public static Rect GetRect(float minWidth, float maxWidth, float minHeight, float maxHeight);
public static function 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 function 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 function 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

minWidth The minimum width of the area passed back.
maxWidth The maximum width of the area passed back.
minHeight The minimum width of the area passed back.
maxHeight The maximum width of the area passed back.
style An 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.
options An 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.

Copyright © 2016 Unity Technologies. Publication 5.4b-R
Tutorials Community Answers Knowledge Base Forums Asset Store