Source/System/State/NVidia/OSGRegisterCombinersChunk.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="RegisterCombinersChunk"
   5    parent="StateChunk"
   6    library="State"
   7    pointerfieldtypes="both"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    decoratable="false"
  12    docGroupBase="GrpStateNVidia"
  13    ><![CDATA[
  14 See \ref PageSystemRegisterCombinersChunk for a description.
  15
  16 Try to avoid using this chunk, as it is very non-portable. Using a shader
  17 instead is recommend, and much easier to do.
  18
  19 This chunk wraps nVidia's register combiners. The
  20 OSG::RegisterCombinersChunk::setCombinerRGB and
  21 OSG::RegisterCombinersChunk::setCombinerAlpha convenience functions
  22 should be used,
  23 which set up all the parameters for a single combiner's RGB or alpha part.
  24 OSG::RegisterCombinersChunk::setFinalCombiner sets all parameters for the
  25 final combiner. The constants are set by
  26 OSG::RegisterCombinersChunk::setConstantColors(Color4f &color0, Color4f
  27 &color1) for the gloabl constants and
  28 OSG::RegisterCombinersChunk::setConstantColors(UInt16 which,
  29 Color4f &color0,
  30 Color4f &color1) for the per-combiner constants (if supported). To reset a
  31 combiner one or all of the combiners use
  32 OSG::RegisterCombinersChunk::clearCombiners or
  33 OSG::RegisterCombinersChunk::clearCombiner.
  34
  35 Don't use the direct field access to set the register combiner's parameter
  36 unlesss you really have to, as the internal representation is a bit
  37 non-intuitive.
  38
  39 \ext To reduce the number of fields there isn't a field for every parameter,
  40 instead they are kept in blocks of three in the fields. Please refer to the
  41 source code for details.
  42 \endext]]>
  43   <Field
  44          name="color0"
  45          type="Color4f"
  46          cardinality="single"
  47          visibility="external"
  48          access="public"
  49          >
  50   </Field>
  51   <Field
  52          name="color1"
  53          type="Color4f"
  54          cardinality="single"
  55          visibility="external"
  56          access="public"
  57          >
  58   </Field>
  59   <Field
  60          name="colorSumClamp"
  61          type="bool"
  62          cardinality="single"
  63          visibility="external"
  64          defaultValue="false"
  65          access="public"
  66          >
  67   </Field>
  68   <Field
  69          name="variableArgb"
  70          type="GLenum"
  71          cardinality="multi"
  72          visibility="external"
  73          access="public"
  74          >
  75         input,mapping,component Usage triples for variable A, RGB part
  76   </Field>
  77   <Field
  78          name="variableBrgb"
  79          type="GLenum"
  80          cardinality="multi"
  81          visibility="external"
  82          access="public"
  83          >
  84   </Field>
  85   <Field
  86          name="variableCrgb"
  87          type="GLenum"
  88          cardinality="multi"
  89          visibility="external"
  90          access="public"
  91          >
  92   </Field>
  93   <Field
  94          name="variableDrgb"
  95          type="GLenum"
  96          cardinality="multi"
  97          visibility="external"
  98          access="public"
  99          >
 100   </Field>
 101   <Field
 102          name="variableAalpha"
 103          type="GLenum"
 104          cardinality="multi"
 105          visibility="external"
 106          access="public"
 107          >
 108   </Field>
 109   <Field
 110          name="variableBalpha"
 111          type="GLenum"
 112          cardinality="multi"
 113          visibility="external"
 114          access="public"
 115          >
 116   </Field>
 117   <Field
 118          name="variableCalpha"
 119          type="GLenum"
 120          cardinality="multi"
 121          visibility="external"
 122          access="public"
 123          >
 124   </Field>
 125   <Field
 126          name="variableDalpha"
 127          type="GLenum"
 128          cardinality="multi"
 129          visibility="external"
 130          access="public"
 131          >
 132   </Field>
 133   <Field
 134          name="outputABrgb"
 135          type="GLenum"
 136          cardinality="multi"
 137          visibility="external"
 138          access="public"
 139          >
 140   </Field>
 141   <Field
 142          name="outputCDrgb"
 143          type="GLenum"
 144          cardinality="multi"
 145          visibility="external"
 146          access="public"
 147          >
 148   </Field>
 149   <Field
 150          name="outputSumrgb"
 151          type="GLenum"
 152          cardinality="multi"
 153          visibility="external"
 154          access="public"
 155          >
 156   </Field>
 157   <Field
 158          name="scalergb"
 159          type="GLenum"
 160          cardinality="multi"
 161          visibility="external"
 162          access="public"
 163          >
 164   </Field>
 165   <Field
 166          name="biasrgb"
 167          type="GLenum"
 168          cardinality="multi"
 169          visibility="external"
 170          access="public"
 171          >
 172   </Field>
 173   <Field
 174          name="outputABalpha"
 175          type="GLenum"
 176          cardinality="multi"
 177          visibility="external"
 178          access="public"
 179          >
 180   </Field>
 181   <Field
 182          name="outputCDalpha"
 183          type="GLenum"
 184          cardinality="multi"
 185          visibility="external"
 186          access="public"
 187          >
 188   </Field>
 189   <Field
 190          name="outputSumalpha"
 191          type="GLenum"
 192          cardinality="multi"
 193          visibility="external"
 194          access="public"
 195          >
 196   </Field>
 197   <Field
 198          name="dotABrgb"
 199          type="UInt8"
 200          cardinality="multi"
 201          visibility="external"
 202          access="public"
 203          >
 204   </Field>
 205   <Field
 206          name="dotCDrgb"
 207          type="UInt8"
 208          cardinality="multi"
 209          visibility="external"
 210          access="public"
 211          >
 212   </Field>
 213   <Field
 214          name="muxSumrgb"
 215          type="UInt8"
 216          cardinality="multi"
 217          visibility="external"
 218          access="public"
 219          >
 220   </Field>
 221   <Field
 222          name="scalealpha"
 223          type="GLenum"
 224          cardinality="multi"
 225          visibility="external"
 226          access="public"
 227          >
 228   </Field>
 229   <Field
 230          name="biasalpha"
 231          type="GLenum"
 232          cardinality="multi"
 233          visibility="external"
 234          access="public"
 235          >
 236   </Field>
 237   <Field
 238          name="muxSumalpha"
 239          type="UInt8"
 240          cardinality="multi"
 241          visibility="external"
 242          access="public"
 243          >
 244   </Field>
 245   <Field
 246          name="variableE"
 247          type="GLenum"
 248          cardinality="multi"
 249          visibility="external"
 250          access="public"
 251          >
 252   </Field>
 253   <Field
 254          name="variableF"
 255          type="GLenum"
 256          cardinality="multi"
 257          visibility="external"
 258          access="public"
 259          >
 260   </Field>
 261   <Field
 262          name="variableG"
 263          type="GLenum"
 264          cardinality="multi"
 265          visibility="external"
 266          access="public"
 267          >
 268   </Field>
 269   <Field
 270          name="combinerColor0"
 271          type="Color4f"
 272          cardinality="multi"
 273          visibility="external"
 274          access="public"
 275          >
 276   </Field>
 277   <Field
 278          name="combinerColor1"
 279          type="Color4f"
 280          cardinality="multi"
 281          visibility="external"
 282          access="public"
 283          >
 284   </Field>
 285   <Field
 286          name="perStageConstants"
 287          type="UInt8"
 288          cardinality="single"
 289          visibility="internal"
 290          access="public"
 291          >
 292   </Field>
 293 </FieldContainer>