---
title: WebGLRenderingContext.viewport()
slug: Web/API/WebGLRenderingContext/viewport
tags:
  - WebGL
  - viewport
translation_of: Web/API/WebGLRenderingContext/viewport
---
<div>{{APIRef("WebGL")}}</div>

<p><a href="/en-US/docs/Web/API/WebGL_API">WebGL API</a> 的 <strong><code>WebGLRenderingContext.viewport()</code></strong> 方法，用来设置视口，即指定从标准设备到窗口坐标的x、y仿射变换。</p>

<h2 id="语法">语法</h2>

<pre class="syntaxbox"><var><em>void gl</em>.viewport</var><var>(x, y, width, height);</var>
</pre>

<h3 id="参数">参数</h3>

<dl>
 <dt><code>x</code></dt>
 <dd>{{domxref("GLint")}}，用来设定视口的左下角水平坐标。默认值：0。</dd>
 <dt><code>y</code></dt>
 <dd>{{domxref("GLint")}}，用来设定视口的左下角垂直坐标。默认值：0。</dd>
 <dt>width</dt>
 <dd>非负数{{domxref("Glsizei")}}，用来设定视口的宽度。默认值：canvas的宽度。</dd>
 <dt>height</dt>
 <dd>非负数{{domxref("Glsizei")}}，用来设定视口的高度。默认值：canvas的高度。</dd>
</dl>

<h3 id="返回值">返回值</h3>

<p>None.</p>

<h3 id="异常错误">异常错误</h3>

<p>只要宽度或高度有一个为负值，<code>gl.INVALID_VALUE错误将被抛出。</code>.</p>

<h2 id="样例">样例</h2>

<p>当你第一次创建WebGL上下文的时候，视口的大小将和canvas的大小是匹配的。然而，如果你重新改变了canvas的大小，你需要告诉WebGL上下文设定新的视口。在这里，你可以使用<code>gl.viewport。</code></p>

<pre class="brush: js">gl.viewport(0, 0, canvas.width, canvas.height);
</pre>

<p>视口的宽度和高度的设定范围是依赖于底层如何实现的。如果你要获取这个范围，你可以查询<code>MAX_VIEWPORT_DIMS</code> 常量，它将返回 {{jsxref("Int32Array")}}。</p>

<pre class="brush: js">gl.getParameter(gl.MAX_VIEWPORT_DIMS);
// e.g. Int32Array[16384, 16384]
</pre>

<p>如果要获取当前的视口，则可以查询<code>VIEWPORT</code> 常量。</p>

<pre class="brush: js">gl.getParameter(gl.VIEWPORT);
// e.g. Int32Array[0, 0, 640, 480]
</pre>

<h2 id="规范">规范</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('WebGL', "#5.14.4", "viewport")}}</td>
   <td>{{Spec2('WebGL')}}</td>
   <td>Initial definition.</td>
  </tr>
  <tr>
   <td>{{SpecName('OpenGL ES 2.0', "glViewport.xml", "glViewport")}}</td>
   <td>{{Spec2('OpenGL ES 2.0')}}</td>
   <td>Man page of the OpenGL API.</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容性">浏览器兼容性</h2>

<p>{{Compat("api.WebGLRenderingContext.viewport")}}</p>

<h2 id="另见">另见</h2>

<ul>
 <li>{{domxref("WebGLRenderingContext.scissor()")}}</li>
 <li>{{domxref("WebGLRenderingContext.getParameter()")}}</li>
</ul>