CanvasGroup
Show Deprecated
CanvasGroup renders descendants as a group with color and transparency applied to the render result. GuiEffect (UICorner and UIGradient) under CanvasGroup will also apply to the whole group. CanvasGroup always has GuiObject.ClipsDescendants set to true and all descendants will render within CanvasGroup's viewport.
Important notes:
- Descendants of CanvasGroup will be rendered as a flattened texture only when the ancestor LayerCollector has its LayerCollector.ZIndexBehavior set to ZIndexBehavior.Sibling.
- CanvasGroup consumes extra texture memory. The quality of the texture and total memory usage is limited by the QualityLevel of the client. When exceeding the memory cap, CanvasGroup will render as a blank texture.
- We recommend using CanvasGroup with static sizes, otherwise a new texture would need to be created to accommodate new sizes.
Summary
Properties
Color tint that applies to all descendants.
Transparency that applies to all descendants.
Properties inherited from Instance
Properties inherited from GuiObject
Properties inherited from GuiBase2d
Methods
Methods inherited from Instance
Methods inherited from GuiObject
Events
Events inherited from Instance
Events inherited from GuiObject
Events inherited from GuiBase2d
Properties
GroupColor3
Color tint that applies to all descendants.
GroupTransparency
Transparency that applies to all descendants.
Properties inherited from Instance
Properties inherited from GuiObject
Properties inherited from GuiBase2d
Methods
Methods inherited from Instance
Methods inherited from GuiObject
Events
Events inherited from Instance
Events inherited from GuiObject
Events inherited from GuiBase2d