Source/System/State/OpenGL/OSGStencilChunk.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="StencilChunk"
   5    parent="StateChunk"
   6    library="State"
   7    pointerfieldtypes="both"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    decoratable="false"
  12    useLocalIncludes="false"
  13    docGroupBase="GrpStateOpenGL"
  14    >
  15   The stencil chunk handles OpenGL stencil tests by wrapping glStencilFunc()
  16   and glStencilOp().
  17   <Field
  18          name="stencilFunc"
  19          type="GLenum"
  20          cardinality="single"
  21          visibility="external"
  22          defaultValue="GL_NONE"
  23          defaultHeader="OSGGL.h"
  24          access="public"
  25          >
  26         The stencilFunc defines how fragments which do not fulfill a certain
  27         condition are handled.
  28     See glStencilFunc() for details. GL_NONE is used to disable stencil.
  29   </Field>
  30   <Field
  31          name="stencilValue"
  32          type="Int32"
  33          cardinality="single"
  34          visibility="external"
  35          defaultValue="0"
  36          access="public"
  37          >
  38         The stencilFunc defines how fragments which do not fulfill a certain
  39         condition are handled.
  40     See glStencilFunc() for details. GL_NONE is used to disable stencil.
  41   </Field>
  42   <Field
  43          name="stencilMask"
  44          type="UInt32"
  45          cardinality="single"
  46          visibility="external"
  47          defaultValue="0x1"
  48          access="public"
  49          >
  50         The stencilFunc defines how fragments which do not fulfill a certain
  51         condition are handled.
  52     See glStencilFunc() for details. GL_NONE is used to disable stencil.
  53   </Field>
  54   <Field
  55          name="stencilOpFail"
  56          type="GLenum"
  57          cardinality="single"
  58          visibility="external"
  59          defaultValue="GL_KEEP"
  60          defaultHeader="OSGGL.h"
  61          access="public"
  62          >
  63         The stencilFunc defines how fragments which do not fulfill a certain
  64         condition are handled.
  65     See glStencilFunc() for details. GL_NONE is used to disable stencil.
  66   </Field>
  67   <Field
  68          name="stencilOpZFail"
  69          type="GLenum"
  70          cardinality="single"
  71          visibility="external"
  72          defaultValue="GL_KEEP"
  73          defaultHeader="OSGGL.h"
  74          access="public"
  75          >
  76         The stencilFunc defines how fragments which do not fulfill a certain
  77         condition are handled.
  78     See glStencilFunc() for details. GL_NONE is used to disable stencil.
  79   </Field>
  80   <Field
  81          name="stencilOpZPass"
  82          type="GLenum"
  83          cardinality="single"
  84          visibility="external"
  85          defaultValue="GL_KEEP"
  86          defaultHeader="OSGGL.h"
  87          access="public"
  88          >
  89         The stencilFunc defines how fragments which do not fulfill a certain
  90         condition are handled.
  91     See glStencilFunc() for details. GL_NONE is used to disable stencil.
  92   </Field>
  93   <Field
  94          name="clearBuffer"
  95          type="Int32"
  96          cardinality="single"
  97          visibility="external"
  98          defaultValue="0"
  99          access="public"
 100          >
 101         Clear buffer on activate(1) or deactivate(2).
 102   </Field>
 103   <Field
 104          name="bitMask"
 105          type="UInt32"
 106          cardinality="single"
 107          visibility="external"
 108          defaultValue="0xFFFFFFFF"
 109          access="public"
 110          >
 111         Controls writing of individual bits in stencil planes, with 0 means write
 112         protected and 1 write enabled.
 113   </Field>
 114 </FieldContainer>