API

Interface BillboardPickInfo

Result of a successful pickBillboardSprite hit (re-exported from the public picker).

interface BillboardPickInfo {
    distance: number;
    pickedPoint: [number, number, number] | null;
    spriteIndex: number;
    system: BillboardSpriteSystem;
}
Index
distance: number

Distance from the camera to pickedPoint, or 0 when unavailable.

pickedPoint: [number, number, number] | null

World-space hit point reconstructed from the pick depth, or null if it could not be reconstructed.

spriteIndex: number

Index-API slot of the hit sprite within system (the value returned by addBillboardSpriteIndex).

system: BillboardSpriteSystem

The billboard system that owns the hit sprite.