Version: Unity 6.7 Alpha (6000.7)
LanguageEnglish
  • C#

GUILayout.Button

Leave feedback
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(Texture image, params GUILayoutOption[] options);

Parameters

Parameter Description
image Texture to display on the button.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool true when the users clicks the button.

Description

Make a single press button.

Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicked.



Buttons in the Game View.

Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    // Draws a button with an image and a button with text
    Texture tex;

    void OnGUI()
    {
        if (!tex)
        {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

        if (GUILayout.Button(tex))
        {
            Debug.Log("Clicked the image");
        }
        if (GUILayout.Button("I am a regular Automatic Layout Button"))
        {
            Debug.Log("Clicked Button");
        }
    }
}

Declaration

public static bool Button(string text, params GUILayoutOption[] options);

Parameters

Parameter Description
text Text to display on the button.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool true when the users clicks the button.

Description

Make a single press button.

Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicked.



Buttons in the Game View.

Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    // Draws a button with an image and a button with text
    Texture tex;

    void OnGUI()
    {
        if (!tex)
        {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

        if (GUILayout.Button(tex))
        {
            Debug.Log("Clicked the image");
        }
        if (GUILayout.Button("I am a regular Automatic Layout Button"))
        {
            Debug.Log("Clicked Button");
        }
    }
}

Declaration

public static bool Button(GUIContent content, params GUILayoutOption[] options);

Parameters

Parameter Description
content Text, image and tooltip for this button.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool true when the users clicks the button.

Description

Make a single press button.

Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicked.



Buttons in the Game View.

Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    // Draws a button with an image and a button with text
    Texture tex;

    void OnGUI()
    {
        if (!tex)
        {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

        if (GUILayout.Button(tex))
        {
            Debug.Log("Clicked the image");
        }
        if (GUILayout.Button("I am a regular Automatic Layout Button"))
        {
            Debug.Log("Clicked Button");
        }
    }
}

Declaration

public static bool Button(Texture image, GUIStyle style, params GUILayoutOption[] options);

Parameters

Parameter Description
image Texture to display on the button.
style The style to use. If left out, the button style from the current GUISkin is used.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool true when the users clicks the button.

Description

Make a single press button.

Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicked.



Buttons in the Game View.

Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    // Draws a button with an image and a button with text
    Texture tex;

    void OnGUI()
    {
        if (!tex)
        {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

        if (GUILayout.Button(tex))
        {
            Debug.Log("Clicked the image");
        }
        if (GUILayout.Button("I am a regular Automatic Layout Button"))
        {
            Debug.Log("Clicked Button");
        }
    }
}

Declaration

public static bool Button(string text, GUIStyle style, params GUILayoutOption[] options);

Parameters

Parameter Description
text Text to display on the button.
style The style to use. If left out, the button style from the current GUISkin is used.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool true when the users clicks the button.

Description

Make a single press button.

Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicked.



Buttons in the Game View.

Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    // Draws a button with an image and a button with text
    Texture tex;

    void OnGUI()
    {
        if (!tex)
        {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

        if (GUILayout.Button(tex))
        {
            Debug.Log("Clicked the image");
        }
        if (GUILayout.Button("I am a regular Automatic Layout Button"))
        {
            Debug.Log("Clicked Button");
        }
    }
}

Declaration

public static bool Button(GUIContent content, GUIStyle style, params GUILayoutOption[] options);

Parameters

Parameter Description
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.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight

Returns

bool true when the users clicks the button.

Description

Make a single press button.

Create a GUILayout.Button that can be pressed and released as a normal button. When this GUILayout.Button is released the Button returns the expected true value. If the mouse is moved off the button it is not clicked.



Buttons in the Game View.

Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight

using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    // Draws a button with an image and a button with text
    Texture tex;

    void OnGUI()
    {
        if (!tex)
        {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

        if (GUILayout.Button(tex))
        {
            Debug.Log("Clicked the image");
        }
        if (GUILayout.Button("I am a regular Automatic Layout Button"))
        {
            Debug.Log("Clicked Button");
        }
    }
}

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2005-2026 Unity Technologies. All rights reserved. Built from job ID 72102643. Built on: 2026-07-22.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Do Not Sell or Share My Personal Information