effect-motion
API Referenceeffect-motionNamespacesEntityVariables

Image

const Image: TaggedStruct<"Image", {

Variable: Image

const Image: TaggedStruct<"Image", {
  height: optionalKey<Number>;
  image: TaggedStruct<"effect-motion/Resources/Image", {
     id: String;
  }>;
  opacity: withConstructorDefault<Number>;
  position: withConstructorDefault<TaggedStruct<"Vec3", {
     x: withConstructorDefault<Number>;
     y: withConstructorDefault<Number>;
     z: withConstructorDefault<Number>;
  }>>;
  rotation: withConstructorDefault<TaggedStruct<"Vec3", {
     x: withConstructorDefault<Number>;
     y: withConstructorDefault<Number>;
     z: withConstructorDefault<Number>;
  }>>;
  scale: withConstructorDefault<TaggedStruct<"Vec3", {
     x: withConstructorDefault<Number>;
     y: withConstructorDefault<Number>;
     z: withConstructorDefault<Number>;
  }>>;
  visible: withConstructorDefault<Boolean>;
  width: optionalKey<Number>;
}>;

Defined in: packages/motion/src/Entity.ts:271

A bitmap image leaf. image is an Image resource reference; the bytes live in the scene's requirements, never in frame data. Use PNG or JPEG: the Node renderer decodes only those (the browser decodes whatever createImageBitmap supports). SVG is not supported — trace it into Paths.

width/height are optional and undefaulted: set BOTH to draw at that size (numeric, so they tween), leave both absent for the source's natural size. A lone dimension is ignored — aspect math needs the natural size, which frame data never sees.

On this page