Hilo3d API - v2.0.0-alpha.3
    Preparing search index...

    Interface SpriteParameters

    interface SpriteParameters {
        anchorX?: number;
        anchorY?: number;
        anim?: Animation | null;
        animationId?: string;
        autoPlay?: boolean;
        autoUpdateChildWorldMatrix?: boolean;
        autoUpdateWorldMatrix?: boolean;
        castShadows?: boolean;
        frame?: SpriteFrame;
        frameRate?: number;
        frames?: readonly SpriteFrame[];
        height?: number;
        jointName?: string;
        layer?: number;
        loop?: boolean;
        material?: SpriteMaterial;
        name?: string;
        needCallChildUpdate?: boolean;
        onlySyncQuaternion?: boolean;
        onUpdate?: ((deltaTime: number) => void) | null;
        parent?: Node | null;
        pivotX?: number;
        pivotY?: number;
        pivotZ?: number;
        pointerChildren?: boolean;
        pointerEnabled?: boolean;
        receiveShadows?: boolean;
        renderOrder?: number;
        rotationX?: number;
        rotationY?: number;
        rotationZ?: number;
        scaleX?: number;
        scaleY?: number;
        scaleZ?: number;
        sortingLayer?: number;
        texture?: Texture<TextureImageSource>;
        tint?: Color;
        up?: Vector3;
        useHandCursor?: boolean;
        userData?: unknown;
        visible?: boolean;
        width?: number;
        x?: number;
        y?: number;
        z?: number;
        zIndex?: number;
    }

    Hierarchy

    • Omit<MeshParameters, "geometry" | "material" | "useInstanced" | "frustumTest">
      • SpriteParameters
    Index
    anchorX? anchorY? anim? animationId? autoPlay? autoUpdateChildWorldMatrix? autoUpdateWorldMatrix? castShadows? frame? frameRate? frames? height? jointName? layer? loop? material? name? needCallChildUpdate? onlySyncQuaternion? onUpdate? parent? pivotX? pivotY? pivotZ? pointerChildren? pointerEnabled? receiveShadows? renderOrder? rotationX? rotationY? rotationZ? scaleX? scaleY? scaleZ? sortingLayer? texture? tint? up? useHandCursor? userData? visible? width? x? y? z? zIndex?
    anchorX?: number

    Horizontal anchor in normalized local coordinates. Defaults to the visual center (0.5).

    anchorY?: number

    Vertical anchor in normalized local coordinates. Defaults to the visual center (0.5).

    anim?: Animation | null
    animationId?: string
    autoPlay?: boolean

    Start sequence playback immediately when more than one frame exists.

    autoUpdateChildWorldMatrix?: boolean
    autoUpdateWorldMatrix?: boolean
    castShadows?: boolean
    frame?: SpriteFrame

    Initial frame shorthand.

    frameRate?: number

    Default animation rate when frames do not carry an explicit duration.

    frames?: readonly SpriteFrame[]

    Sequence frames, normally from one shared texture atlas.

    height?: number

    Logical display height. Defaults to the initial frame height.

    jointName?: string
    layer?: number

    Scene-layer bit mask. A node is renderable when at least one bit overlaps the active camera's visibility mask.

    loop?: boolean

    Whether sequence playback wraps at the end.

    material?: SpriteMaterial

    Optional customized material. Sprites sharing a material can batch together.

    name?: string
    needCallChildUpdate?: boolean
    onlySyncQuaternion?: boolean
    onUpdate?: ((deltaTime: number) => void) | null
    parent?: Node | null
    pivotX?: number
    pivotY?: number
    pivotZ?: number
    pointerChildren?: boolean
    pointerEnabled?: boolean
    receiveShadows?: boolean
    renderOrder?: number
    rotationX?: number
    rotationY?: number
    rotationZ?: number
    scaleX?: number
    scaleY?: number
    scaleZ?: number
    sortingLayer?: number

    Coarse 2D display layer. Higher values render later.

    This is independent from layer, which is a camera-visibility bit mask.

    texture?: Texture<TextureImageSource>

    Full texture shorthand when no explicit frame list is supplied.

    tint?: Color

    Per-instance color multiplier.

    up?: Vector3
    useHandCursor?: boolean
    userData?: unknown
    visible?: boolean
    width?: number

    Logical display width. Defaults to the initial frame width.

    x?: number
    y?: number
    z?: number
    zIndex?: number

    Fine 2D display order within sortingLayer. Higher values render later.

    Settings
    Member Visibility

    On This Page
    Properties