aboutsummaryrefslogtreecommitdiff
path: root/files/ja/web/api/webglrenderingcontext/clear/index.html
blob: 63742665a0dc89e88122e328a625676aae7c6b4f (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
---
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>ありません。</p>

<h3 id="例外">例外</h3>

<p><em>mask</em> が記載した値のうちどれでもない場合、<code>gl.INVALID_ENUM</code> エラーがスローされます。</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">仕様書</th>
   <th scope="col">策定状況</th>
   <th scope="col">コメント</th>
  </tr>
  <tr>
   <td>{{SpecName('WebGL', "#5.14.11", "clear")}}</td>
   <td>{{Spec2('WebGL')}}</td>
   <td>初回定義。</td>
  </tr>
  <tr>
   <td>{{SpecName('OpenGL ES 2.0', "glClear.xml", "glClear")}}</td>
   <td>{{Spec2('OpenGL ES 2.0')}}</td>
   <td>OpenGL API のマニュアルページ。</td>
  </tr>
 </tbody>
</table>

<h2 id="ブラウザーの対応">ブラウザーの対応</h2>

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

<h2 id="関連項目">関連項目</h2>

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