Interface GpuRenderer

Readonlycanvas

ReadonlymaxSize

setImage

• setImage(image: ImageDataLike | GpuImageSource, options?: ColorOptions): void

  Uploads the image to correct. Call once per image; render can then run any number of times. Throws a RangeError for an image wider or taller than GpuRenderer.maxSize.

  image can also be a GpuImageSource such as another canvas, copied on the GPU, which is much faster for a picture that is already there (a map drawn with WebGL, a video). Its pixels are not read back, so colorMode: 'auto' means rgb and autoStretch cannot take statistics from it: resolve it first (pipeline.resolve(stats)).

  Parameters

  • image: ImageDataLike | GpuImageSource
  • Optionaloptions: ColorOptions

  Returns void

render

• render(
      steps: readonly OpSpec[] | { ops: readonly OpSpec[] },
      options?: GpuRenderOptions,
  ): void

  Corrects the image with the steps of steps (a Pipeline or an array of steps) and draws the result on GpuRenderer.canvas. autoStretch takes its statistics from the image passed to setImage. A palette colors the result as it is drawn (see GpuRenderOptions).

  Parameters

  • steps: readonly OpSpec[] | { ops: readonly OpSpec[] }
  • Optionaloptions: GpuRenderOptions

  Returns void

read

• read(): ImageData

  The last rendered result as pixels, colored by its palette if it had one (a GPU-to-memory copy, so slower than render).

  Returns ImageData

dispose

• dispose(): void

  Frees the GPU memory. The renderer cannot be used afterwards.

  Returns void