gameforge - v0.1.12
    Preparing search index...

    Class BackgroundSystem

    The background system manages the background color and alpha of the main view.

    PIXI

    Implements

    Index

    Constructors

    constructor

    Properties

    clearBeforeRender defaultOptions

    Accessors

    alpha backgroundColor color

    Methods

    destroy init

    Constructors

    Properties

    clearBeforeRender: boolean

    This sets if the CanvasRenderer will clear the canvas or not before the new render pass. If the scene is NOT transparent PixiJS will use a canvas sized fillRect operation every frame to set the canvas background color. If the scene is transparent PixiJS will use clearRect to clear the canvas every frame. Disable this by setting this to false. For example, if your game has a canvas filling background image you often don't need this set.
    defaultOptions: BackgroundSystemOptions

    Accessors

    • get alpha(): number

      The background color alpha. Setting this to 0 will make the canvas transparent.

      Returns number

    • set alpha(value: number): void

      Parameters

      • value: number

      Returns void

    • get backgroundColor(): Color

      The background color object.

      Returns Color

    • get color(): ColorSource

      The background color to fill if not transparent.

      Returns ColorSource

    • set color(value: ColorSource): void

      Parameters

      Returns void

    Methods

    • Generic destroy methods to be overridden by the subclass

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods