Home
  • English
  • 中文
Home
  • English
  • 中文
  • Get Started

    • Install
    • Hello LGUI
    • Custom Button
    • Use custom font
    • Prefab workflow
    • Interaction
    • Button from scratch
  • Sample Projects

    • Sample Projects
  • Prefab Workflow

    • LGUI Prefab
    • PrefabEditor
    • LGUILifeCycleBehaviour
    • LGUIPrefabInterface
  • Rendering

    • LGUICanvas
    • Screen Space Overlay
    • World Space - UE Renderer
    • World Space - LGUI Renderer
    • LGUI render flow
    • UICanvasGroup
  • Visual Components

    • UIText
    • UIEffect
    • TextAnimation
    • UIBackgroundBlur
    • UIBackgroundPixelate
  • Events

    • LGUIEventDelegate
    • LGUIEventSystem
  • Interaction Components

    • UISelectable component
  • Layout

    • Basic Layout
    • Auto Layout
  • Tween Animation

    • LTween
    • Use LTween for UI element
  • Performance

    • LGUI Stat
  • ReleaseNotes

    • LGUI 3.x
    • LGUI 2.x
  • FAQ

    • Why use prefab?
    • Update project from LGUI2 to LGUI3
    • Project 3d world position to LGUI's screen 2d position
    • Deproject LGUI's screen position to world
    • Use custom material for UI elements
    • Disable interaction component
    • Find Child by DisplayName
    • Get actor or component inside prefab
    • Anti-aliasing

UICanvasGroup

The UI Canvas Group can be used to control certain aspects of a whole group of UI elements from one place without needing to handle them each individually. The properties of the UICanvasGroup affect the UI element it is on as well as all children.

Properties

Property:Function:
AlphaThe opacity of the UI elements in this group. The value is between 0 and 1 where 0 is fully transparent and 1 is fully opaque. Note that elements retain their own transparency as well, so the UICanvasGroup alpha and the alpha values of the individual UI elements are multiplied with each other.
InteractableDetermines if this component will accept input. When it is set to false interaction is disabled.
RestrictNavigationAreaWhen use navigation input (keyboard or gamepad navigation), restrict navigation area to only children of this UI element when navigate out.
IgnoreParentGroupWill this group also be affected by the settings in UICanvasGroup components further up in the UI element hierarchy, or will it ignore those and hence override them?

Details

Typical uses of UICanvasGroup are:

  • Fading in or out a whole window by adding a UICanvasGroup on the UI actor of the Window and control its Alpha property.
  • Making a whole set of controls non-interactable ("grayed out") by adding a UICanvasGroup to a parent UI actor and setting its Interactable property to false.
Last Updated:
Contributors: lf2007hf
Prev
LGUI render flow