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 /* OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
  45  * for GL_LUMINANCE4_ALPHA4. */
  46 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
  47
  48
  49 /**
  50  * Max number of bytes for any non-compressed pixel format below, or for
  51  * intermediate pixel storage in Mesa.  This should never be less than
  52  * 16.  Maybe 32 someday?
  53  */
  54 #define MAX_PIXEL_BYTES 16
  55
  56
  57 /**
  58  * Mesa texture/renderbuffer image formats.
  59  */
  60 typedef enum
  61 {
  62    MESA_FORMAT_NONE = 0,
  63
  64    /**
  65     * \name Basic hardware formats
  66     *
  67     * The mesa format name specification is as follows:
  68     *
  69     *  There shall be 3 naming format base types: those for component array
  70     *  formats (type A); those for compressed formats (type C); and those for packed
  71     *  component formats (type P). With type A formats, color component order does not
  72     *  change with endianess. Each format name shall begin with MESA_FORMAT_,
  73     *  followed by a component label (from the Component Label list below) for each
  74     *  component in the order that the component(s) occur in the format, except for
  75     *  non-linear color formats where the first letter shall be 'S'. For type P formats,
  76     *  each component label is followed by the number of bits that represent it in the
  77     *  fundamental data type used by the format.
  78     *
  79     *  Following the listing of the component labels shall be an underscore; a compression
  80     *  type followed by an underscore for Type C formats only; a storage type from the list
  81     *  below; and a bit with for type A formats, which is the bit width for each array element.
  82     *
  83     *
  84     *  ----------    Format Base Type A: Array ----------
  85     *  MESA_FORMAT_[component list]_[storage type][array element bit width]
  86     *
  87     *  examples:
  88     *  MESA_FORMAT_A_SNORM8     - uchar[i] = A
  89     *  MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
  90     *                             ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
  91     *  MESA_FORMAT_Z_UNORM32    - float[i] = Z
  92     *
  93     *
  94     *
  95     *  ----------    Format Base Type C: Compressed ----------
  96     *  MESA_FORMAT_[component list*][_*][compression type][storage type*]
  97     *  * where required
  98     *
  99     *  examples:
 100     *  MESA_FORMAT_RGB_ETC1
 101     *  MESA_FORMAT_RGBA_ETC2
 102     *  MESA_FORMAT_LATC1_UNORM
 103     *  MESA_FORMAT_RGBA_FXT1
 104     *
 105     *
 106     *
 107     *  ----------    Format Base Type P: Packed  ----------
 108     *  MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
 109     *   * when type differs between component
 110     *   ** when type applies to all components
 111     *
 112     *  examples:                   msb <------ TEXEL BITS -----------> lsb
 113     *  MESA_FORMAT_A8B8G8R8_UNORM, AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR
 114     *  MESA_FORMAT_R5G6B5_UNORM                        RRRR RGGG GGGB BBBB
 115     *  MESA_FORMAT_B4G4R4X4_UNORM                      BBBB GGGG RRRR XXXX
 116     *  MESA_FORMAT_Z32_FLOAT_S8X24_UINT
 117     *  MESA_FORMAT_R10G10B10A2_UINT
 118     *  MESA_FORMAT_R9G9B9E5_FLOAT
 119     *
 120     *
 121     *
 122     *  ----------    Component Labels: ----------
 123     *  A - Alpha
 124     *  B - Blue
 125     *  DU - Delta U
 126     *  DV - Delta V
 127     *  E - Shared Exponent
 128     *  G - Green
 129     *  I - Intensity
 130     *  L - Luminance
 131     *  R - Red
 132     *  S - Stencil (when not followed by RGB or RGBA)
 133     *  U - Chrominance
 134     *  V - Chrominance
 135     *  Y - Luma
 136     *  X - Packing bits
 137     *  Z - Depth
 138     *
 139     *
 140     *
 141     *  ----------    Type C Compression Types: ----------
 142     *  DXT1 - Color component labels shall be given
 143     *  DXT3 - Color component labels shall be given
 144     *  DXT5 - Color component labels shall be given
 145     *  ETC1 - No other information required
 146     *  ETC2 - No other information required
 147     *  FXT1 - Color component labels shall be given
 148     *  FXT3 - Color component labels shall be given
 149     *  LATC1 - Fundamental data type shall be given
 150     *  LATC2 - Fundamental data type shall be given
 151     *  RGTC1 - Color component labels and data type shall be given
 152     *  RGTC2 - Color component labels and data type shall be given
 153     *
 154     *
 155     *
 156     *  ----------    Storage Types: ----------
 157     *  FLOAT
 158     *  SINT
 159     *  UINT
 160     *  SNORM
 161     *  UNORM
 162     *  SRGB - RGB components, or L are UNORMs in sRGB color space. Alpha, if present is linear.
 163     *
 164     *
 165     *   ----------   Type A Format List (based on format_unpack.c):
 166     *  BGR_UNORM8
 167     *  RGB_UNORM8
 168     *  A_UNORM8
 169     *  A_UNORM16
 170     *  L_UNORM8
 171     *  L_UNORM16
 172     *  I_UNORM8
 173     *  I_UNOMR16
 174     *  R_UNORM8
 175     *  R_UNORM16
 176     *  Z_UNORM16
 177     *  Z_UNORM32
 178     *  Z_FLOAT32
 179     *  S_UINT8
 180     *  BGR_SRGB8
 181     *  L_SRGB8
 182     *  RGBA_FLOAT32
 183     *  RGBA_FLOAT16
 184     *  RGB_FLOAT32
 185     *  RGB_FLOAT16
 186     *  A_FLOAT32
 187     *  A_FLOAT16
 188     *  L_FLOAT32
 189     *  L_FLOAT16
 190     *  LA_FLOAT32
 191     *  LA_FLOAT16
 192     *  I_FLOAT32
 193     *  I_FLOAT16
 194     *  R_FLOAT32
 195     *  R_FLOAT16
 196     *  RG_FLOAT32
 197     *  RG_FLOAT16
 198     *  A_UINT8
 199     *  A_UINT16
 200     *  A_UINT32
 201     *  A_SINT8
 202     *  A_SINT16
 203     *  A_SINT32
 204     *  I_UINT8
 205     *  I_UINT16
 206     *  I_UINT32
 207     *  I_SINT8
 208     *  I_SINT16
 209     *  I_SINT32
 210     *  L_UINT8
 211     *  L_UINT16
 212     *  L_UINT32
 213     *  L_SINT8
 214     *  L_SINT16
 215     *  L_SINT32
 216     *  LA_UINT8
 217     *  LA_UINT16
 218     *  LA_UINT32
 219     *  LA_SINT8
 220     *  LA_SINT16
 221     *  LA_SINT32
 222     *  R_SINT8
 223     *  RG_SINT8
 224     *  RGB_SINT8
 225     *  RGBA_SINT8
 226     *  R_SINT16
 227     *  RG_SINT16
 228     *  RGB_SINT16
 229     *  RGBA_SINT16
 230     *  R_SINT32
 231     *  RG_SINT32
 232     *  RGB_SINT32
 233     *  RGBA_SINT32
 234     *  R_SINT16
 235     *  R_SINT32
 236     *  R_UINT8
 237     *  RG_UINT8
 238     *  RGB_UINT8
 239     *  RGBA_UINT8
 240     *  R_UINT16
 241     *  RG_UINT16
 242     *  RGB_UINT16
 243     *  RGBA_UINT16
 244     *  R_UINT32
 245     *  RG_UINT32
 246     *  RGB_UINT32
 247     *  RGBA_UINT32
 248     *  R_UINT16
 249     *  R_UINT32
 250     *  R_SNORM8
 251     *  R_SNORM16
 252     *  RGB_SNORM16
 253     *  RGBA_SNORM16
 254     *  RGBA_UNORM16
 255     *  A_SNORM8
 256     *  L_SNORM8
 257     *  I_SNORM8
 258     *  A_SNORM16
 259     *  L_SNORM16
 260     *  LA_SNORM16
 261     *  I_SNORM16
 262     *  RGBX_UINT8
 263     *  RGBX_SINT8
 264     *  RGBX_UNORM16
 265     *  RGBX_SNORM16
 266     *  RGBX_FLOAT16
 267     *  RGBX_UINT16
 268     *  RGBX_SINT16
 269     *  RGBX_FLOAT32
 270     *  RGBX_UINT32
 271     *  RGBX_SINT32
 272     *
 273     *
 274     *
 275     *   ----------   Type P Format List (based on format_unpack.c):
 276     *  A8B8G8R8_UNORM
 277     *  R8G8B8A8_UNORM
 278     *  B8G8R8A8_UNORM
 279     *  A8R8G8B8_UNORM
 280     *  X8B8G8R8_UNORM
 281     *  R8G8B8X8_UNORM
 282     *  B8G8R8X8_UNORM
 283     *  X8R8G8B8_UNORM
 284     *  B5G6R5_UNORM
 285     *  R5G6B5_UNORM
 286     *  B4G4R4A4_UNORM
 287     *  A4R4G4B4_UNORM
 288     *  A1B5G5R5_UNORM
 289     *  B5G5R5A1_UNORM
 290     *  A1R5G5B5_UNORM
 291     *  L4A4_UNORM
 292     *  L8A8_UNORM
 293     *  A8L8_UNORM
 294     *  L16A16_UNORM
 295     *  A16L16_UNORM
 296     *  B2G3R3_UNORM
 297     *  YCBCR
 298     *  YCBCR_REV
 299     *  R8G8_UNORM
 300     *  G8R8_UNORM
 301     *  R16G16_UNORM
 302     *  G16R16_UNORM
 303     *  B10G10R10A2_UNORM
 304     *  B10G10R10A2_UINT
 305     *  R10G10B10A2_UINT
 306     *  S8_UINT_Z24_UNORM
 307     *  Z24_UNORM_S8_UINT
 308     *  Z24_UNORM_X8_UINT
 309     *  X8_UINT_Z24_UNORM
 310     *  Z32_FLOAT_S8X24_UINT
 311     *  A8R8G8B8_SRGB
 312     *  B8G8R8A8_SRGB
 313     *  L8A8_SRGB
 314     *  R8G8_SNORM
 315     *  X8B8G8R8_SNORM
 316     *  A8B8G8R8_SNORM
 317     *  R8G8B8A8_SNORM
 318     *  R16G16_SNORM
 319     *  L8A8_SNORM
 320     *  R9G9B9E5_FLOAT
 321     *  R11G11B10_FLOAT
 322     *  B4G4R4X4_UNORM
 323     *  B5G5R5X1_UNORM
 324     *  R8G8_SNORM
 325     *  R8G8B8X8_SNORM
 326     *  R8G8B8X8_SRGB
 327     *  B10G10R10X2_UNORM
 328     *  R10G10B10A2_UNORM
 329     *  G8R8_SINT
 330     *  G16R16_SINT
 331     *
 332     */
 333    /*@{*/
 334
 335    /* Type P formats */          /* msb <------ TEXEL BITS -----------> lsb */
 336                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 337    MESA_FORMAT_A8B8G8R8_UNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 338    MESA_FORMAT_R8G8B8A8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 339    MESA_FORMAT_B8G8R8A8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 340    MESA_FORMAT_A8R8G8B8_UNORM,   /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 341    MESA_FORMAT_X8B8G8R8_UNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 342    MESA_FORMAT_R8G8B8X8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 343    MESA_FORMAT_B8G8R8X8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
 344    MESA_FORMAT_X8R8G8B8_UNORM,   /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
 345
 346    /* Type A formats */
 347    MESA_FORMAT_BGR_UNORM8,    /* uchar[i * 3] = B, [i * 3 + 1] = G, [i *3 + 2] = R */
 348    MESA_FORMAT_RGB_UNORM8,    /* uchar[i * 3] = R, [i * 3 + 1] = G, [i *3 + 2] = B */
 349
 350    /* Type P formats */
 351    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
 352    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
 353    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
 354    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
 355    MESA_FORMAT_RGBA5551,        /*                     RRRR RGGG GGBB BBBA */
 356    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
 357    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
 358    MESA_FORMAT_AL44,            /*                               AAAA LLLL */
 359    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
 360    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
 361    MESA_FORMAT_AL1616,          /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 362    MESA_FORMAT_AL1616_REV,      /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
 363    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
 364
 365    /* Type A formats */
 366    MESA_FORMAT_A_UNORM8,     /* uchar[i] = A */
 367    MESA_FORMAT_A_UNORM16,    /* ushort[i] = A */
 368    MESA_FORMAT_L_UNORM8,     /* uchar[i] = L */
 369    MESA_FORMAT_L_UNORM16,    /* ushort[i] = L */
 370    MESA_FORMAT_I_UNORM8,     /* uchar[i] = I */
 371    MESA_FORMAT_I_UNORM16,    /* ushort[i] = I */
 372
 373    /* Type P formats */
 374    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
 375    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
 376
 377    /* Type A format(s) */
 378    MESA_FORMAT_R_UNORM8,      /* uchar[i] = R */
 379
 380    /* Type P formats */
 381    MESA_FORMAT_GR88,            /*                     GGGG GGGG RRRR RRRR */
 382    MESA_FORMAT_RG88,            /*                     RRRR RRRR GGGG GGGG */
 383
 384    /* Type A format(s) */
 385    MESA_FORMAT_R_UNORM16,     /* ushort[i] = R */
 386
 387    /* Type P formats */
 388    MESA_FORMAT_GR1616,          /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 389    MESA_FORMAT_RG1616,          /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 390    MESA_FORMAT_ARGB2101010,     /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 391    MESA_FORMAT_Z24_S8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
 392    MESA_FORMAT_S8_Z24,          /* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 393
 394    /* Type A format(s) */
 395    MESA_FORMAT_Z_UNORM16,     /* ushort[i] = Z */
 396
 397    /* Type P formats */
 398    MESA_FORMAT_X8_Z24,          /* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 399    MESA_FORMAT_Z24_X8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 400
 401    /* Type A formats */
 402    MESA_FORMAT_Z_UNORM32,     /* uint[i] = Z */
 403    MESA_FORMAT_S_UINT8,       /* uchar[i] = S */
 404    /*@}*/
 405
 406    /**
 407     * \name 8-bit/channel sRGB formats
 408     */
 409    /*@{*/
 410    /* Type A format(s) */
 411    MESA_FORMAT_BGR_SRGB8,     /* uchar[i * 3] = B, [i * 3 + 1] = G, [i *3 + 2] = R */
 412
 413    /* Type P formats */
 414    MESA_FORMAT_SRGBA8,          /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 415    MESA_FORMAT_SARGB8,          /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 416
 417    /* Type A format(s) */
 418    MESA_FORMAT_L_SRGB8,       /* uchar[i] = L */
 419
 420    /* Type P formats */
 421    MESA_FORMAT_SLA8,            /*                     AAAA AAAA LLLL LLLL */
 422
 423    /* Type C formats */
 424    MESA_FORMAT_SRGB_DXT1,
 425    MESA_FORMAT_SRGBA_DXT1,
 426    MESA_FORMAT_SRGBA_DXT3,
 427    MESA_FORMAT_SRGBA_DXT5,
 428    /*@}*/
 429
 430    /**
 431     * \name Compressed texture formats.
 432     */
 433    /*@{*/
 434    /* Type C formats */
 435    MESA_FORMAT_RGB_FXT1,
 436    MESA_FORMAT_RGBA_FXT1,
 437    MESA_FORMAT_RGB_DXT1,
 438    MESA_FORMAT_RGBA_DXT1,
 439    MESA_FORMAT_RGBA_DXT3,
 440    MESA_FORMAT_RGBA_DXT5,
 441    /*@}*/
 442
 443    /**
 444     * \name Floating point texture formats.
 445     */
 446    /*@{*/
 447
 448    /* Type A formats */
 449    MESA_FORMAT_RGBA_FLOAT32,  /* float[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = A */
 450    MESA_FORMAT_RGBA_FLOAT16,
 451    MESA_FORMAT_RGB_FLOAT32,
 452    MESA_FORMAT_RGB_FLOAT16,
 453    MESA_FORMAT_ALPHA_FLOAT32,
 454    MESA_FORMAT_ALPHA_FLOAT16,
 455    MESA_FORMAT_LUMINANCE_FLOAT32,
 456    MESA_FORMAT_LUMINANCE_FLOAT16,
 457    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT32,
 458    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT16,
 459    MESA_FORMAT_INTENSITY_FLOAT32,
 460    MESA_FORMAT_INTENSITY_FLOAT16,
 461    MESA_FORMAT_R_FLOAT32,
 462    MESA_FORMAT_R_FLOAT16,
 463    MESA_FORMAT_RG_FLOAT32,
 464    MESA_FORMAT_RG_FLOAT16,
 465    /*@}*/
 466
 467    /**
 468     * \name Non-normalized signed integer formats.
 469     * XXX Note: these are just stand-ins for some better hardware
 470     * formats TBD such as BGRA or ARGB.
 471     */
 472
 473    /* Type A formats */
 474    MESA_FORMAT_ALPHA_UINT8,
 475    MESA_FORMAT_ALPHA_UINT16,
 476    MESA_FORMAT_ALPHA_UINT32,
 477    MESA_FORMAT_ALPHA_INT8,
 478    MESA_FORMAT_ALPHA_INT16,
 479    MESA_FORMAT_ALPHA_INT32,
 480
 481    MESA_FORMAT_INTENSITY_UINT8,
 482    MESA_FORMAT_INTENSITY_UINT16,
 483    MESA_FORMAT_INTENSITY_UINT32,
 484    MESA_FORMAT_INTENSITY_INT8,
 485    MESA_FORMAT_INTENSITY_INT16,
 486    MESA_FORMAT_INTENSITY_INT32,
 487
 488    MESA_FORMAT_LUMINANCE_UINT8,
 489    MESA_FORMAT_LUMINANCE_UINT16,
 490    MESA_FORMAT_LUMINANCE_UINT32,
 491    MESA_FORMAT_LUMINANCE_INT8,
 492    MESA_FORMAT_LUMINANCE_INT16,
 493    MESA_FORMAT_LUMINANCE_INT32,
 494    MESA_FORMAT_LUMINANCE_ALPHA_UINT8,
 495    MESA_FORMAT_LUMINANCE_ALPHA_UINT16,
 496    MESA_FORMAT_LUMINANCE_ALPHA_UINT32,
 497    MESA_FORMAT_LUMINANCE_ALPHA_INT8,
 498    MESA_FORMAT_LUMINANCE_ALPHA_INT16,
 499    MESA_FORMAT_LUMINANCE_ALPHA_INT32,
 500
 501    MESA_FORMAT_R_INT8,
 502    MESA_FORMAT_RG_INT8,
 503    MESA_FORMAT_RGB_INT8,
 504    MESA_FORMAT_RGBA_INT8,
 505    MESA_FORMAT_R_INT16,
 506    MESA_FORMAT_RG_INT16,
 507    MESA_FORMAT_RGB_INT16,
 508    MESA_FORMAT_RGBA_INT16,
 509
 510    MESA_FORMAT_R_INT32,
 511    MESA_FORMAT_RG_INT32,
 512    MESA_FORMAT_RGB_INT32,
 513    MESA_FORMAT_RGBA_INT32,
 514
 515    /**
 516     * \name Non-normalized unsigned integer formats.
 517     */
 518    /* Type A format(s) */
 519    MESA_FORMAT_R_UINT8,
 520    MESA_FORMAT_RG_UINT8,
 521    MESA_FORMAT_RGB_UINT8,
 522    MESA_FORMAT_RGBA_UINT8,
 523
 524    MESA_FORMAT_R_UINT16,
 525    MESA_FORMAT_RG_UINT16,
 526    MESA_FORMAT_RGB_UINT16,
 527    MESA_FORMAT_RGBA_UINT16,
 528
 529    MESA_FORMAT_R_UINT32,
 530    MESA_FORMAT_RG_UINT32,
 531    MESA_FORMAT_RGB_UINT32,
 532    MESA_FORMAT_RGBA_UINT32,
 533
 534                                   /* msb <------ TEXEL BITS -----------> lsb */
 535                                   /* ---- ---- ---- ---- ---- ---- ---- ---- */
 536    /**
 537     * \name Signed fixed point texture formats.
 538     */
 539    /*@{*/
 540    MESA_FORMAT_DUDV8,             /*                     DUDU DUDU DVDV DVDV */
 541
 542    /* Type A format(s) */
 543    MESA_FORMAT_SIGNED_R8,         /*                               RRRR RRRR */
 544
 545    /* Type P formats */
 546    MESA_FORMAT_SIGNED_RG88_REV,   /*                     GGGG GGGG RRRR RRRR */
 547    MESA_FORMAT_SIGNED_RGBX8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 548    MESA_FORMAT_SIGNED_RGBA8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 549    MESA_FORMAT_SIGNED_RGBA8888_REV,/*AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 550
 551    /* Type A format(s) */
 552    MESA_FORMAT_SIGNED_R16,        /*                     RRRR RRRR RRRR RRRR */
 553
 554    /* Type P format(s) */
 555    MESA_FORMAT_SIGNED_GR1616,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 556
 557    /* Type A format(s) */
 558    MESA_FORMAT_SIGNED_RGB_16,     /* ushort[0]=R, ushort[1]=G, ushort[2]=B */
 559    MESA_FORMAT_SIGNED_RGBA_16,    /* ... */
 560    MESA_FORMAT_RGBA_UNORM16,      /* ... */
 561    /*@}*/
 562
 563    /*@{*/
 564    /* Type C formats */
 565    MESA_FORMAT_RED_RGTC1,
 566    MESA_FORMAT_SIGNED_RED_RGTC1,
 567    MESA_FORMAT_RG_RGTC2,
 568    MESA_FORMAT_SIGNED_RG_RGTC2,
 569    /*@}*/
 570
 571    /*@{*/
 572    MESA_FORMAT_L_LATC1,
 573    MESA_FORMAT_SIGNED_L_LATC1,
 574    MESA_FORMAT_LA_LATC2,
 575    MESA_FORMAT_SIGNED_LA_LATC2,
 576    /*@}*/
 577
 578    MESA_FORMAT_ETC1_RGB8,
 579    MESA_FORMAT_ETC2_RGB8,
 580    MESA_FORMAT_ETC2_SRGB8,
 581    MESA_FORMAT_ETC2_RGBA8_EAC,
 582    MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
 583    MESA_FORMAT_ETC2_R11_EAC,
 584    MESA_FORMAT_ETC2_RG11_EAC,
 585    MESA_FORMAT_ETC2_SIGNED_R11_EAC,
 586    MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
 587    MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
 588    MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
 589
 590    /* Type A format(s) */
 591    MESA_FORMAT_SIGNED_A8,         /*                               AAAA AAAA */
 592    MESA_FORMAT_SIGNED_L8,         /*                               LLLL LLLL */
 593
 594    /* Type P format(s) */
 595    MESA_FORMAT_SIGNED_AL88,       /*                     AAAA AAAA LLLL LLLL */
 596
 597    /* Type A format(s) */
 598    MESA_FORMAT_SIGNED_I8,         /*                               IIII IIII */
 599    MESA_FORMAT_SIGNED_A16,        /*                     AAAA AAAA AAAA AAAA */
 600    MESA_FORMAT_SIGNED_L16,        /*                     LLLL LLLL LLLL LLLL */
 601    MESA_FORMAT_SIGNED_AL1616,     /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 602    MESA_FORMAT_SIGNED_I16,        /*                     IIII IIII IIII IIII */
 603
 604    /* Type P format(s) */
 605    MESA_FORMAT_RGB9_E5_FLOAT,
 606    MESA_FORMAT_R11_G11_B10_FLOAT,
 607
 608    /* Type A format(s) */
 609    MESA_FORMAT_Z_FLOAT32,
 610
 611    /* Type P formats */
 612    MESA_FORMAT_Z32_FLOAT_X24S8,
 613
 614    MESA_FORMAT_ARGB2101010_UINT,
 615    MESA_FORMAT_ABGR2101010_UINT,
 616
 617    MESA_FORMAT_XRGB4444_UNORM,    /*                     xxxx RRRR GGGG BBBB */
 618    MESA_FORMAT_XRGB1555_UNORM,    /*                     xRRR RRGG GGGB BBBB */
 619    MESA_FORMAT_XBGR8888_SNORM,    /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 620    MESA_FORMAT_XBGR8888_SRGB,     /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 621
 622    /* Type A formats */
 623    MESA_FORMAT_RGBX_UINT8,    /* uchar[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 624    MESA_FORMAT_RGBX_SINT8,    /* char[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x  */
 625
 626    /* Type P format(s) */
 627    MESA_FORMAT_XRGB2101010_UNORM, /* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 628
 629    /* Type A format(s) */
 630    MESA_FORMAT_RGBX_UNORM16,  /* ushort[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 631    MESA_FORMAT_RGBX_SNORM16,  /* ... */
 632    MESA_FORMAT_RGBX_FLOAT16,  /* ... */
 633    MESA_FORMAT_RGBX_UINT16,   /* ... */
 634    MESA_FORMAT_RGBX_SINT16,   /* ... */
 635
 636    MESA_FORMAT_RGBX_FLOAT32,  /* float[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 637    MESA_FORMAT_RGBX_UINT32,   /* ... */
 638    MESA_FORMAT_RGBX_SINT32,   /* ... */
 639
 640    /* Type P formats */
 641    MESA_FORMAT_ABGR2101010,
 642    MESA_FORMAT_SIGNED_RG88,
 643    MESA_FORMAT_SIGNED_RG1616,
 644
 645    MESA_FORMAT_COUNT
 646 } mesa_format;
 647
 648
 649 extern const char *
 650 _mesa_get_format_name(mesa_format format);
 651
 652 extern GLint
 653 _mesa_get_format_bytes(mesa_format format);
 654
 655 extern GLint
 656 _mesa_get_format_bits(mesa_format format, GLenum pname);
 657
 658 extern GLuint
 659 _mesa_get_format_max_bits(mesa_format format);
 660
 661 extern GLenum
 662 _mesa_get_format_datatype(mesa_format format);
 663
 664 extern GLenum
 665 _mesa_get_format_base_format(mesa_format format);
 666
 667 extern void
 668 _mesa_get_format_block_size(mesa_format format, GLuint *bw, GLuint *bh);
 669
 670 extern GLboolean
 671 _mesa_is_format_compressed(mesa_format format);
 672
 673 extern GLboolean
 674 _mesa_is_format_packed_depth_stencil(mesa_format format);
 675
 676 extern GLboolean
 677 _mesa_is_format_integer_color(mesa_format format);
 678
 679 extern GLboolean
 680 _mesa_is_format_unsigned(mesa_format format);
 681
 682 extern GLboolean
 683 _mesa_is_format_signed(mesa_format format);
 684
 685 extern GLenum
 686 _mesa_get_format_color_encoding(mesa_format format);
 687
 688 extern GLuint
 689 _mesa_format_image_size(mesa_format format, GLsizei width,
 690                         GLsizei height, GLsizei depth);
 691
 692 extern uint64_t
 693 _mesa_format_image_size64(mesa_format format, GLsizei width,
 694                           GLsizei height, GLsizei depth);
 695
 696 extern GLint
 697 _mesa_format_row_stride(mesa_format format, GLsizei width);
 698
 699 extern void
 700 _mesa_format_to_type_and_comps(mesa_format format,
 701                                GLenum *datatype, GLuint *comps);
 702
 703 extern void
 704 _mesa_test_formats(void);
 705
 706 extern mesa_format
 707 _mesa_get_srgb_format_linear(mesa_format format);
 708
 709 extern mesa_format
 710 _mesa_get_uncompressed_format(mesa_format format);
 711
 712 extern GLuint
 713 _mesa_format_num_components(mesa_format format);
 714
 715 GLboolean
 716 _mesa_format_matches_format_and_type(mesa_format mesa_format,
 717                                      GLenum format, GLenum type,
 718                                      GLboolean swapBytes);
 719
 720 #ifdef __cplusplus
 721 }
 722 #endif
 723
 724 #endif /* FORMATS_H */