Interface Renderer

Readonlybackend

Optional Readonlygpu

Optional Readonlyreason

apply

• apply(
      image: LinearImage | Rgba8Image,
      edit: unknown,
      options?: { scale?: number },
  ): Promise<LinearImage>

  Renders an edit document on a linear image (see applyEdit in @rullino/core).

  Parameters

  • image: LinearImage | Rgba8Image
  • edit: unknown
  • Optionaloptions: { scale?: number }

  Returns Promise<LinearImage>

destroy

• destroy(): void

  Releases the GPU device.

  Returns void

render

• render(
      input: Uint8Array<ArrayBufferLike> | Rgba8Image,
      edit: unknown,
  ): Promise<Rendered>

  Renders an edit document and encodes the result as the document's output says. The input is 8-bit RGBA pixels, or an encoded image file (JPEG, PNG, WebP, AVIF, TIFF... decoded by sharp, EXIF orientation applied). PNG is written by rullino (8 or 16 bit); JPEG and WebP by sharp.

  Parameters

  • input: Uint8Array<ArrayBufferLike> | Rgba8Image
  • edit: unknown

  Returns Promise<Rendered>