Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#

GUI.Label

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

Parameters

positionRectangle on the screen to use for the label.
textText to display on the label.
image Texture to display on the label.
contentText, image and tooltip for this label.
styleThe style to use. If left out, the label style from the current GUISkin is used.

Description

Make a text or texture label on screen.

Labels have no user interaction, do not catch mouse clicks and are always rendered in normal style. If you want to make a control that responds visually to user input, use a Box control.

Example: Draw the classic Hello World! string:


Text label on the Game View.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void OnGUI() { GUI.Label(new Rect(10, 10, 100, 20), "Hello World!"); } }

Example: Draw a texture on-screen. Labels are also used to display textures, instead of a string, simply pass in a texture:


Texture Label.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Texture2D textureToDisplay;

void OnGUI() { GUI.Label(new Rect(10, 40, textureToDisplay.width, textureToDisplay.height), textureToDisplay); } }

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