logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class UnityUiBackgroundComponent

    Unity-specific background UI component used for decorative menu backgrounds.
    Inherits from UnityUiComponent but is non-interactive: it does not participate in navigation or input.
    Holds references to the main background image and optional decorative elements that can be adapted to a layout area.

    Inheritance
    object
    UnityUiComponent
    UnityUiBackgroundComponent
    Inherited Members
    UnityUiComponent._animators
    UnityUiComponent.UpdateUiElement<T>(Action<T>, IFoundationViewElement)
    Namespace: Serenity.Ui.Infrastructure.Components
    Assembly: Serenity.UnityUi.Infrastructure.dll
    Syntax
    public class UnityUiBackgroundComponent : UnityUiComponent

    Constructors

    UnityUiBackgroundComponent()

    Declaration
    public UnityUiBackgroundComponent()

    Methods

    Awake()

    Validates configuration on Awake and warns if required references are missing.

    Declaration
    public override void Awake()
    Overrides
    UnityUiComponent.Awake()

    GetDecorations()

    Returns the array of decorative RectTransforms associated with this background.

    Declaration
    public RectTransform[] GetDecorations()
    Returns
    Type Description
    RectTransform[]

    GetMainImage()

    Returns the main background image RectTransform used as reference for layout.

    Declaration
    public RectTransform GetMainImage()
    Returns
    Type Description
    RectTransform

    Initialize(IUiComponentParameters, IUiComponentActions, ILogService)

    Initializes the background component.
    Reuses UnityUiComponent initialization logic (Animator discovery, logging, etc.),
    but does not add interactive behavior.

    Declaration
    public override void Initialize(IUiComponentParameters parameters, IUiComponentActions uiComponentActions, ILogService logService)
    Parameters
    Type Name Description
    IUiComponentParameters parameters
    IUiComponentActions uiComponentActions
    ILogService logService
    Overrides
    UnityUiComponent.Initialize(IUiComponentParameters, IUiComponentActions, ILogService)
    In this article
    © 2026 Serenity. All Rights Reserved