phaser - v4.0.0-rc.4
    Preparing search index...

    Class Shadow

    The Shadow Filter.

    This filter controller manages the shadow effect for a Camera.

    The shadow effect is a visual technique used to create the illusion of depth and realism by adding darker, offset silhouettes or shapes beneath game objects, characters, or environments. These simulated shadows help to enhance the visual appeal and immersion, making the 2D game world appear more dynamic and three-dimensional.

    A Shadow effect is added to a Camera via the FilterList component:

    const camera = this.cameras.main;

    camera.filters.internal.addShadow();
    camera.filters.external.addShadow();

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active allowBaseDraw camera color currentPadding decay glcolor ignoreDestroy intensity paddingOverride power renderNode samples x y

    Methods

    destroy getPadding setActive setPaddingOverride

    Constructors

    • Parameters

      • camera: Cameras.Scene2D.Camera

        The camera that owns this filter.

      • Optionalx: number

        The horizontal offset of the shadow effect. Default 0.

      • Optionaly: number

        The vertical offset of the shadow effect. Default 0.

      • Optionaldecay: number

        The amount of decay for the shadow effect. Default 0.1.

      • Optionalpower: number

        The power of the shadow effect. Default 1.

      • Optionalcolor: number

        The color of the shadow, as a hex value. Default 0x000000.

      • Optionalsamples: number

        The number of samples that the shadow effect will run for. Default 6.

      • Optionalintensity: number

        The intensity of the shadow effect. Default 1.

      Returns Shadow

    Properties

    active: boolean

    Toggle this boolean to enable or disable this filter, without removing and adding it from the Game Object.

    allowBaseDraw: boolean

    If true, this filter will be permitted to draw to the base texture. This can be unwanted if, for example, the filter doesn't actually draw anything.

    This is an internal flag used by the renderer. You should not modify this value directly.

    camera: Cameras.Scene2D.Camera

    A reference to the Camera that owns this filter.

    color: number

    The color of the shadow.

    currentPadding: Geom.Rectangle

    The padding currently being used by this filter. This is set and used during rendering using getPadding. It is necessary for filters being used in an external list. You should not modify this value directly.

    decay: number

    The amount of decay for the shadow effect.

    glcolor: number[]

    The internal gl color array.

    ignoreDestroy: boolean

    Whether this filter controller will be destroyed when the FilterList that owns it is destroyed. If you enable this, you must ensure that you clean up the filter controller at an appropriate time. This allows you to reuse a controller for multiple objects; this is not recommended unless you know what you're doing. It tends to work best with external filters.

    intensity: number

    The intensity of the shadow effect.

    paddingOverride: Geom.Rectangle

    Padding override. This is on by default. If this is set, the filter will use this padding instead of calculating it. Prefer using setPaddingOverride instead of modifying this directly.

    power: number

    The power of the shadow effect.

    renderNode: string

    The ID of the RenderNode that this filter uses.

    samples: number

    The number of samples that the shadow effect will run for.

    This should be an integer with a minimum value of 1 and a maximum of 12.

    x: number

    The horizontal offset of the shadow effect.

    y: number

    The vertical offset of the shadow effect.

    Methods

    • Returns the padding required for this filter, and sets currentPadding to the result. Most filters don't need extra padding, but some might sample beyond the texture size, such as a blur.

      The bounds are encoded as a Rectangle. To enlarge the bounds, the top and left values should be negative, and the bottom and right values should be positive.

      Returns Geom.Rectangle

    • Sets the active state of this filter.

      A disabled filter will not be used.

      Parameters

      • value: boolean

        true to enable this filter, or false to disable it.

      Returns this

    • Sets the padding override. If this is set, the filter will use this padding instead of calculating them. it Call setPaddingOverride(null) to clear the override. Call setPaddingOverride() to set the padding to 0.

      Parameters

      • Optionalleft: number

        The top padding. Default 0.

      • Optionaltop: number

        The top padding. Default 0.

      • Optionalright: number

        The right padding. Default 0.

      • Optionalbottom: number

        The bottom padding. Default 0.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods