Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

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

GUI.Label

Switch to Manual
public static function Label(position: Rect, text: string): void;
public static function Label(position: Rect, image: Texture): void;
public static function Label(position: Rect, content: GUIContent): void;
public static function Label(position: Rect, text: string, style: GUIStyle): void;
public static function Label(position: Rect, image: Texture, style: GUIStyle): void;
public static function Label(position: Rect, content: GUIContent, style: GUIStyle): 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!");
	}

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