src/mesa/main/formats.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  * Copyright (c) 2008-2009  VMware, Inc.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  23  * OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /*
  27  * Authors:
  28  *   Brian Paul
  29  */
  30
  31
  32 #ifndef FORMATS_H
  33 #define FORMATS_H
  34
  35
  36 #include <GL/gl.h>
  37
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43
  44 /**
  45  * OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
  46  * for GL_LUMINANCE4_ALPHA4.
  47  */
  48 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
  49
  50
  51 /**
  52  * Max number of bytes for any non-compressed pixel format below, or for
  53  * intermediate pixel storage in Mesa.  This should never be less than
  54  * 16.  Maybe 32 someday?
  55  */
  56 #define MAX_PIXEL_BYTES 16
  57
  58
  59 /**
  60  * Mesa texture/renderbuffer image formats.
  61  */
  62 typedef enum
  63 {
  64    MESA_FORMAT_NONE = 0,
  65
  66    /**
  67     * \name Basic hardware formats
  68     *
  69     * The mesa format name specification is as follows:
  70     *
  71     *  There shall be 3 naming format base types: those for component array
  72     *  formats (type A); those for compressed formats (type C); and those for
  73     *  packed component formats (type P). With type A formats, color component
  74     *  order does not change with endianess. Each format name shall begin with
  75     *  MESA_FORMAT_, followed by a component label (from the Component Label
  76     *  list below) for each component in the order that the component(s) occur
  77     *  in the format, except for non-linear color formats where the first
  78     *  letter shall be 'S'. For type P formats, each component label is
  79     *  followed by the number of bits that represent it in the fundamental
  80     *  data type used by the format.
  81     *
  82     *  Following the listing of the component labels shall be an underscore; a
  83     *  compression type followed by an underscore for Type C formats only; a
  84     *  storage type from the list below; and a bit with for type A formats,
  85     *  which is the bit width for each array element.
  86     *
  87     *
  88     *  ----------    Format Base Type A: Array ----------
  89     *  MESA_FORMAT_[component list]_[storage type][array element bit width]
  90     *
  91     *  examples:
  92     *  MESA_FORMAT_A_SNORM8     - uchar[i] = A
  93     *  MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
  94     *                             ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
  95     *  MESA_FORMAT_Z_UNORM32    - float[i] = Z
  96     *
  97     *
  98     *
  99     *  ----------    Format Base Type C: Compressed ----------
 100     *  MESA_FORMAT_[component list*][_*][compression type][storage type*]
 101     *  * where required
 102     *
 103     *  examples:
 104     *  MESA_FORMAT_RGB_ETC1
 105     *  MESA_FORMAT_RGBA_ETC2
 106     *  MESA_FORMAT_LATC1_UNORM
 107     *  MESA_FORMAT_RGBA_FXT1
 108     *
 109     *
 110     *
 111     *  ----------    Format Base Type P: Packed  ----------
 112     *  MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
 113     *   * when type differs between component
 114     *   ** when type applies to all components
 115     *
 116     *  examples:                   msb <------ TEXEL BITS -----------> lsb
 117     *  MESA_FORMAT_A8B8G8R8_UNORM, AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR
 118     *  MESA_FORMAT_R5G6B5_UNORM                        RRRR RGGG GGGB BBBB
 119     *  MESA_FORMAT_B4G4R4X4_UNORM                      BBBB GGGG RRRR XXXX
 120     *  MESA_FORMAT_Z32_FLOAT_S8X24_UINT
 121     *  MESA_FORMAT_R10G10B10A2_UINT
 122     *  MESA_FORMAT_R9G9B9E5_FLOAT
 123     *
 124     *
 125     *
 126     *  ----------    Component Labels: ----------
 127     *  A - Alpha
 128     *  B - Blue
 129     *  DU - Delta U
 130     *  DV - Delta V
 131     *  E - Shared Exponent
 132     *  G - Green
 133     *  I - Intensity
 134     *  L - Luminance
 135     *  R - Red
 136     *  S - Stencil (when not followed by RGB or RGBA)
 137     *  U - Chrominance
 138     *  V - Chrominance
 139     *  Y - Luma
 140     *  X - Packing bits
 141     *  Z - Depth
 142     *
 143     *
 144     *
 145     *  ----------    Type C Compression Types: ----------
 146     *  DXT1 - Color component labels shall be given
 147     *  DXT3 - Color component labels shall be given
 148     *  DXT5 - Color component labels shall be given
 149     *  ETC1 - No other information required
 150     *  ETC2 - No other information required
 151     *  FXT1 - Color component labels shall be given
 152     *  FXT3 - Color component labels shall be given
 153     *  LATC1 - Fundamental data type shall be given
 154     *  LATC2 - Fundamental data type shall be given
 155     *  RGTC1 - Color component labels and data type shall be given
 156     *  RGTC2 - Color component labels and data type shall be given
 157     *
 158     *
 159     *
 160     *  ----------    Storage Types: ----------
 161     *  FLOAT
 162     *  SINT
 163     *  UINT
 164     *  SNORM
 165     *  UNORM
 166     *  SRGB - RGB components, or L are UNORMs in sRGB color space.
 167     *         Alpha, if present is linear.
 168     *
 169     */
 170    /*@{*/
 171
 172    /* Type P formats */          /* msb <------ TEXEL BITS -----------> lsb */
 173                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 174    MESA_FORMAT_A8B8G8R8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 175    MESA_FORMAT_R8G8B8A8_UNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 176    MESA_FORMAT_B8G8R8A8_UNORM,   /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 177    MESA_FORMAT_A8R8G8B8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 178    MESA_FORMAT_X8B8G8R8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 179    MESA_FORMAT_R8G8B8X8_UNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 180    MESA_FORMAT_B8G8R8X8_UNORM,   /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
 181    MESA_FORMAT_X8R8G8B8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
 182
 183    /* Type A formats */
 184    MESA_FORMAT_BGR_UNORM8,    /* uchar[i * 3] = B, [i * 3 + 1] = G, [i *3 + 2] = R */
 185    MESA_FORMAT_RGB_UNORM8,    /* uchar[i * 3] = R, [i * 3 + 1] = G, [i *3 + 2] = B */
 186
 187    /* Type P formats */
 188    MESA_FORMAT_B5G6R5_UNORM,                         /* RRRR RGGG GGGB BBBB */
 189    MESA_FORMAT_R5G6B5_UNORM,                         /* BBBB BGGG GGGR RRRR */
 190    MESA_FORMAT_B4G4R4A4_UNORM,                       /* AAAA RRRR GGGG BBBB */
 191    MESA_FORMAT_A4R4G4B4_UNORM,                       /* BBBB GGGG RRRR AAAA */
 192    MESA_FORMAT_A1B5G5R5_UNORM,                       /* RRRR RGGG GGBB BBBA */
 193    MESA_FORMAT_B5G5R5A1_UNORM,                       /* ARRR RRGG GGGB BBBB */
 194    MESA_FORMAT_A1R5G5B5_UNORM,                       /* BBBB BGGG GGRR RRRA */
 195    MESA_FORMAT_L4A4_UNORM,                                     /* AAAA LLLL */
 196    MESA_FORMAT_L8A8_UNORM,                           /* AAAA AAAA LLLL LLLL */
 197    MESA_FORMAT_A8L8_UNORM,                           /* LLLL LLLL AAAA AAAA */
 198    MESA_FORMAT_L16A16_UNORM,     /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 199    MESA_FORMAT_A16L16_UNORM,     /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
 200    MESA_FORMAT_B2G3R3_UNORM,                                   /* RRRG GGBB */
 201
 202    /* Type A formats */
 203    MESA_FORMAT_A_UNORM8,     /* uchar[i] = A */
 204    MESA_FORMAT_A_UNORM16,    /* ushort[i] = A */
 205    MESA_FORMAT_L_UNORM8,     /* uchar[i] = L */
 206    MESA_FORMAT_L_UNORM16,    /* ushort[i] = L */
 207    MESA_FORMAT_I_UNORM8,     /* uchar[i] = I */
 208    MESA_FORMAT_I_UNORM16,    /* ushort[i] = I */
 209
 210    /* Type P formats */
 211    MESA_FORMAT_YCBCR,         /*                     YYYY YYYY UorV UorV */
 212    MESA_FORMAT_YCBCR_REV,     /*                     UorV UorV YYYY YYYY */
 213
 214    /* Type A format(s) */
 215    MESA_FORMAT_R_UNORM8,      /* uchar[i] = R */
 216
 217    /* Type P formats */
 218    MESA_FORMAT_R8G8_UNORM,                           /* GGGG GGGG RRRR RRRR */
 219    MESA_FORMAT_G8R8_UNORM,                           /* RRRR RRRR GGGG GGGG */
 220
 221    /* Type A format(s) */
 222    MESA_FORMAT_R_UNORM16,     /* ushort[i] = R */
 223
 224    /* Type P formats */
 225    MESA_FORMAT_R16G16_UNORM,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 226    MESA_FORMAT_G16R16_UNORM,     /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 227    MESA_FORMAT_B10G10R10A2_UNORM,/* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 228    MESA_FORMAT_S8_UINT_Z24_UNORM,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
 229    MESA_FORMAT_Z24_UNORM_S8_UINT,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 230
 231    /* Type A format(s) */
 232    MESA_FORMAT_Z_UNORM16,     /* ushort[i] = Z */
 233
 234    /* Type P formats */
 235    MESA_FORMAT_Z24_UNORM_X8_UINT,/* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 236    MESA_FORMAT_X8Z24_UNORM,      /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 237
 238    /* Type A formats */
 239    MESA_FORMAT_Z_UNORM32,     /* uint[i] = Z */
 240    MESA_FORMAT_S_UINT8,       /* uchar[i] = S */
 241    /*@}*/
 242
 243    /**
 244     * \name 8-bit/channel sRGB formats
 245     */
 246    /*@{*/
 247    /* Type A format(s) */
 248    MESA_FORMAT_BGR_SRGB8,     /* uchar[i * 3] = B, [i * 3 + 1] = G, [i *3 + 2] = R */
 249
 250    /* Type P formats */
 251    MESA_FORMAT_A8B8G8R8_SRGB,    /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 252    MESA_FORMAT_B8G8R8A8_SRGB,    /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 253    MESA_FORMAT_R8G8B8A8_SRGB,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 254
 255    /* Type A format(s) */
 256    MESA_FORMAT_L_SRGB8,       /* uchar[i] = L */
 257
 258    /* Type P formats */
 259    MESA_FORMAT_L8A8_SRGB,                            /* AAAA AAAA LLLL LLLL */
 260
 261    /* Type C formats */
 262    MESA_FORMAT_SRGB_DXT1,
 263    MESA_FORMAT_SRGBA_DXT1,
 264    MESA_FORMAT_SRGBA_DXT3,
 265    MESA_FORMAT_SRGBA_DXT5,
 266    /*@}*/
 267
 268    /**
 269     * \name Compressed texture formats.
 270     */
 271    /*@{*/
 272    /* Type C formats */
 273    MESA_FORMAT_RGB_FXT1,
 274    MESA_FORMAT_RGBA_FXT1,
 275    MESA_FORMAT_RGB_DXT1,
 276    MESA_FORMAT_RGBA_DXT1,
 277    MESA_FORMAT_RGBA_DXT3,
 278    MESA_FORMAT_RGBA_DXT5,
 279    /*@}*/
 280
 281    /**
 282     * \name Floating point texture formats.
 283     */
 284    /*@{*/
 285
 286    /* Type A formats */
 287    MESA_FORMAT_RGBA_FLOAT32,  /* float[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = A */
 288    MESA_FORMAT_RGBA_FLOAT16,
 289    MESA_FORMAT_RGB_FLOAT32,
 290    MESA_FORMAT_RGB_FLOAT16,
 291    MESA_FORMAT_A_FLOAT32,
 292    MESA_FORMAT_A_FLOAT16,
 293    MESA_FORMAT_L_FLOAT32,
 294    MESA_FORMAT_L_FLOAT16,
 295    MESA_FORMAT_LA_FLOAT32,
 296    MESA_FORMAT_LA_FLOAT16,
 297    MESA_FORMAT_I_FLOAT32,
 298    MESA_FORMAT_I_FLOAT16,
 299    MESA_FORMAT_R_FLOAT32,
 300    MESA_FORMAT_R_FLOAT16,
 301    MESA_FORMAT_RG_FLOAT32,
 302    MESA_FORMAT_RG_FLOAT16,
 303    /*@}*/
 304
 305    /**
 306     * \name Non-normalized signed integer formats.
 307     * XXX Note: these are just stand-ins for some better hardware
 308     * formats TBD such as BGRA or ARGB.
 309     */
 310
 311    /* Type A formats */
 312    MESA_FORMAT_A_UINT8,
 313    MESA_FORMAT_A_UINT16,
 314    MESA_FORMAT_A_UINT32,
 315    MESA_FORMAT_A_SINT8,
 316    MESA_FORMAT_A_SINT16,
 317    MESA_FORMAT_A_SINT32,
 318
 319    MESA_FORMAT_I_UINT8,
 320    MESA_FORMAT_I_UINT16,
 321    MESA_FORMAT_I_UINT32,
 322    MESA_FORMAT_I_SINT8,
 323    MESA_FORMAT_I_SINT16,
 324    MESA_FORMAT_I_SINT32,
 325
 326    MESA_FORMAT_L_UINT8,
 327    MESA_FORMAT_L_UINT16,
 328    MESA_FORMAT_L_UINT32,
 329    MESA_FORMAT_L_SINT8,
 330    MESA_FORMAT_L_SINT16,
 331    MESA_FORMAT_L_SINT32,
 332    MESA_FORMAT_LA_UINT8,
 333    MESA_FORMAT_LA_UINT16,
 334    MESA_FORMAT_LA_UINT32,
 335    MESA_FORMAT_LA_SINT8,
 336    MESA_FORMAT_LA_SINT16,
 337    MESA_FORMAT_LA_SINT32,
 338
 339    MESA_FORMAT_R_SINT8,
 340    MESA_FORMAT_RG_SINT8,
 341    MESA_FORMAT_RGB_SINT8,
 342    MESA_FORMAT_RGBA_SINT8,
 343    MESA_FORMAT_R_SINT16,
 344    MESA_FORMAT_RG_SINT16,
 345    MESA_FORMAT_RGB_SINT16,
 346    MESA_FORMAT_RGBA_SINT16,
 347
 348    MESA_FORMAT_R_SINT32,
 349    MESA_FORMAT_RG_SINT32,
 350    MESA_FORMAT_RGB_SINT32,
 351    MESA_FORMAT_RGBA_SINT32,
 352
 353    /**
 354     * \name Non-normalized unsigned integer formats.
 355     */
 356    /* Type A format(s) */
 357    MESA_FORMAT_R_UINT8,
 358    MESA_FORMAT_RG_UINT8,
 359    MESA_FORMAT_RGB_UINT8,
 360    MESA_FORMAT_RGBA_UINT8,
 361
 362    MESA_FORMAT_R_UINT16,
 363    MESA_FORMAT_RG_UINT16,
 364    MESA_FORMAT_RGB_UINT16,
 365    MESA_FORMAT_RGBA_UINT16,
 366
 367    MESA_FORMAT_R_UINT32,
 368    MESA_FORMAT_RG_UINT32,
 369    MESA_FORMAT_RGB_UINT32,
 370    MESA_FORMAT_RGBA_UINT32,
 371
 372                                  /* msb <------ TEXEL BITS -----------> lsb */
 373                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 374    /**
 375     * \name Signed fixed point texture formats.
 376     */
 377    /*@{*/
 378    MESA_FORMAT_DUDV8,             /*                     DUDU DUDU DVDV DVDV */
 379
 380    /* Type A format(s) */
 381    MESA_FORMAT_R_SNORM8,      /* char[i] = R */
 382
 383    /* Type P formats */
 384    MESA_FORMAT_R8G8_SNORM,                           /* GGGG GGGG RRRR RRRR */
 385    MESA_FORMAT_X8B8G8R8_SNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 386    MESA_FORMAT_A8B8G8R8_SNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 387    MESA_FORMAT_R8G8B8A8_SNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 388
 389    /* Type A format(s) */
 390    MESA_FORMAT_R_SNORM16,     /* short[i] = R */
 391
 392    /* Type P format(s) */
 393    MESA_FORMAT_R16G16_SNORM,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 394
 395    /* Type A format(s) */
 396    MESA_FORMAT_RGB_SNORM16,   /* short[i * 3] = R, [i * 3 + 1] = G, [i *3 + 2] = B */
 397    MESA_FORMAT_RGBA_SNORM16,  /* ... */
 398    MESA_FORMAT_RGBA_UNORM16,  /* ... */
 399    /*@}*/
 400
 401    /*@{*/
 402    /* Type C formats */
 403    MESA_FORMAT_R_RGTC1_UNORM,
 404    MESA_FORMAT_R_RGTC1_SNORM,
 405    MESA_FORMAT_RG_RGTC2_UNORM,
 406    MESA_FORMAT_RG_RGTC2_SNORM,
 407    /*@}*/
 408
 409    /*@{*/
 410    MESA_FORMAT_L_LATC1_UNORM,
 411    MESA_FORMAT_L_LATC1_SNORM,
 412    MESA_FORMAT_LA_LATC2_UNORM,
 413    MESA_FORMAT_LA_LATC2_SNORM,
 414    /*@}*/
 415
 416    MESA_FORMAT_ETC1_RGB8,
 417    MESA_FORMAT_ETC2_RGB8,
 418    MESA_FORMAT_ETC2_SRGB8,
 419    MESA_FORMAT_ETC2_RGBA8_EAC,
 420    MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
 421    MESA_FORMAT_ETC2_R11_EAC,
 422    MESA_FORMAT_ETC2_RG11_EAC,
 423    MESA_FORMAT_ETC2_SIGNED_R11_EAC,
 424    MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
 425    MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
 426    MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
 427
 428    /* Type A format(s) */
 429    MESA_FORMAT_A_SNORM8,      /* char[i] = A */
 430    MESA_FORMAT_L_SNORM8,      /* char[i] = L */
 431
 432    /* Type P format(s) */
 433    MESA_FORMAT_L8A8_SNORM,                           /* AAAA AAAA LLLL LLLL */
 434
 435    /* Type A format(s) */
 436    MESA_FORMAT_I_SNORM8,      /* char[i] = I */
 437    MESA_FORMAT_A_SNORM16,     /* short[i] = A */
 438    MESA_FORMAT_L_SNORM16,     /* short[i] = L */
 439    MESA_FORMAT_LA_SNORM16,    /* short[i * 2] = L, [i * 2 + 1] = A */
 440    MESA_FORMAT_I_SNORM16,     /* short[i] = I */
 441
 442    /* Type P format(s) */
 443    MESA_FORMAT_R9G9B9E5_FLOAT,
 444    MESA_FORMAT_R11G11B10_FLOAT,   /* BBBB BBBB BBGG GGGG GGGG GRRR RRRR RRRR */
 445
 446    /* Type A format(s) */
 447    MESA_FORMAT_Z_FLOAT32,
 448
 449    /* Type P formats */
 450    MESA_FORMAT_Z32_FLOAT_S8X24_UINT, /* (float, x24s8) */
 451
 452    MESA_FORMAT_B10G10R10A2_UINT, /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 453    MESA_FORMAT_R10G10B10A2_UINT, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
 454
 455    MESA_FORMAT_B4G4R4X4_UNORM,                       /* xxxx RRRR GGGG BBBB */
 456    MESA_FORMAT_B5G5R5X1_UNORM,                       /* xRRR RRGG GGGB BBBB */
 457    MESA_FORMAT_R8G8B8X8_SNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 458    MESA_FORMAT_R8G8B8X8_SRGB,    /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 459
 460    /* Type A formats */
 461    MESA_FORMAT_RGBX_UINT8,    /* uchar[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 462    MESA_FORMAT_RGBX_SINT8,    /* char[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x  */
 463
 464    /* Type P format(s) */
 465    MESA_FORMAT_B10G10R10X2_UNORM,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 466
 467    /* Type A formats */
 468    MESA_FORMAT_RGBX_UNORM16,  /* ushort[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 469    MESA_FORMAT_RGBX_SNORM16,  /* ... */
 470    MESA_FORMAT_RGBX_FLOAT16,  /* ... */
 471    MESA_FORMAT_RGBX_UINT16,   /* ... */
 472    MESA_FORMAT_RGBX_SINT16,   /* ... */
 473
 474    MESA_FORMAT_RGBX_FLOAT32,  /* float[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 475    MESA_FORMAT_RGBX_UINT32,   /* ... */
 476    MESA_FORMAT_RGBX_SINT32,   /* ... */
 477
 478    /* Type P formats */
 479    MESA_FORMAT_R10G10B10A2_UNORM, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
 480    MESA_FORMAT_G8R8_SNORM,        /*                     RRRR RRRR GGGG GGGG */
 481    MESA_FORMAT_G16R16_SNORM,      /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 482
 483    MESA_FORMAT_B8G8R8X8_SRGB,     /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
 484
 485    MESA_FORMAT_COUNT
 486 } mesa_format;
 487
 488
 489 extern const char *
 490 _mesa_get_format_name(mesa_format format);
 491
 492 extern GLint
 493 _mesa_get_format_bytes(mesa_format format);
 494
 495 extern GLint
 496 _mesa_get_format_bits(mesa_format format, GLenum pname);
 497
 498 extern GLuint
 499 _mesa_get_format_max_bits(mesa_format format);
 500
 501 extern GLenum
 502 _mesa_get_format_datatype(mesa_format format);
 503
 504 extern GLenum
 505 _mesa_get_format_base_format(mesa_format format);
 506
 507 extern void
 508 _mesa_get_format_block_size(mesa_format format, GLuint *bw, GLuint *bh);
 509
 510 extern GLboolean
 511 _mesa_is_format_compressed(mesa_format format);
 512
 513 extern GLboolean
 514 _mesa_is_format_packed_depth_stencil(mesa_format format);
 515
 516 extern GLboolean
 517 _mesa_is_format_integer_color(mesa_format format);
 518
 519 extern GLboolean
 520 _mesa_is_format_unsigned(mesa_format format);
 521
 522 extern GLboolean
 523 _mesa_is_format_signed(mesa_format format);
 524
 525 extern GLenum
 526 _mesa_get_format_color_encoding(mesa_format format);
 527
 528 extern GLuint
 529 _mesa_format_image_size(mesa_format format, GLsizei width,
 530                         GLsizei height, GLsizei depth);
 531
 532 extern uint64_t
 533 _mesa_format_image_size64(mesa_format format, GLsizei width,
 534                           GLsizei height, GLsizei depth);
 535
 536 extern GLint
 537 _mesa_format_row_stride(mesa_format format, GLsizei width);
 538
 539 extern void
 540 _mesa_format_to_type_and_comps(mesa_format format,
 541                                GLenum *datatype, GLuint *comps);
 542
 543 extern void
 544 _mesa_test_formats(void);
 545
 546 extern mesa_format
 547 _mesa_get_srgb_format_linear(mesa_format format);
 548
 549 extern mesa_format
 550 _mesa_get_uncompressed_format(mesa_format format);
 551
 552 extern GLuint
 553 _mesa_format_num_components(mesa_format format);
 554
 555 GLboolean
 556 _mesa_format_matches_format_and_type(mesa_format mesa_format,
 557                                      GLenum format, GLenum type,
 558                                      GLboolean swapBytes);
 559
 560 #ifdef __cplusplus
 561 }
 562 #endif
 563
 564 #endif /* FORMATS_H */