glStencilFunc

glStencilFunc 関数はステンシルテスト用の関数と参照値を設定する。

glStencilFunc func, ref, mask

func : [int] テスト関数。次の 8 トークンが有効: GL_NEVER (常に失敗)、GL_LESS / GL_LEQUAL / GL_GREATER / GL_GEQUAL / GL_EQUAL / GL_NOTEQUAL ((ref & mask) と (stencil & mask) の比較が条件を満たすとき合格)、GL_ALWAYS (常に合格)。
ref : [int] 
mask : [int] テスト実行時に参照値および格納されたステンシル値の両方と AND されるマスク。

(プラグイン / モジュール : opengl32.dll)

解説

glStencilFunc 関数はステンシルテスト用の関数と参照値を設定する。

[戻り値]
この関数は値を返さない。

[備考]
ステンシリングは z バッファリング同様にピクセル単位で描画を有効/無効にする。OpenGL
の描画プリミティブでステンシルプレーンに描き、その後ジオメトリや画像をレンダリングする際にステンシルプレーンで画面の一部をマスクする。ステンシリングは通常マルチパスレンダリングでデカール、輪郭線、CSG
描画などの特殊効果に使われる。ステンシルテストは参照値とステンシルバッファの値の比較結果に基づきピクセルを条件付きで除外する。glEnable
/ glDisable に GL_STENCIL_TEST を指定して有効化する。テスト結果に応じた動作は glStencilOp
で指定する。func はステンシル比較関数を決めるシンボル定数で 8 種類のいずれかを受け付ける。ref は比較に使う整数参照値で [0,
2^n - 1] にクランプされる (n はステンシルバッファのビットプレーン数)。mask は参照値と格納値の両方とビット AND
され、AND 結果が比較に使われる。比較に成功した場合のみピクセルがラスタ化の次段階に渡される。stencil
値はすべて符号なし整数として扱われる。初期状態ではステンシルテストは無効。ステンシルバッファが無い場合、変更は起こらず常に合格扱いとなる。関連情報は
glGet (GL_STENCIL_FUNC / VALUE_MASK / REF / BITS) と glIsEnabled
(GL_STENCIL_TEST) で取得できる。

情報