大网数据广告活动
Web 标准与前端开发

GPURenderPassEncoder: setViewport() method

· 52CE 我爱测

The **`setViewport()`** method of the GPURenderPassEncoder interface sets the viewport used during the rasterization stage to linearly map from normalized device coordinates to viewport coordinates.

WebGPU API

The setViewport() method of the GPURenderPassEncoder interface sets the viewport used during the rasterization stage to linearly map from normalized device coordinates to viewport coordinates.

Syntax

setViewport(x, y, width, height, minDepth, maxDepth)

Parameters

  • x
    • : A number representing the minimum X value of the viewport, in pixels.
  • y
    • : A number representing the minimum Y value of the viewport, in pixels.
  • width
    • : A number representing the width of the viewport, in pixels.
  • height
    • : A number representing the height of the viewport, in pixels.
  • minDepth
    • : A number representing the minimum depth value of the viewport.
  • maxDepth
    • : A number representing the maximum depth value of the viewport.

[!NOTE] If a setViewport() call is not made, the default values are (0, 0, attachment width, attachment height, 0, 1) for each render pass.

Return value

None (undefined).

Validation

The following criteria must be met when calling setViewport(), otherwise a GPUValidationError is generated and the GPURenderPassEncoder becomes invalid:

  • x, y, width, and height are all greater than or equal to 0.
  • x + width is less than or equal to the width of the render pass's render attachments (see note below).
  • y + height is less than or equal to the height of the render pass's render attachments (see note below).
  • minDepth and maxDepth are both inside the range 0.0–1.0 inclusive.
  • minDepth is less than maxDepth.

[!NOTE] See the color and depth/stencil attachments specified in the descriptor of GPUCommandEncoder.beginRenderPass(); the width and height are based on that of the GPUTexture that their views originate from.

Examples

Basic snippet

In a typical canvas render, the following could be used to halve the width and height of the rendered graphics:

passEncoder.setViewport(0, 0, canvas.width / 2, canvas.height / 2, 0, 1);

In context

In the WebGPU Samples reversedZ example, setViewport is used several times to set the viewport for the different render passes. Study the example code listing for the full context.

For example:

// …

colorPass.setViewport(
  (canvas.width * m) / 2,
  0,
  canvas.width / 2,
  canvas.height,
  0,
  1,
);

// …

Specifications

Browser compatibility

See also

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。