Version: 2023.2
LanguageEnglish
  • C#

GUI.Button

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

Declaration

public static bool Button(Rect position, string text);

Declaration

public static bool Button(Rect position, Texture image);

Declaration

public static bool Button(Rect position, GUIContent content);

Declaration

public static bool Button(Rect position, string text, GUIStyle style);

Declaration

public static bool Button(Rect position, Texture image, GUIStyle style);

Declaration

public static bool Button(Rect position, GUIContent content, GUIStyle style);

Parameters

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

Returns

bool true when the users clicks the button.

Description

Make a single press button. The user clicks them and something happens immediately.

// Draws 2 buttons, one with an image, and other with a text
// And print a message when they got clicked.

using UnityEngine; using System.Collections;

public class ExampleClass : MonoBehaviour { public Texture btnTexture;

void OnGUI() { if (!btnTexture) { Debug.LogError("Please assign a texture on the inspector"); return; }

if (GUI.Button(new Rect(10, 10, 50, 50), btnTexture)) Debug.Log("Clicked the button with an image");

if (GUI.Button(new Rect(10, 70, 50, 30), "Click")) Debug.Log("Clicked the button with text"); } }