CanvasRenderingContext2D:drawImage() 方法
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since 2015年7月.
* Some parts of this feature may have varying levels of support.
Canvas 2D API 的 CanvasRenderingContext2D.drawImage() 方法提供了多种在画布(Canvas)上绘制图像的方式。
语法
drawImage(image, dx, dy)
drawImage(image, dx, dy, dWidth, dHeight)
drawImage(image, sx, sy, sWidth, sHeight, dx, dy, dWidth, dHeight)

参数
image-
绘制到上下文的元素。允许任何的画布图像源,例如:
HTMLImageElement、SVGImageElement、HTMLVideoElement、HTMLCanvasElement、ImageBitmap、OffscreenCanvas或VideoFrame。 sx可选-
需要绘制到目标上下文中的,源
image的子矩形(裁剪)的左上角 X 轴坐标。可以使用 3 参数或 5 参数语法来省略这个参数。 sy可选-
需要绘制到目标上下文中的,源
image的子矩形(裁剪)的左上角 Y 轴坐标。可以使用 3 参数或 5 参数语法来省略这个参数。 sWidth可选-
需要绘制到目标上下文中的,源
image的子矩形(裁剪)的宽度。如果不指定,整个矩形(裁剪)从坐标的sx和sy开始,到image的右下角结束。可以使用 3 参数或 5 参数语法来省略这个参数。使用负值将翻转这个图像。 sHeight可选-
需要绘制到目标上下文中的,
image的矩形(裁剪)选择框的高度。可以使用 3 参数或 5 参数语法来省略这个参数。使用负值将翻转这个图像。 dx-
源
image的左上角在目标画布上 X 轴坐标。 dy-
源
image的左上角在目标画布上 Y 轴坐标。 dWidth-
image在目标画布上绘制的宽度。允许对绘制的图像进行缩放。如果不指定,在绘制时image宽度不会缩放。注意,这个参数不包含在 3 参数语法中。 dHeight-
image在目标画布上绘制的高度。允许对绘制的图像进行缩放。如果不指定,在绘制时image高度不会缩放。注意,这个参数不包含在 3 参数语法中。
返回值
无(undefined)。
异常
InvalidStateErrorDOMException-
当图像没有数据或者画布或源矩形宽度/高度为零时抛出该异常。
TypeMismatchErrorDOMException-
当将
null或undefined值作为图像的参数传入时抛出该异常。
示例
>在画布上绘制图像
此示例在画布中使用 drawImage() 方法绘制一张图像。
HTML
<canvas id="canvas"></canvas>
<div style="display:none;">
<img
id="source"
src="https://mdn.github.io/shared-assets/images/examples/rhino.jpg"
width="300"
height="227" />
</div>
JavaScript
原图像从坐标 (33,71) 处截取一个宽度为 104 高度为 124 的图像。并将其绘制到画布的 (21, 20) 坐标处,并将其缩放为宽 87、高 104 的图像。
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
const image = document.getElementById("source");
image.addEventListener("load", (e) => {
ctx.drawImage(image, 33, 71, 104, 124, 21, 20, 87, 104);
});
结果
理解源元素大小
drawImage() 方法在绘制时使用源元素的以 CSS 像素为单位的固有尺寸。
例如,如果加载图像(Image)并在其构造函数中指定可选的大小参数,则必须使用所创建实例的 naturalWidth 和 naturalHeight 属性来正确计算裁剪和缩放区域等内容,而不是 element.width 和 element.height。如果元素是 <video> 元素,则 videoWidth 和 videoHeight 也是如此,依此类推。
HTML
<canvas id="canvas"></canvas>
JavaScript
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
const image = new Image(); // 创建一个新的图片对象
image.width = 60; // 使用可选的图片尺寸
image.height = 45; // 使用可选的图片尺寸
image.onload = drawImageActualSize; // 图片加载完成后进行绘制
// 加载一个固定尺寸(以 CSS 像素为单位)为 300x227 的图片
image.src = "https://mdn.github.io/shared-assets/images/examples/rhino.jpg";
function drawImageActualSize() {
// 在画布上使用图片的实际尺寸(以 CSS 像素为单位)
canvas.width = this.naturalWidth;
canvas.height = this.naturalHeight;
// 绘制图片,使用它的固定尺寸 300x227,忽略构造函数中给定的自定义尺寸 60x45
ctx.drawImage(this, 0, 0);
// 若要使用自定义尺寸,必须指定缩放参数
// 让我们在画布的左上角绘制一个使用元素宽度和高度属性的图片:
ctx.drawImage(this, 0, 0, this.width, this.height);
}
结果
规范
| Specification |
|---|
| HTML> # dom-context-2d-drawimage-dev> |
浏览器兼容性
Loading…
备注
drawImage()对于HTMLVideoElement只有在其HTMLMediaElement.readyState大于 1(即设置currentTime属性后触发 seek 事件)时才能正确工作。- 在绘制,裁剪和/或缩放时,
drawImage()将始终使用源元素以 CSS 像素为单位的固有尺寸。 - 在某些旧版本浏览器中,
drawImage()将忽略图像中的所有 EXIF 元数据,包括方向。此行为在 iOS 设备上尤其麻烦。你应该自己检测方向并使用rotate()使其正确。
参见
- 定义该方法的接口:
CanvasRenderingContext2D