Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

CanvasGroup

CanvasGroup : Frame

Overview

CanvasGroup is a Frame-based UI container that composites itself and all of its descendant UI elements into a single image for rendering, and then applies color and transparency to the entire result at once.

Adjusting the transparency of each descendant UI element individually makes the overlapping parts of the elements show through, but with CanvasGroup's GroupTransparency, all descendants can be faded in and out uniformly as if they were a single image.

CanvasGroup can be controlled only in client environment.

Properties

GroupColor3

Color3

A property that specifies the color multiplied into the composited result of the CanvasGroup and all of its descendant UI elements.

The default value is white, in which case the original colors are displayed without any color correction. Each color component is limited to the range 0 to 1.

Code Samples

GroupTransparency

number

A property that specifies the transparency of the composited result of the CanvasGroup and all of its descendant UI elements.

0 means completely opaque, and 1 means completely invisible. The default value is 0, and values outside the range 0 to 1 are clamped to that range.

Code Samples

Methods

Events

Last updated