pixi-viewport
    Preparing search index...

    Interface IClampOptions

    There are three ways to clamp:

    1. direction: 'all' = the world is clamped to its world boundaries, ie, you cannot drag any part of the world offscreen direction: 'x' | 'y' = only the x or y direction is clamped to its world boundary
    2. left, right, top, bottom = true | number = the world is clamped to the world's pixel location for each side; if any of these are set to true, then the location is set to the boundary [0, viewport.worldWidth/viewport.worldHeight] eg: to allow the world to be completely dragged offscreen, set [-viewport.worldWidth, -viewport.worldHeight, viewport.worldWidth * 2, viewport.worldHeight * 2]

    Underflow determines what happens when the world is smaller than the viewport

    1. none = the world is clamped but there is no special behavior
    2. center = the world is centered on the viewport
    3. combination of top/bottom/center and left/right/center (case insensitive) = the world is stuck to the appropriate boundaries
    interface IClampOptions {
        bottom?: number | boolean | null;
        direction?: "all" | "x" | "y" | null;
        left?: number | boolean | null;
        right?: number | boolean | null;
        top?: number | boolean | null;
        underflow?: string;
    }
    Index
    bottom? direction? left? right? top? underflow?
    bottom?: number | boolean | null

    Clamp bottom; true = viewport.worldHeight

    false
    direction?: "all" | "x" | "y" | null

    (all, x, or y) using clamps of [0, viewport.worldWidth/viewport.worldHeight]; replaces left/right/top/bottom if set

    null
    left?: number | boolean | null

    Clamp left; true = 0

    false
    right?: number | boolean | null

    Clamp right; true = viewport.worldWidth

    false
    top?: number | boolean | null

    Clamp top; true = 0

    false
    underflow?: string

    Where to place world if too small for screen (e.g., top-right, center, none, bottomleft)

    'center'

    Settings
    Member Visibility

    On This Page
    Properties