effect-motion
API ReferencerendererNamespacesImagesFunctions

ready

function ready(images, id): Effect<DecodedImage, EffectMotionError>;

Function: ready()

function ready(images, id): Effect<DecodedImage, EffectMotionError>;

Defined in: packages/renderer/src/Images.ts:164

Await the decoded texture for an id.

Parameters

ParameterType
imagesImages
idstring

Returns

Effect<DecodedImage, EffectMotionError>

Remarks

register must have run first — asking for an unregistered image is a defect, though in practice Sync.resolveResources guarantees registration for anything a frame references. A failed decode arrives as a typed error naming the image.

On this page