Source/System/Image/OSGImage.fcd

   1 <?xml version="1.0"?>
   2
   3 <FieldContainer
   4    name="Image"
   5    parent="AttachmentContainer"
   6    library="System"
   7    pointerfieldtypes="both"
   8    structure="concrete"
   9    systemcomponent="true"
  10    parentsystemcomponent="true"
  11    decoratable="false"
  12    useLocalIncludes="false"
  13    fieldsUnmarkedOnCreate="(ComponentSizeFieldMask | SideSizeFieldMask | FrameSizeFieldMask)"
  14    childFields="single"
  15    docGroupBase="GrpSystemImage"
  16    >
  17
  18   1D/2D/3D Image with various pixel types data, optionally also can hold
  19   mipMap and simple multi-frame data.
  20
  21   <Field
  22          name="parents"
  23          type="FieldContainer"
  24          cardinality="multi"
  25          visibility="internal"
  26          access="none"
  27      category="parentpointer"
  28          >
  29   </Field>
  30   <Field
  31          name="dimension"
  32          type="Int32"
  33          cardinality="single"
  34          visibility="external"
  35          defaultValue="0"
  36          access="public"
  37          >
  38         Image dimension, 0 for invalid, 1 for 1D, 2 for 2D and 3 for 3D data.
  39   </Field>
  40   <Field
  41          name="width"
  42          type="Int32"
  43          cardinality="single"
  44          visibility="external"
  45          defaultValue="0"
  46          access="public"
  47          >
  48   </Field>
  49   <Field
  50          name="height"
  51          type="Int32"
  52          cardinality="single"
  53          visibility="external"
  54          defaultValue="1"
  55          access="public"
  56          >
  57   </Field>
  58   <Field
  59          name="depth"
  60          type="Int32"
  61          cardinality="single"
  62          visibility="external"
  63          defaultValue="1"
  64          access="public"
  65          >
  66   </Field>
  67   <Field
  68          name="bpp"
  69          type="Int32"
  70          cardinality="single"
  71          visibility="external"
  72          defaultValue="1"
  73          access="public"
  74          >
  75     Bytes of data per pixel.
  76   </Field>
  77   <Field
  78          name="mipMapCount"
  79          type="Int32"
  80          cardinality="single"
  81          visibility="external"
  82          defaultValue="1"
  83          access="public"
  84          >
  85   </Field>
  86   <Field
  87          name="frameCount"
  88          type="Int32"
  89          cardinality="single"
  90          visibility="external"
  91          defaultValue="1"
  92          access="public"
  93          >
  94     The number of frames in the data.
  95   </Field>
  96   <Field
  97          name="frameDelay"
  98          type="Time"
  99          cardinality="single"
 100          visibility="external"
 101          defaultValue="0"
 102          access="public"
 103          >
 104     Time between frames.  Determines the frame rate.
 105   </Field>
 106   <Field
 107          name="pixelFormat"
 108          type="UInt32"
 109          cardinality="single"
 110          visibility="external"
 111          defaultValue="Image::OSG_INVALID_PF"
 112          access="public"
 113          >
 114   </Field>
 115   <Field
 116          name="pixel"
 117          type="UInt8"
 118          cardinality="multi"
 119          visibility="external"
 120          access="public"
 121          >
 122     The pixel data buffer. This is where the data for the image is stored.
 123   </Field>
 124   <Field
 125          name="frameSize"
 126          type="Int32"
 127          cardinality="single"
 128          visibility="internal"
 129          defaultValue="0"
 130          access="public"
 131          >
 132   </Field>
 133   <Field
 134          name="name"
 135          type="std::string"
 136          cardinality="single"
 137          visibility="external"
 138          access="public"
 139          >
 140         Texture file path.
 141   </Field>
 142   <Field
 143          name="dataType"
 144          type="Int32"
 145          cardinality="single"
 146          visibility="external"
 147          defaultValue="GL_UNSIGNED_BYTE"
 148          defaultHeader="&quot;OSGGL.h&quot;"
 149          access="public"
 150          >
 151         Type of image data.
 152   </Field>
 153   <Field
 154          name="componentSize"
 155          type="Int32"
 156          cardinality="single"
 157          visibility="internal"
 158          defaultValue="1"
 159          access="protected"
 160          >
 161         Size (in byte) of a single component of the image. Necessary
 162     for High Dynamic Range and other higher-level image types.
 163   </Field>
 164   <Field
 165          name="sideCount"
 166          type="Int32"
 167          cardinality="single"
 168          visibility="external"
 169          defaultValue="1"
 170          access="public"
 171          >
 172   </Field>
 173   <Field
 174          name="sideSize"
 175          type="Int32"
 176          cardinality="single"
 177          visibility="internal"
 178          defaultValue="0"
 179          access="public"
 180          >
 181   </Field>
 182   <Field
 183          name="forceCompressedData"
 184          type="bool"
 185          cardinality="single"
 186          visibility="external"
 187          defaultValue="false"
 188          access="public"
 189          >
 190     Set to true if using the image to keep unknown data for textures.
 191     Generally used in conjunction with TextureChunk::externalFormat.
 192   </Field>
 193   <Field
 194          name="forceAlphaChannel"
 195          type="bool"
 196          cardinality="single"
 197          visibility="external"
 198          defaultValue="false"
 199          access="public"
 200          >
 201     Set to true if using the image to keep unknown data for textures.
 202     Generally used in conjunction with TextureChunk::externalFormat.
 203   </Field>
 204   <Field
 205          name="forceColorChannel"
 206          type="bool"
 207          cardinality="single"
 208          visibility="external"
 209          defaultValue="false"
 210          access="public"
 211          >
 212     Set to true if using the image to keep unknown data for textures.
 213     Generally used in conjunction with TextureChunk::externalFormat.
 214   </Field>
 215   <Field
 216          name="forceAlphaBinary"
 217          type="bool"
 218          cardinality="single"
 219          visibility="external"
 220          defaultValue="false"
 221          access="public"
 222          >
 223     Set to true if using the image to prevent depth sorting for
 224     SimpleTexturedMaterials using this Image.
 225   </Field>
 226   <Field
 227          name="resX"
 228          type="Real32"
 229          cardinality="single"
 230          visibility="external"
 231          defaultValue="72.0f"
 232          access="public"
 233          >
 234   </Field>
 235   <Field
 236          name="resY"
 237          type="Real32"
 238          cardinality="single"
 239          visibility="external"
 240          defaultValue="72.0f"
 241          access="public"
 242          >
 243   </Field>
 244   <Field
 245          name="resUnit"
 246          type="UInt16"
 247          cardinality="single"
 248          visibility="external"
 249          defaultValue="2"
 250          access="public"
 251          >
 252         resolution unit (invalid=0, none=1, inch=2)
 253   </Field>
 254   <Field
 255          name="clearOnLoad"
 256          type="bool"
 257          cardinality="single"
 258          visibility="external"
 259          defaultValue="false"
 260          access="public"
 261          >
 262     Set to true if the image data should be cleared after it has been uploaded to the graphics
 263     card and is no longer needed in main memory.
 264   </Field>
 265 </FieldContainer>