SkeletalPreview
Defined in: render/skeletalPreview.ts:57
An offscreen preview of one posed skeleton.
Its lifetime is the caller’s: whoever needs the preview to be alive holds
this, and dispose ends it. A disposed handle answers nothing rather than
quietly addressing whatever was made next.
Properties
Section titled “Properties”height
Section titled “height”
readonlyheight:number
Defined in: render/skeletalPreview.ts:61
readonlywidth:number
Defined in: render/skeletalPreview.ts:61
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get live():
boolean
Defined in: render/skeletalPreview.ts:73
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: render/skeletalPreview.ts:131
End it. Idempotent, and the id stops answering rather than addressing whatever is made next.
Returns
Section titled “Returns”void
render()
Section titled “render()”render(
viewProjection):Promise<ImageData|null>
Defined in: render/skeletalPreview.ts:103
Draw what has been handed over and resolve with the pixels, upright.
Null when this preview already has a readback in flight — one at a time, which is what keeps a landed image and the camera it was drawn with from drifting apart. The caller re-renders when the pending one lands.
Parameters
Section titled “Parameters”viewProjection
Section titled “viewProjection”Float32Array
Returns
Section titled “Returns”Promise<ImageData | null>
submit()
Section titled “submit()”submit(
batch):boolean
Defined in: render/skeletalPreview.ts:79
Hand over one batch. The engine copies it, so these buffers are the caller’s again the moment this returns.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”boolean
create()
Section titled “create()”
staticcreate(module,w,h):SkeletalPreview|null
Defined in: render/skeletalPreview.ts:66
A preview of w×h, or null where this core has no such surface.
Parameters
Section titled “Parameters”module
Section titled “module”unknown
number
number
Returns
Section titled “Returns”SkeletalPreview | null