Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

GUI.BeginGroup

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

public static method BeginGroup(position: Rect): void;
public static void BeginGroup(Rect position);
public static method BeginGroup(position: Rect, text: string): void;
public static void BeginGroup(Rect position, string text);
public static method BeginGroup(position: Rect, image: Texture): void;
public static void BeginGroup(Rect position, Texture image);
public static method BeginGroup(position: Rect, content: GUIContent): void;
public static void BeginGroup(Rect position, GUIContent content);
public static method BeginGroup(position: Rect, style: GUIStyle): void;
public static void BeginGroup(Rect position, GUIStyle style);
public static method BeginGroup(position: Rect, text: string, style: GUIStyle): void;
public static void BeginGroup(Rect position, string text, GUIStyle style);
public static method BeginGroup(position: Rect, image: Texture, style: GUIStyle): void;
public static void BeginGroup(Rect position, Texture image, GUIStyle style);
public static method BeginGroup(position: Rect, content: GUIContent, style: GUIStyle): void;
public static void BeginGroup(Rect position, GUIContent content, GUIStyle style);

Parameters

position Rectangle on the screen to use for the group.
text Text to display on the group.
image Texture to display on the group.
content Text, image and tooltip for this group. If supplied, any mouse clicks are "captured" by the group and not If left out, no background is rendered, and mouse clicks are passed.
style The style to use for the background.

Description

Begin a group. Must be matched with a call to EndGroup.

When you begin a group, the coordinate system for GUI controls are set so (0,0) is the top-left corner of the group. All controls are clipped to the group. Groups can be nested - if they are, children are clipped to their parents.

This is very useful when moving a bunch of GUI elements around on screen. A common use case is designing your menus to fit on a specific screen size, then centering the GUI on larger displays. See Also: matrix, BeginScrollView.

    function OnGUI () {
        // Constrain all drawing to be within a 800x600 pixel area centered on the screen.
        GUI.BeginGroup (new Rect (Screen.width / 2 - 400, Screen.height / 2 - 300, 800, 600));

// Draw a box in the new coordinate space defined by the BeginGroup. // Notice how (0,0) has now been moved on-screen GUI.Box (new Rect (0,0,800,600), "This box is now centered! - here you would put your main menu");

// We need to match all BeginGroup calls with an EndGroup GUI.EndGroup (); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void OnGUI() { GUI.BeginGroup(new Rect(Screen.width / 2 - 400, Screen.height / 2 - 300, 800, 600)); GUI.Box(new Rect(0, 0, 800, 600), "This box is now centered! - here you would put your main menu"); GUI.EndGroup(); } }

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