pixi-viewport
    Preparing search index...

    Class Clamp

    Plugin to clamp the viewport to a specific world bounding box.

    Hierarchy (View Summary)

    Index
    constructor
    last noUnderflow options parent paused underflowX underflowY
    destroy down globalToParent move parentToViewport pause reset resize resume up update viewportToParent wheel
    last: {
        scaleX: number | null;
        scaleY: number | null;
        screenHeight: number | null;
        screenWidth: number | null;
        x: number | null;
        y: number | null;
    }

    Last state of viewport

    noUnderflow: boolean
    options: Required<IClampOptions>

    Options used to initialize this plugin, cannot be modified later.

    parent: Viewport

    The viewport to which this plugin is attached.

    paused: boolean

    Flags whether this plugin has been "paused".

    • Plugin#pause
    • Plugin#resume
    underflowX: -1 | 0 | 1
    underflowY: -1 | 0 | 1

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods