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

GUI.Toggle

public static bool Toggle(Rect position, bool value, string text);
public static bool Toggle(Rect position, bool value, Texture image);
public static bool Toggle(Rect position, bool value, GUIContent content);
public static bool Toggle(Rect position, bool value, string text, GUIStyle style);
public static bool Toggle(Rect position, bool value, Texture image, GUIStyle style);
public static bool Toggle(Rect position, bool value, GUIContent content, GUIStyle style);

Parameters

positionRectangle on the screen to use for the button.
valueIs this button on or off?
textText to display on the button.
image Texture to display on the button.
contentText, image and tooltip for this button.
styleThe style to use. If left out, the toggle style from the current GUISkin is used.

Returns

bool The new value of the button.

Description

Make an on/off toggle button.

// Draws 2 toggle controls, one with a text, the other with an image.

using UnityEngine; using System.Collections;

public class ExampleClass : MonoBehaviour { public Texture aTexture;

private bool toggleTxt = false; private bool toggleImg = false;

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

toggleTxt = GUI.Toggle(new Rect(10, 10, 100, 30), toggleTxt, "A Toggle text"); toggleImg = GUI.Toggle(new Rect(10, 50, 50, 50), toggleImg, aTexture); } }

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