Skip to main content
Version: 0.12

Image Layer

etro.layer.Image renders an <img> element to the movie.

Usage​

import etro from 'etro';

const layer = new etro.layer.Image({
  startTime: 0,
  duration: 5,
  source: new Image(),
  sourceX: 0, // default: 0
  sourceY: 0, // default: 0
  sourceWidth: 400, // default: null (full width)
  sourceHeight: 400, // default: null (full height)
  x: 0, // default: 0
  y: 0, // default: 0
  width: 400, // default: null (full width)
  height: 400, // default: null (full height)
  opacity: 1, // default: 1
});

Inheritance​

etro.layer.Image inherits from etro.layer.Visual.

Options​

source​

The <img> element to render.

sourceX​

tip

This is a Dynamic Property.

The x position to crop the image from. The default value is 0.

sourceY​

tip

This is a Dynamic Property.

The y position to crop the image from. The default value is 0.

sourceWidth​

tip

This is a Dynamic Property.

The width to crop the image to. The default value is null, which means the image will be cropped to the full width of the image.

sourceHeight​

tip

This is a Dynamic Property.

The height to crop the image to. The default value is null, which means the image will be cropped to the full height of the image.