CanvasGroup

Not yet Class GUI

Blends descendants as a flattened group with an optional color/transparency modification.

Not implemented yet

Group clipping and tinting are not implemented.

Workaround: Tint children individually; use a Frame with ClipsDescendants for clipping.

0 Nova members · 8 modern Roblox members not implemented yet

Description

CanvasGroup renders its descendants as a flattened group with GroupColor3 and GroupTransparency optionally applied to the rendered result. UIComponent visual modifiers such as UICorner and UIGradient under a CanvasGroup will also apply to the whole group. Note that CanvasGroup always has ClipsDescendants set to true and all descendants will be clipped outside the group's bounds.

Important Notes

• Descendants of CanvasGroup will be rendered as a flattened texture only when the ancestor LayerCollector has its 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.
• It's recommended to use CanvasGroup with static sizes, otherwise a new texture would need to be created to accommodate new sizes.

Inheritance

Object → Instance → GuiBase → GuiBase2d → GuiObject → CanvasGroup

Properties

Member	Signature	Summary
GroupColor3	GroupColor3: Color3	Color tint that applies to the rendered group.
GroupTransparency	GroupTransparency: float	Transparency that applies to the rendered group.
ResolutionScale	ResolutionScale: float	—

Roblox reference: CanvasGroup

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.