Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

GUILayout.Box

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 void Box(Texture image, params GUILayoutOption[] options);
public static void Box(string text, params GUILayoutOption[] options);
public static void Box(GUIContent content, params GUILayoutOption[] options);
public static void Box(Texture image, GUIStyle style, params GUILayoutOption[] options);
public static void Box(string text, GUIStyle style, params GUILayoutOption[] options);
public static void Box(GUIContent content, GUIStyle style, params GUILayoutOption[] options);

Parameters

textText to display on the box.
image Texture to display on the box.
contentText, image and tooltip for this box.
styleThe style to use. If left out, the box style from the current GUISkin is used.
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.

Description

Make an auto-layout box.

This will make a box that contains static text or images but not other GUI controls. If you want to make a rectangular container for a set of GUI controls, use one of the grouping functions (BeginHorizontal, BeginVertical, BeginArea, etc...).


Boxes in the Game View.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Texture tex; void OnGUI() { if (!tex) Debug.LogError("Missing texture, assign a texture in the inspector"); GUILayout.Box(tex); GUILayout.Box("This is an sized label"); } }

Did you find this page useful? Please give it a rating: