Class
CanvasGroup
Blends descendants as a flattened group with an optional color/transparency modification.
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
CanvasGroupwill be rendered as a flattened texture only when the ancestorLayerCollectorhas itsZIndexBehaviorset toZIndexBehavior.Sibling. CanvasGroupconsumes extra texture memory. The quality of the texture and total memory usage is limited by theQualityLevelof the client. When exceeding the memory cap,CanvasGroupwill render as a blank texture.- It's recommended to use
CanvasGroupwith static sizes, otherwise a new texture would need to be created to accommodate new sizes.
Properties 2#
GroupColor3Color3 | Color tint that applies to the rendered group.ReadSafe |
GroupTransparencyfloat | Transparency that applies to the rendered group.ReadSafe |
Inherited members#
Inherited from GuiObject 51
Properties (30)
Active, AnchorPoint, AutomaticSize, BackgroundColor, BackgroundColor3, BackgroundTransparency, BorderColor, BorderColor3, BorderMode, BorderSizePixel, ClipsDescendants, Draggable, GuiState, InputSink, Interactable, LayoutOrder, NextSelectionDown, NextSelectionLeft, NextSelectionRight, NextSelectionUp, Position, Rotation, Selectable, SelectionImageObject, SelectionOrder, Size, SizeConstraint, Transparency, Visible, ZIndex
Methods (3)
Inherited from GuiBase2d 12
Properties (11)
AbsolutePosition, AbsoluteRotation, AbsoluteSize, AutoLocalize, Localize, RootLocalizationTable, SelectionBehaviorDown, SelectionBehaviorLeft, SelectionBehaviorRight, SelectionBehaviorUp, SelectionGroup
Events (1)
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild