WebGLRenderingContext.clear()

WebGL APIWebGLRenderingContext.clear() メソッドは、バッファーをプリセット値で消去します。

プリセット値は、clearColor(), clearDepth() や clearStencil() で設定可能です。

シザーボックス、ディザリング、バッファー書き込みマスクは clear() メソッドに影響します。

構文

void gl.clear(mask);

引数

mask
消去されるバッファーを示す GLbitfield (en-US) のビット論理和マスクです。以下の値を取ることができます。
  • gl.COLOR_BUFFER_BIT
  • gl.DEPTH_BUFFER_BIT
  • gl.STENCIL_BUFFER_BIT

返り値

ありません。

例外

mask が記載した値のうちどれでもない場合、gl.INVALID_ENUM エラーがスローされます。

clear() メソッドは複数の値を受け入れることができます。

gl.clear(gl.DEPTH_BUFFER_BIT);
gl.clear(gl.DEPTH_BUFFER_BIT | gl.COLOR_BUFFER_BIT);

現在の消去する値を取得するには、COLOR_CLEAR_VALUE, DEPTH_CLEAR_VALUE, や STENCIL_CLEAR_VALUE 定数で問い合わせます。

gl.getParameter(gl.COLOR_CLEAR_VALUE);
gl.getParameter(gl.DEPTH_CLEAR_VALUE);
gl.getParameter(gl.STENCIL_CLEAR_VALUE);

仕様策定状況

仕様書 策定状況 コメント
WebGL 1.0
clear の定義
勧告 初回定義。
OpenGL ES 2.0
glClear の定義
標準 OpenGL API のマニュアルページ。

ブラウザーの対応

BCD tables only load in the browser

関連項目