ステンシル バッファ

 解説

ステンシルバッファとは数値を記録するバッファです。
主な使用用途は数値による描画のマスクなどです。

ステンシルバッファはデプスバッファより先に評価されます。
この優先度があることは重要です。

バッファの深さを調べる場合は glGetIntegerv で
第１引数に GL_STENCIL_BITS を指定してやると
第２引数のアドレスに GLint の値を１つ入れて返ってきます。
戻ってきた値は１ピクセルあたりのビットの数です。
(これより以下はビットの深さが 8 として説明します。)

初期化は GLUT にて、
glutInitDisplayMode で GLUT_STENCIL のビットをたてる。

glClear にて GL_STENCIL_BUFFER_BIT を指定してクリア。
クリアする場合の初期値は glClearStencil で設定。
また、有効にするために GL_STENCIL_TEST を glEnable する必要があります。

バッファの評価は glStencilFunc を用いて行います。
第１引数で評価法で第２引数を用いて評価します。
ただし、第２引数の数値とステンシルバッファの数値は
評価する前に第３引数の数値によって AND をとります。
評価法は以下のとおり、

GL_NEVER:全て採用されない
GL_LESS:バッファより値が小さければ採用
GL_LEQUAL:バッファの値以下であれば採用
GL_EQUAL:バッファの値と同じであれば採用
GL_GREATER:バッファより値が大きければ採用
GL_NOTEQUAL:バッファの値と同じでなければ採用
GL_GEQUAL:バッファの値以上であれば採用
GL_ALWAYS:常に採用される

ステンシルバッファでは描画を行った後に
どのようにバッファを更新するかという更新法も指定します。
更新法は glStencilOp で指定します。

第１引数は評価においてステンシルバッファが採用されなかった場合。
第２引数はステンシルバッファは採用されたが、デプスバッファが採用されなかった場合。
第３引数はステンシルバッファが採用されデプスバッファも採用されたか無い場合。

更新の評価は第１引数から第２引数、第３引数の順で行われます。
まずステンシルバッファを評価し、
ステンシルバッファが採用されなかったら第１引数の更新法を使用。
ステンシルバッファが採用された場合は次にデプスバッファを評価し、
デプスバッファが採用されなかったら第２引数の更新法を使用。
デプスバッファが採用されたかデプスバッファが存在しない場合は第３引数の更新法を使用。

更新する数値は次のように指定します。

GL_KEEP:更新しない
GL_ZERO: 0 で更新する
GL_REPLACE:glStencilFunc の第２引数で更新する
GL_INCR: 1 だけ増やす
GL_DECR: 1 だけ減らす
GL_INVERT: 現在のビットを反転する

また glStencilMask ではステンシルバッファ自体をマスクできる。
これも AND をとるので 0xFF でマスク無しと同じ状態。
0x00 ですべてマスクされた状態となる。