aboutsummaryrefslogtreecommitdiff
path: root/files/zh-cn/web/api/webglrenderingcontext/clear/index.html
blob: ac8f04493388c586dbde892f265943b3f9af0179 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
---
title: WebGLRenderingContext.clear()
slug: Web/API/WebGLRenderingContext/clear
translation_of: Web/API/WebGLRenderingContext/clear
---
<div>{{APIRef("WebGL")}}</div>

<p><a href="/en-US/docs/Web/API/WebGL_API">WebGL API</a> 的 <strong><code>WebGLRenderingContext.clear()</code></strong> 方法使用预设值来清空缓冲。</p>

<p>预设值可以使用 {{domxref("WebGLRenderingContext.clearColor", "clearColor()")}} 、 {{domxref("WebGLRenderingContext.clearDepth", "clearDepth()")}}{{domxref("WebGLRenderingContext.clearStencil", "clearStencil()")}} 设置。</p>

<p>裁剪、抖动处理和缓冲写入遮罩会影响 <code>clear()</code> 方法。</p>

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

<pre class="syntaxbox">void <var>gl</var>.clear(<var>mask</var>);
</pre>

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

<dl>
 <dt><code>mask</code></dt>
 <dd>一个用于指定需要清除的缓冲区的 {{domxref("GLbitfield")}} 。可能的值有:
 <ul>
  <li><code>gl.COLOR_BUFFER_BIT   //颜色缓冲区</code></li>
  <li><code>gl.DEPTH_BUFFER_BIT   //深度缓冲区</code></li>
  <li><code>gl.STENCIL_BUFFER_BIT  //模板缓冲区</code></li>
 </ul>
 </dd>
</dl>

<h3 id="错误抛出">错误抛出</h3>

<p>如果mask不是以上列出的值,会抛出 <code>gl.INVALID_ENUM</code> 错误。</p>

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

<p></p>

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

<p><code>clear()</code> 方法可接受复合值,</p>

<pre class="brush: js">gl.clear(gl.DEPTH_BUFFER_BIT);
gl.clear(gl.DEPTH_BUFFER_BIT | gl.COLOR_BUFFER_BIT);
</pre>

<p>要获得当前的清除值,传入 <code>COLOR_CLEAR_VALUE</code>,、<code>DEPTH_CLEAR_VALUE或</code><code>STENCIL_CLEAR_VALUE</code> 常量。</p>

<pre class="brush: js">gl.getParameter(gl.COLOR_CLEAR_VALUE);
gl.getParameter(gl.DEPTH_CLEAR_VALUE);
gl.getParameter(gl.STENCIL_CLEAR_VALUE);
</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.11", "clear")}}</td>
   <td>{{Spec2('WebGL')}}</td>
   <td>Initial definition.</td>
  </tr>
  <tr>
   <td>{{SpecName('OpenGL ES 2.0', "glClear.xml", "glClear")}}</td>
   <td>{{Spec2('OpenGL ES 2.0')}}</td>
   <td>Man page of the OpenGL API.</td>
  </tr>
 </tbody>
</table>

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

<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p>

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

<h2 id="相关内容">相关内容</h2>

<ul>
 <li>{{domxref("WebGLRenderingContext.clearColor()")}}</li>
 <li>{{domxref("WebGLRenderingContext.clearDepth()")}}</li>
 <li>{{domxref("WebGLRenderingContext.clearStencil()")}}</li>
</ul>