Language: English
  • C#
  • JS

Script language

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

GUI.Toggle

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

Switch to Manual
public static function Toggle(position: Rect, value: bool, text: string): bool;
public static bool Toggle(Rect position, bool value, string text);
public static function Toggle(position: Rect, value: bool, image: Texture): bool;
public static bool Toggle(Rect position, bool value, Texture image);
public static function Toggle(position: Rect, value: bool, content: GUIContent): bool;
public static bool Toggle(Rect position, bool value, GUIContent content);
public static function Toggle(position: Rect, value: bool, text: string, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, string text, GUIStyle style);
public static function Toggle(position: Rect, value: bool, image: Texture, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, Texture image, GUIStyle style);
public static function Toggle(position: Rect, value: bool, content: GUIContent, style: GUIStyle): bool;
public static bool Toggle(Rect position, bool value, GUIContent content, GUIStyle style);

Parameters

position Rectangle on the screen to use for the button.
value Is this button on or off?
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 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.
	var aTexture : Texture;
	
	private var toggleTxt : boolean = false;
	private var toggleImg : boolean = false;
	
	function OnGUI () {
		if(!aTexture) {
			Debug.LogError("Please assign a texture in the inspector.");
			return;
		}
	
		toggleTxt = GUI.Toggle(Rect(10, 10, 100, 30), toggleTxt, "A Toggle text");
		toggleImg = GUI.Toggle(Rect(10, 50, 50, 50), toggleImg, aTexture);
	}
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); } }