Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Background

Background configuration

The class defines the view background settings. The background can either be single colored or be a gradient between a top and a bottom color. Image backgrounds are also supported, in which case the image will be rendered on top of the specified background color.

You can access the background object from the remote model with the [[RemoteModel.background]] property.

Hierarchy

  • Background

Index

Accessors

Readonly bottomColor

bottomColor: Color4

The bottom color of the background.

If background is single color, the topColor and bottomColor properties are equal

Readonly image

image: Texture

If image background is in use it returns the image uses as a background.

Readonly topColor

topColor: Color4

The top color of the background.

If background is single color, the topColor and bottomColor properties are equal

Methods

setImage

  • setImage(texture: Texture | null): void
  • Use the given image as the background of the view

    Specify null to clear any previously specified background image.

    Parameters

    Returns void

setSingleColor

  • Sets the background color to the given color (single color)

    The background of the view will be cleared with the given color, and no graded background will be rendered. This is the default mode.

    Parameters

    Returns void

setTopAndBottomColor

  • Sets the background color to a gradient defined by a top color and a bottom color

    Parameters

    Returns void

Generated using TypeDoc