# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: CanvasGroup
type: class
memory_category: Gui
summary: |
  Blends descendants as a flattened group with an optional color/transparency
  modification.
description: |
  `CanvasGroup` renders its descendants as a flattened group with
  `Class.CanvasGroup.GroupColor3|GroupColor3` and
  `Class.CanvasGroup.GroupTransparency|GroupTransparency` optionally applied to
  the rendered result. `Class.UIComponent` visual modifiers such as
  `Class.UICorner` and `Class.UIGradient` under a `CanvasGroup` will also apply
  to the whole group. Note that `CanvasGroup` always has
  `Class.GuiObject.ClipsDescendants|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 `Class.LayerCollector` has its
    `Class.LayerCollector.ZIndexBehavior|ZIndexBehavior` set to
    `Enum.ZIndexBehavior.Sibling`.
  - `CanvasGroup` consumes extra texture memory. The quality of the texture and
    total memory usage is limited by the `Enum.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.
code_samples: []
inherits:
  - GuiObject
descendants: []
tags: []
deprecation_message: ''
properties:
  - name: CanvasGroup.GroupColor3
    summary: |
      Color tint that applies to the rendered group.
    description: |
      Color tint that applies to the rendered group.
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
  - name: CanvasGroup.GroupTransparency
    summary: |
      Transparency that applies to the rendered group.
    description: |
      Transparency that applies to the rendered group.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - UI
methods: []
events: []
callbacks: []