Language: English
  • C#
  • JS
  • Boo

Script language

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

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

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

Parameters

position Rectangle on the screen to use for the label.
text Text to display on the label.
image Texture to display on the label.
content Text, image and tooltip for this label.
style The 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.

	function OnGUI () {
		GUI.Label (Rect (10, 10, 100, 20), "Hello World!");
	}
using UnityEngine;
using System.Collections;

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

public class ExampleClass(MonoBehaviour):

	def OnGUI() as void:
		GUI.Label(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.

	var textureToDisplay : Texture2D;
	
	function OnGUI () {
		GUI.Label (Rect (10, 40, textureToDisplay.width, textureToDisplay.height),
			textureToDisplay);
	}
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);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public textureToDisplay as Texture2D

	def OnGUI() as void:
		GUI.Label(Rect(10, 40, textureToDisplay.width, textureToDisplay.height), textureToDisplay)