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

Script language

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

GUI.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

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 Box(position: Rect, text: string): void;
public static void Box(Rect position, string text);
public static function Box(position: Rect, image: Texture): void;
public static void Box(Rect position, Texture image);
public static function Box(position: Rect, content: GUIContent): void;
public static void Box(Rect position, GUIContent content);
public static function Box(position: Rect, text: string, style: GUIStyle): void;
public static void Box(Rect position, string text, GUIStyle style);
public static function Box(position: Rect, image: Texture, style: GUIStyle): void;
public static void Box(Rect position, Texture image, GUIStyle style);
public static function Box(position: Rect, content: GUIContent, style: GUIStyle): void;
public static void Box(Rect position, GUIContent content, GUIStyle style);

Parameters

position Rectangle on the screen to use for the box.
text Text to display on the box.
image Texture to display on the box.
content Text, image and tooltip for this box.
style The style to use. If left out, the box style from the current GUISkin is used.

Description

Create a Box on the GUI Layer. A Box can contain text, an image, or a combination of these along with an optional tooltip, through using a GUIContent parameter. You may also use a GUIStyle to adjust the layout of items in a box, text colour and other properties.

Here is an example of a Box containing Text:

no example available in JavaScript
using UnityEngine;

public class BoxExample : MonoBehaviour { void OnGUI() { GUI.Box(new Rect(0, 0, Screen.width, Screen.height), "This is a box"); } }

Here is an example of a Box containing a Texture:

no example available in JavaScript
using UnityEngine;

public class BoxWithTextureExample : MonoBehaviour { public Texture BoxTexture; // Drag a Texture onto this item in the Inspector

void OnGUI() { GUI.Box(new Rect(0, 0, Screen.width, Screen.height), BoxTexture); } }

Here is an example of a Box containing a GUIContent, combining Text, Texture and Tooltip:

no example available in JavaScript
using UnityEngine;

public class BoxWithContentExample : MonoBehaviour { public Texture BoxTexture; // Drag a Texture onto this item in the Inspector

GUIContent content;

void Start() { content = new GUIContent("This is a box", BoxTexture, "This is a tooltip"); }

void OnGUI() { GUI.Box(new Rect(0, 0, Screen.width, Screen.height), content); } }

Here is an example of a Box containing Text, with options set in a GUIStyle to position the Text in the center of the Box.

no example available in JavaScript
using UnityEngine;

public class BoxWithTextStyleExample : MonoBehaviour { GUIStyle style = new GUIStyle();

void Start() { // Position the Text in the center of the Box style.alignment = TextAnchor.MiddleCenter; }

void OnGUI() { GUI.Box(new Rect(0, 0, Screen.width, Screen.height), "This is a box", style); } }

Here is an example of a Box containing a Texture, with options set in a GUIStyle to position the Texture in the center of the Box.

no example available in JavaScript
using UnityEngine;

public class BoxWithTextureStyleExample : MonoBehaviour { public Texture BoxTexture; // Drag a Texture onto this item in the Inspector

GUIStyle style = new GUIStyle();

void Start() { // Position the Texture in the center of the Box style.alignment = TextAnchor.MiddleCenter; }

void OnGUI() { GUI.Box(new Rect(0, 0, Screen.width, Screen.height), BoxTexture, style); } }

Finally, here is an example of a Box containing a GUIContent, combining Text, Texture and Tooltip, with positional information contained in the GUIStyle parameter:

no example available in JavaScript
using UnityEngine;

public class BoxWithContentStyleExample : MonoBehaviour { public Texture BoxTexture; // Drag a Texture onto this item in the Inspector

GUIContent content; GUIStyle style = new GUIStyle();

void Start() { content = new GUIContent("This is a box", BoxTexture, "This is a tooltip");

// Position the Text and Texture in the center of the box style.alignment = TextAnchor.MiddleCenter;

// Position the Text below the Texture (rather than to the right of it) style.imagePosition = ImagePosition.ImageAbove; }

void OnGUI() { GUI.Box(new Rect(0, 0, Screen.width, Screen.height), content, style); } }