PokéRogue
    Preparing search index...

    Class Sampler

    The Sampler Filter Controller.

    This controller reads pixel data from the camera's rendered output and passes it to a user-defined callback. Unlike other filter controllers, the Sampler does not alter the rendered image in any way — it is purely a data extraction tool. It can sample a single point, a rectangular region, or the entire camera view, and is useful for techniques such as color picking, pixel-perfect hit detection, or runtime visual analysis.

    This operation is expensive, so use sparingly.

    A Sampler is added to a Camera via the FilterList component:

    const camera = this.cameras.main;

    camera.filters.internal.addSampler(callback, region);
    camera.filters.external.addSampler(callback, region);

    Hierarchy (View Summary)

    Index
    constructor
    active allowBaseDraw callback camera currentPadding ignoreDestroy paddingOverride region renderNode
    destroy getPadding getPaddingCeil setActive setPaddingOverride

    • Parameters

      • camera: Camera

        The Camera that owns this filter.

      • callback: SnapshotCallback

        The callback to call with the results of the sampler.

      • Optionalregion: Vector2Like | Rectangle | null

        The region to sample. If null, the entire camera view is sampled. If a Phaser.Types.Math.Vector2Like, a point is sampled. If a Phaser.Geom.Rectangle, the region is sampled. Default null.

      Returns Sampler

    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.

    callback: SnapshotCallback

    The callback to invoke once the pixel data has been read from the sampled region. It receives the snapshot result, which may be an HTMLImageElement (for region snapshots) or a Phaser.Display.Color (for point snapshots), depending on the region type.

    camera: Camera

    A reference to the Camera that owns this filter.

    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.

    region: Vector2Like | Rectangle | null

    The region to sample. If null, the entire camera view is sampled. If a Phaser.Types.Math.Vector2Like, a point is sampled. If a Phaser.Geom.Rectangle, the region is sampled.

    renderNode: string

    The ID of the RenderNode that this filter uses.

    • 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 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