Source/System/State/Base/OSGUniformBufferObjChunk.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4     name="UniformBufferObjChunk"
   5     parent="UniformBufferObjBaseChunk"
   6     library="System"
   7     pointerfieldtypes="both"
   8     structure="concrete"
   9     systemcomponent="true"
  10     parentsystemcomponent="true"
  11     decoratable="false"
  12     useLocalIncludes="false"
  13     docGroupBase="GrpSystemState"
  14     >
  15     See \ref PageSystemUniformBufferObjChunk for a description.
  16
  17     This chunk wraps the OpenGL uniform buffer object extension (ARB_uniform_buffer_object).
  18
  19     <Field
  20         name="GLId"
  21         type="GLenum"
  22         cardinality="single"
  23         visibility="internal"
  24         access="public"
  25         defaultValue="0"
  26         fieldFlags="FClusterLocal"
  27         >
  28             The OpenGL object id for this uniform buffer object.
  29     </Field>
  30     <Field
  31         name="usage"
  32         type="GLenum"
  33         cardinality="single"
  34         visibility="external"
  35         access="public"
  36         defaultValue="GL_STATIC_DRAW"
  37         potential_values="GL_STREAM_DRAW, GL_STREAM_READ, GL_STREAM_COPY, GL_STATIC_DRAW, GL_STATIC_READ, GL_STATIC_COPY, GL_DYNAMIC_DRAW, GL_DYNAMIC_READ, GL_DYNAMIC_COPY"
  38         >
  39                 Specifies the expected usage pattern of the data store. The symbolic constant must be
  40                  GL_STREAM_DRAW, GL_STREAM_READ, GL_STREAM_COPY,
  41                  GL_STATIC_DRAW, GL_STATIC_READ, GL_STATIC_COPY,
  42                  GL_DYNAMIC_DRAW, GL_DYNAMIC_READ, or GL_DYNAMIC_COPY.
  43     </Field>
  44     <Field
  45         name="blockName"
  46         type="std::string"
  47         cardinality="single"
  48         visibility="external"
  49         access="public"
  50         >
  51                 The name of the uniform block.
  52     </Field>
  53     <Field
  54         name="fundamentalTypes"
  55         type="UInt8"
  56         cardinality="multi"
  57         visibility="external"
  58         access="protected"
  59         >
  60                 Stores the fundamental type of  a block entry. This can be any of the set {NONE_T, FLOAT_T, DOUBLE_T, INT_T, UINT_T, BOOL_T}.
  61     </Field>
  62     <Field
  63         name="mainTypes"
  64         type="UInt8"
  65         cardinality="multi"
  66         visibility="external"
  67         access="protected"
  68         >
  69                 Stores the main type of  a block entry. This can be any of the set {SIMPLE_T, VEC2_T, VEC3_T, VEC4_T, MAT2_T, MAT3_T, MAT4_T,
  70                 MAT2X3_T, MAT2X4_T, MAT3X4_T, MAT3X2_T, MAT4X2_T, MAT4X3_T, STRUCT_BEGIN_T, STRUCT_END_T}.
  71     </Field>
  72     <Field
  73         name="cardinality"
  74         type="UInt32"
  75         cardinality="multi"
  76         visibility="external"
  77         access="protected"
  78         >
  79                 Stores the cardinality of array structure elements.
  80     </Field>
  81     <Field
  82         name="index"
  83         type="UInt32"
  84         cardinality="multi"
  85         visibility="external"
  86         access="protected"
  87         >
  88                 Stores the index pointer into the value containers.
  89     </Field>
  90     <Field
  91         name="names"
  92         type="std::string"
  93         cardinality="multi"
  94         visibility="external"
  95         access="protected"
  96         >
  97                 Stores the index pointer into the value containers.
  98     </Field>
  99     <Field
 100         name="nameToIndex"
 101         type="StringToUInt32Map"
 102         cardinality="single"
 103         visibility="external"
 104         access="protected"
 105         >
 106                 Stores the mapping from names into the index container.
 107     </Field>
 108     <Field
 109         name="floatValues"
 110         type="Real32"
 111         cardinality="multi"
 112         visibility="external"
 113         access="protected"
 114         >
 115                 The float values.
 116     </Field>
 117     <Field
 118         name="doubleValues"
 119         type="Real64"
 120         cardinality="multi"
 121         visibility="external"
 122         access="protected"
 123         >
 124                 The double values.
 125     </Field>
 126     <Field
 127         name="intValues"
 128         type="Int32"
 129         cardinality="multi"
 130         visibility="external"
 131         access="protected"
 132         >
 133                 The int values.
 134     </Field>
 135     <Field
 136         name="uIntValues"
 137         type="UInt32"
 138         cardinality="multi"
 139         visibility="external"
 140         access="protected"
 141         >
 142                 The unsigned int values.
 143     </Field>
 144     <Field
 145         name="boolValues"
 146         type="UInt8"
 147         cardinality="multi"
 148         visibility="external"
 149         access="protected"
 150         >
 151                 The bool values.
 152     </Field>
 153 </FieldContainer>