CanvasRenderingContext2D: putImageData() 方法

Baseline 已广泛支持

此特性已相当成熟,可在许多设备和浏览器版本上使用。自 ⁨2015 年 7 月⁩以来,各浏览器均已提供此特性。

Canvas 2D API 的 CanvasRenderingContext2D.putImageData() 方法可以将给定 ImageData 对象中的数据绘制到画布上。如果提供了脏矩形,则只绘制该矩形内的像素。此方法不受画布变换矩阵的影响。

注意:可以使用 getImageData() 方法从画布中检索图像数据。

您可以在文章 使用 Canvas 进行像素操作 中找到有关 putImageData() 和 Canvas 内容的常规操作的更多信息。

语法

js
putImageData(imageData, dx, dy)
putImageData(imageData, dx, dy, dirtyX, dirtyY, dirtyWidth, dirtyHeight)

参数

imageData

一个包含像素值数组的 ImageData 对象。

dx

在目标画布上放置图像数据的水平位置(x 坐标)。

dy

在目标画布上放置图像数据的垂直位置(y 坐标)。

dirtyX 可选

将要从中提取图像数据的左上角的水平位置(x 坐标)。默认为 0

dirtyY 可选

将要从中提取图像数据的左上角的垂直位置(y 坐标)。默认为 0

dirtyWidth 可选

要绘制的矩形的宽度。默认为图像数据的宽度。

dirtyHeight 可选

要绘制的矩形的高度。默认为图像数据的高度。

返回值

无(undefined)。

异常

NotSupportedError DOMException

如果任何参数是无穷大,则抛出此异常。

InvalidStateError DOMException

如果 ImageData 对象的 data 已被分离,则抛出此异常。

示例

理解 putImageData

为了理解此算法的内部工作原理,下面是一个基于 CanvasRenderingContext2D.fillRect() 的实现。

HTML

html
<canvas id="canvas"></canvas>

JavaScript

js
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");

function putImageData(
  ctx,
  imageData,
  dx,
  dy,
  dirtyX = 0,
  dirtyY = 0,
  dirtyWidth = imageData.width,
  dirtyHeight = imageData.height,
) {
  const data = imageData.data;
  const height = imageData.height;
  const width = imageData.width;
  const limitBottom = dirtyY + dirtyHeight;
  const limitRight = dirtyX + dirtyWidth;
  for (let y = dirtyY; y < limitBottom; y++) {
    for (let x = dirtyX; x < limitRight; x++) {
      const pos = y * width + x;
      ctx.fillStyle = `rgb(${data[pos * 4 + 0]} ${data[pos * 4 + 1]}
      ${data[pos * 4 + 2]} / ${data[pos * 4 + 3] / 255})`;
      ctx.fillRect(x + dx, y + dy, 1, 1);
    }
  }
}

// Draw content onto the canvas
ctx.fillRect(0, 0, 100, 100);
// Create an ImageData object from it
const imagedata = ctx.getImageData(0, 0, 100, 100);
// use the putImageData function that illustrates how putImageData works
putImageData(ctx, imagedata, 150, 0, 50, 50, 25, 25);

结果

浏览器优化导致的数据丢失

警告:由于转换为和从预乘 alpha 颜色值转换的损失性质,刚刚使用 putImageData() 设置的像素可能在等效的 getImageData() 返回时显示不同的值。

JavaScript

js
const canvas = document.createElement("canvas");
canvas.width = 1;
canvas.height = 1;
const context = canvas.getContext("2d");
const imgData = context.getImageData(0, 0, canvas.width, canvas.height);
const pixels = imgData.data;
pixels[0 + 0] = 1;
pixels[0 + 1] = 127;
pixels[0 + 2] = 255;
pixels[0 + 3] = 1;
console.log("before:", pixels);
context.putImageData(imgData, 0, 0);
const imgData2 = context.getImageData(0, 0, canvas.width, canvas.height);
const pixels2 = imgData2.data;
console.log("after:", pixels2);

输出可能如下所示

before: Uint8ClampedArray(4) [ 1, 127, 255, 1 ]
after: Uint8ClampedArray(4) [ 255, 255, 255, 1 ]

规范

规范
HTML
# dom-context-2d-putimagedata-dev

浏览器兼容性

另见