pixi.js
    Preparing search index...

    Interface RopeGeometryOptionsAdvanced

    Constructor options used for RopeGeometry instances.

    const ropeGeometry = new RopeGeometry({
       points: [new Point(0, 0), new Point(100, 0)],
       width: 10,
       textureScale: 0,
    });

    RopeGeometry

    interface RopeGeometryOptions {
        points?: PointData[];
        textureScale?: number;
        width?: number;
    }
    Index

    Properties

    points? textureScale? width?

    Properties

    points?: PointData[]

    An array of points that determine the rope.

    textureScale?: number

    Rope texture scale, if zero then the rope texture is stretched. By default the rope texture will be stretched to match rope length. If textureScale is positive this value will be treated as a scaling factor and the texture will preserve its aspect ratio instead. To create a tiling rope set baseTexture.wrapMode to 'repeat' and use a power of two texture, then set textureScale=1 to keep the original texture pixel size. In order to reduce alpha channel artifacts provide a larger texture and downsample - i.e. set textureScale=0.5 to scale it down twice.

    width?: number

    The width (i.e., thickness) of the rope.

    Settings

    Member Visibility

    On This Page

    Properties