WebGLRenderingContext.clearStencil()

WebGL API の WebGLRenderingContext.clearStencil() メソッドは、ステンシルバッファーを消去する値を指定します。

この指定は、clear() メソッドを呼ぶときに使用されるステンシルの値です。

構文

void gl.clearStencil(s);

引数

s
インデックスを指定する GLint (en-US) で、ステンシルバッファーの消去に使用される値です。既定値は 0 です。

返り値

ありません。

例

gl.clearStencil(1);

現在のステンシルを消去する値を取得するには、STENCIL_CLEAR_VALUE 定数で問い合わせます。

gl.getParameter(gl.STENCIL_CLEAR_VALUE);
// 1

仕様策定状況

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

ブラウザーの対応

BCD tables only load in the browser

関連項目