GUI.Box

Parameters

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:

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:

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:

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.

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.

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:

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);
    }
}