PokéRogue
    Preparing search index...

    Class Vignette

    The Vignette Filter Controller.

    This controller manages the vignette effect for a Camera.

    The vignette effect is a visual technique where the edges of the screen, or a Game Object, gradually darken or blur, creating a frame-like appearance. This effect is used to draw the player's focus towards the central action or subject, enhance immersion, and provide a cinematic or artistic quality to the game's visuals.

    This filter supports colored borders, and a limited set of blend modes, to increase its stylistic power.

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

    const camera = this.cameras.main;

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

    Hierarchy (View Summary)

    Index
    constructor
    active allowBaseDraw blendMode camera color currentPadding ignoreDestroy paddingOverride radius renderNode strength x y
    destroy getPadding getPaddingCeil setActive setColor setPaddingOverride

    • Parameters

      • camera: Camera

        The camera that owns this filter.

      • Optionalx: number

        The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1. Default 0.5.

      • Optionaly: number

        The vertical offset of the vignette effect. This value is normalized to the range 0 to 1. Default 0.5.

      • Optionalradius: number

        The radius of the vignette effect. This value is normalized to the range 0 to 1. Default 0.5.

      • Optionalstrength: number

        The strength of the vignette effect. Default 0.5.

      • Optionalcolor: string | number | Color | InputColorObject

        The color of the vignette effect, as a hex code or Color object. Default 0x000000.

      • OptionalblendMode: number

        The blend mode to use with the vignette. Only NORMAL, ADD, MULTIPLY, and SCREEN are supported. Default Phaser.BlendModes.NORMAL.

      Returns Vignette

    active: boolean

    Toggle this boolean to enable or disable this filter, without removing it from and re-adding it to the Camera's filter list.

    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.

    blendMode: BlendModes

    The blend mode used to combine the vignette color with the input. Note that only NORMAL, ADD, MULTIPLY and SCREEN are supported.

    camera: Camera

    A reference to the Camera that owns this filter.

    color: Color

    The color of the vignette effect.

    currentPadding: Rectangle

    The padding currently being used by this filter. This is read during rendering via getPadding, and may be updated by subclass implementations. It is necessary for filters being used in an external list. You should not modify this value directly.

    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.

    paddingOverride: 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.

    radius: number

    The radius of the vignette effect. This value is normalized to the range 0 to 1.

    renderNode: string

    The ID of the RenderNode that this filter uses.

    strength: number

    The strength of the vignette effect. Higher values produce a more intense, opaque vignette overlay at the edges, while lower values produce a subtler, more transparent effect.

    x: number

    The horizontal offset of the vignette effect. This value is normalized to the range 0 to 1.

    y: number

    The vertical offset of the vignette effect. This value is normalized to the range 0 to 1.

    • Destroys this Controller and nulls any references it holds.

      Returns void

    • Returns the raw padding required for this filter. This is typically not what you want to call; use getPaddingCeil instead. Values from this method are not rounded, which can cause quality loss.

      Override this method when creating a Filter that requires extra room, e.g. a blur or glow effect.undefined

      Returns Rectangle

      The padding required by this filter.

    • Returns the rounded padding required for this filter.

      Most filters don't need extra padding, but some may sample beyond the texture boundaries, such as a blur or glow effect.

      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.

      This method calls getPadding() to get the raw padding values, and uses Math.ceil() to set the values of paddingOverride and currentPadding.undefined

      Returns Rectangle

      The rounded padding required by this filter.

    • 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

      This filter instance.

    • Sets the color of the vignette overlay.

      Parameters

      • color: string | number | Color | InputColorObject

        The color to set. Note that a Color object will be copied, not attached.

      Returns this

      This filter instance.

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

      Parameters

      • Optionalleft: number | null

        The left 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