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     *   ----------   Type A Format List (based on format_unpack.c):
 171     *  BGR_UNORM8
 172     *  RGB_UNORM8
 173     *  A_UNORM8
 174     *  A_UNORM16
 175     *  L_UNORM8
 176     *  L_UNORM16
 177     *  I_UNORM8
 178     *  I_UNOMR16
 179     *  R_UNORM8
 180     *  R_UNORM16
 181     *  Z_UNORM16
 182     *  Z_UNORM32
 183     *  Z_FLOAT32
 184     *  S_UINT8
 185     *  BGR_SRGB8
 186     *  L_SRGB8
 187     *  RGBA_FLOAT32
 188     *  RGBA_FLOAT16
 189     *  RGB_FLOAT32
 190     *  RGB_FLOAT16
 191     *  A_FLOAT32
 192     *  A_FLOAT16
 193     *  L_FLOAT32
 194     *  L_FLOAT16
 195     *  LA_FLOAT32
 196     *  LA_FLOAT16
 197     *  I_FLOAT32
 198     *  I_FLOAT16
 199     *  R_FLOAT32
 200     *  R_FLOAT16
 201     *  RG_FLOAT32
 202     *  RG_FLOAT16
 203     *  A_UINT8
 204     *  A_UINT16
 205     *  A_UINT32
 206     *  A_SINT8
 207     *  A_SINT16
 208     *  A_SINT32
 209     *  I_UINT8
 210     *  I_UINT16
 211     *  I_UINT32
 212     *  I_SINT8
 213     *  I_SINT16
 214     *  I_SINT32
 215     *  L_UINT8
 216     *  L_UINT16
 217     *  L_UINT32
 218     *  L_SINT8
 219     *  L_SINT16
 220     *  L_SINT32
 221     *  LA_UINT8
 222     *  LA_UINT16
 223     *  LA_UINT32
 224     *  LA_SINT8
 225     *  LA_SINT16
 226     *  LA_SINT32
 227     *  R_SINT8
 228     *  RG_SINT8
 229     *  RGB_SINT8
 230     *  RGBA_SINT8
 231     *  R_SINT16
 232     *  RG_SINT16
 233     *  RGB_SINT16
 234     *  RGBA_SINT16
 235     *  R_SINT32
 236     *  RG_SINT32
 237     *  RGB_SINT32
 238     *  RGBA_SINT32
 239     *  R_SINT16
 240     *  R_SINT32
 241     *  R_UINT8
 242     *  RG_UINT8
 243     *  RGB_UINT8
 244     *  RGBA_UINT8
 245     *  R_UINT16
 246     *  RG_UINT16
 247     *  RGB_UINT16
 248     *  RGBA_UINT16
 249     *  R_UINT32
 250     *  RG_UINT32
 251     *  RGB_UINT32
 252     *  RGBA_UINT32
 253     *  R_UINT16
 254     *  R_UINT32
 255     *  R_SNORM8
 256     *  R_SNORM16
 257     *  RGB_SNORM16
 258     *  RGBA_SNORM16
 259     *  RGBA_UNORM16
 260     *  A_SNORM8
 261     *  L_SNORM8
 262     *  I_SNORM8
 263     *  A_SNORM16
 264     *  L_SNORM16
 265     *  LA_SNORM16
 266     *  I_SNORM16
 267     *  RGBX_UINT8
 268     *  RGBX_SINT8
 269     *  RGBX_UNORM16
 270     *  RGBX_SNORM16
 271     *  RGBX_FLOAT16
 272     *  RGBX_UINT16
 273     *  RGBX_SINT16
 274     *  RGBX_FLOAT32
 275     *  RGBX_UINT32
 276     *  RGBX_SINT32
 277     *
 278     *
 279     *
 280     *   ----------   Type P Format List (based on format_unpack.c):
 281     *  A8B8G8R8_UNORM
 282     *  R8G8B8A8_UNORM
 283     *  B8G8R8A8_UNORM
 284     *  A8R8G8B8_UNORM
 285     *  X8B8G8R8_UNORM
 286     *  R8G8B8X8_UNORM
 287     *  B8G8R8X8_UNORM
 288     *  X8R8G8B8_UNORM
 289     *  B5G6R5_UNORM
 290     *  R5G6B5_UNORM
 291     *  B4G4R4A4_UNORM
 292     *  A4R4G4B4_UNORM
 293     *  A1B5G5R5_UNORM
 294     *  B5G5R5A1_UNORM
 295     *  A1R5G5B5_UNORM
 296     *  L4A4_UNORM
 297     *  L8A8_UNORM
 298     *  A8L8_UNORM
 299     *  L16A16_UNORM
 300     *  A16L16_UNORM
 301     *  B2G3R3_UNORM
 302     *  YCBCR
 303     *  YCBCR_REV
 304     *  R8G8_UNORM
 305     *  G8R8_UNORM
 306     *  R16G16_UNORM
 307     *  G16R16_UNORM
 308     *  B10G10R10A2_UNORM
 309     *  B10G10R10A2_UINT
 310     *  R10G10B10A2_UINT
 311     *  S8_UINT_Z24_UNORM
 312     *  Z24_UNORM_S8_UINT
 313     *  Z24_UNORM_X8_UINT
 314     *  X8_UINT_Z24_UNORM
 315     *  Z32_FLOAT_S8X24_UINT
 316     *  A8R8G8B8_SRGB
 317     *  B8G8R8A8_SRGB
 318     *  L8A8_SRGB
 319     *  R8G8_SNORM
 320     *  X8B8G8R8_SNORM
 321     *  A8B8G8R8_SNORM
 322     *  R8G8B8A8_SNORM
 323     *  R16G16_SNORM
 324     *  L8A8_SNORM
 325     *  R9G9B9E5_FLOAT
 326     *  R11G11B10_FLOAT
 327     *  B4G4R4X4_UNORM
 328     *  B5G5R5X1_UNORM
 329     *  R8G8_SNORM
 330     *  R8G8B8X8_SNORM
 331     *  R8G8B8X8_SRGB
 332     *  B10G10R10X2_UNORM
 333     *  R10G10B10A2_UNORM
 334     *  G8R8_SINT
 335     *  G16R16_SINT
 336     *
 337     */
 338    /*@{*/
 339
 340    /* Type P formats */          /* msb <------ TEXEL BITS -----------> lsb */
 341                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 342    MESA_FORMAT_A8B8G8R8_UNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 343    MESA_FORMAT_R8G8B8A8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 344    MESA_FORMAT_B8G8R8A8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 345    MESA_FORMAT_A8R8G8B8_UNORM,   /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 346    MESA_FORMAT_X8B8G8R8_UNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 347    MESA_FORMAT_R8G8B8X8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 348    MESA_FORMAT_B8G8R8X8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
 349    MESA_FORMAT_X8R8G8B8_UNORM,   /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
 350
 351    /* Type A formats */
 352    MESA_FORMAT_BGR_UNORM8,    /* uchar[i * 3] = B, [i * 3 + 1] = G, [i *3 + 2] = R */
 353    MESA_FORMAT_RGB_UNORM8,    /* uchar[i * 3] = R, [i * 3 + 1] = G, [i *3 + 2] = B */
 354
 355    /* Type P formats */
 356    MESA_FORMAT_B5G6R5_UNORM,                         /* BBBB BGGG GGGR RRRR */
 357    MESA_FORMAT_R5G6B5_UNORM,                         /* RRRR RGGG GGGB BBBB */
 358    MESA_FORMAT_B4G4R4A4_UNORM,                       /* BBBB GGGG RRRR AAAA */
 359    MESA_FORMAT_A4R4G4B4_UNORM,                       /* AAAA RRRR GGGG BBBB */
 360    MESA_FORMAT_A1B5G5R5_UNORM,                       /* ABBB BBGG GGGR RRRR */
 361    MESA_FORMAT_B5G5R5A1_UNORM,                       /* BBBB BGGG GGRR RRRA */
 362    MESA_FORMAT_A1R5G5B5_UNORM,                       /* ARRR RRGG GGGB BBBB */
 363    MESA_FORMAT_L4A4_UNORM,                                     /* LLLL AAAA */
 364    MESA_FORMAT_L8A8_UNORM,                           /* LLLL LLLL AAAA AAAA */
 365    MESA_FORMAT_A8L8_UNORM,                           /* AAAA AAAA LLLL LLLL */
 366    MESA_FORMAT_L16A16_UNORM,     /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
 367    MESA_FORMAT_A16L16_UNORM,     /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 368    MESA_FORMAT_B2G3R3_UNORM,                                   /* BBGG GRRR */
 369
 370    /* Type A formats */
 371    MESA_FORMAT_A_UNORM8,     /* uchar[i] = A */
 372    MESA_FORMAT_A_UNORM16,    /* ushort[i] = A */
 373    MESA_FORMAT_L_UNORM8,     /* uchar[i] = L */
 374    MESA_FORMAT_L_UNORM16,    /* ushort[i] = L */
 375    MESA_FORMAT_I_UNORM8,     /* uchar[i] = I */
 376    MESA_FORMAT_I_UNORM16,    /* ushort[i] = I */
 377
 378    /* Type P formats */
 379    MESA_FORMAT_YCBCR,         /*                     YYYY YYYY UorV UorV */
 380    MESA_FORMAT_YCBCR_REV,     /*                     UorV UorV YYYY YYYY */
 381
 382    /* Type A format(s) */
 383    MESA_FORMAT_R_UNORM8,      /* uchar[i] = R */
 384
 385    /* Type P formats */
 386    MESA_FORMAT_R8G8_UNORM,                           /* RRRR RRRR GGGG GGGG */
 387    MESA_FORMAT_G8R8_UNORM,                           /* GGGG GGGG RRRR RRRR */
 388
 389    /* Type A format(s) */
 390    MESA_FORMAT_R_UNORM16,     /* ushort[i] = R */
 391
 392    /* Type P formats */
 393    MESA_FORMAT_R16G16_UNORM,     /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 394    MESA_FORMAT_G16R16_UNORM,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 395    MESA_FORMAT_B10G10R10A2_UNORM,/* BBBB BBBB BBGG GGGG GGGG RRRR RRRR RRAA */
 396    MESA_FORMAT_S8_UINT_Z24_UNORM,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 397    MESA_FORMAT_Z24_UNORM_X8_UINT,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 398
 399    /* Type A format(s) */
 400    MESA_FORMAT_Z_UNORM16,     /* ushort[i] = Z */
 401
 402    /* Type P formats */
 403    MESA_FORMAT_Z24_UNORM_S8_UINT,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
 404    MESA_FORMAT_X8Z24_UNORM,      /* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 405
 406    /* Type A formats */
 407    MESA_FORMAT_Z_UNORM32,     /* uint[i] = Z */
 408    MESA_FORMAT_S_UINT8,       /* uchar[i] = S */
 409    /*@}*/
 410
 411    /**
 412     * \name 8-bit/channel sRGB formats
 413     */
 414    /*@{*/
 415    /* Type A format(s) */
 416    MESA_FORMAT_BGR_SRGB8,     /* uchar[i * 3] = B, [i * 3 + 1] = G, [i *3 + 2] = R */
 417
 418    /* Type P formats */
 419    MESA_FORMAT_A8B8G8R8_SRGB,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR*/
 420    MESA_FORMAT_B8G8R8A8_SRGB,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 421
 422    /* Type A format(s) */
 423    MESA_FORMAT_L_SRGB8,       /* uchar[i] = L */
 424
 425    /* Type P formats */
 426    MESA_FORMAT_L8A8_SRGB,        /* LLLL LLLL AAAA AAAA */
 427
 428    /* Type C formats */
 429    MESA_FORMAT_SRGB_DXT1,
 430    MESA_FORMAT_SRGBA_DXT1,
 431    MESA_FORMAT_SRGBA_DXT3,
 432    MESA_FORMAT_SRGBA_DXT5,
 433    /*@}*/
 434
 435    /**
 436     * \name Compressed texture formats.
 437     */
 438    /*@{*/
 439    /* Type C formats */
 440    MESA_FORMAT_RGB_FXT1,
 441    MESA_FORMAT_RGBA_FXT1,
 442    MESA_FORMAT_RGB_DXT1,
 443    MESA_FORMAT_RGBA_DXT1,
 444    MESA_FORMAT_RGBA_DXT3,
 445    MESA_FORMAT_RGBA_DXT5,
 446    /*@}*/
 447
 448    /**
 449     * \name Floating point texture formats.
 450     */
 451    /*@{*/
 452
 453    /* Type A formats */
 454    MESA_FORMAT_RGBA_FLOAT32,  /* float[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = A */
 455    MESA_FORMAT_RGBA_FLOAT16,
 456    MESA_FORMAT_RGB_FLOAT32,
 457    MESA_FORMAT_RGB_FLOAT16,
 458    MESA_FORMAT_A_FLOAT32,
 459    MESA_FORMAT_A_FLOAT16,
 460    MESA_FORMAT_L_FLOAT32,
 461    MESA_FORMAT_L_FLOAT16,
 462    MESA_FORMAT_LA_FLOAT32,
 463    MESA_FORMAT_LA_FLOAT16,
 464    MESA_FORMAT_I_FLOAT32,
 465    MESA_FORMAT_I_FLOAT16,
 466    MESA_FORMAT_R_FLOAT32,
 467    MESA_FORMAT_R_FLOAT16,
 468    MESA_FORMAT_RG_FLOAT32,
 469    MESA_FORMAT_RG_FLOAT16,
 470    /*@}*/
 471
 472    /**
 473     * \name Non-normalized signed integer formats.
 474     * XXX Note: these are just stand-ins for some better hardware
 475     * formats TBD such as BGRA or ARGB.
 476     */
 477
 478    /* Type A formats */
 479    MESA_FORMAT_A_UINT8,
 480    MESA_FORMAT_A_UINT16,
 481    MESA_FORMAT_A_UINT32,
 482    MESA_FORMAT_A_SINT8,
 483    MESA_FORMAT_A_SINT16,
 484    MESA_FORMAT_A_SINT32,
 485
 486    MESA_FORMAT_I_UINT8,
 487    MESA_FORMAT_I_UINT16,
 488    MESA_FORMAT_I_UINT32,
 489    MESA_FORMAT_I_SINT8,
 490    MESA_FORMAT_I_SINT16,
 491    MESA_FORMAT_I_SINT32,
 492
 493    MESA_FORMAT_L_UINT8,
 494    MESA_FORMAT_L_UINT16,
 495    MESA_FORMAT_L_UINT32,
 496    MESA_FORMAT_L_SINT8,
 497    MESA_FORMAT_L_SINT16,
 498    MESA_FORMAT_L_SINT32,
 499    MESA_FORMAT_LA_UINT8,
 500    MESA_FORMAT_LA_UINT16,
 501    MESA_FORMAT_LA_UINT32,
 502    MESA_FORMAT_LA_SINT8,
 503    MESA_FORMAT_LA_SINT16,
 504    MESA_FORMAT_LA_SINT32,
 505
 506    MESA_FORMAT_R_SINT8,
 507    MESA_FORMAT_RG_SINT8,
 508    MESA_FORMAT_RGB_SINT8,
 509    MESA_FORMAT_RGBA_SINT8,
 510    MESA_FORMAT_R_SINT16,
 511    MESA_FORMAT_RG_SINT16,
 512    MESA_FORMAT_RGB_SINT16,
 513    MESA_FORMAT_RGBA_SINT16,
 514
 515    MESA_FORMAT_R_SINT32,
 516    MESA_FORMAT_RG_SINT32,
 517    MESA_FORMAT_RGB_SINT32,
 518    MESA_FORMAT_RGBA_SINT32,
 519
 520    /**
 521     * \name Non-normalized unsigned integer formats.
 522     */
 523    /* Type A format(s) */
 524    MESA_FORMAT_R_UINT8,
 525    MESA_FORMAT_RG_UINT8,
 526    MESA_FORMAT_RGB_UINT8,
 527    MESA_FORMAT_RGBA_UINT8,
 528
 529    MESA_FORMAT_R_UINT16,
 530    MESA_FORMAT_RG_UINT16,
 531    MESA_FORMAT_RGB_UINT16,
 532    MESA_FORMAT_RGBA_UINT16,
 533
 534    MESA_FORMAT_R_UINT32,
 535    MESA_FORMAT_RG_UINT32,
 536    MESA_FORMAT_RGB_UINT32,
 537    MESA_FORMAT_RGBA_UINT32,
 538
 539                                  /* msb <------ TEXEL BITS -----------> lsb */
 540                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 541    /**
 542     * \name Signed fixed point texture formats.
 543     */
 544    /*@{*/
 545    MESA_FORMAT_DUDV8,             /*                     DUDU DUDU DVDV DVDV */
 546
 547    /* Type A format(s) */
 548    MESA_FORMAT_R_SNORM8,      /* char[i] = R */
 549
 550    /* Type P formats */
 551    MESA_FORMAT_R8G8_SNORM,                           /* RRRR RRRR GGGG GGGG */
 552    MESA_FORMAT_X8B8G8R8_SNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 553    MESA_FORMAT_A8B8G8R8_SNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 554    MESA_FORMAT_R8G8B8A8_SNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 555
 556    /* Type A format(s) */
 557    MESA_FORMAT_R_SNORM16,     /* short[i] = R */
 558
 559    /* Type P format(s) */
 560    MESA_FORMAT_R16G16_SNORM,     /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 561
 562    /* Type A format(s) */
 563    MESA_FORMAT_RGB_SNORM16,   /* short[i * 3] = R, [i * 3 + 1] = G, [i *3 + 2] = B */
 564    MESA_FORMAT_RGBA_SNORM16,  /* ... */
 565    MESA_FORMAT_RGBA_UNORM16,  /* ... */
 566    /*@}*/
 567
 568    /*@{*/
 569    /* Type C formats */
 570    MESA_FORMAT_R_RGTC1_UNORM,
 571    MESA_FORMAT_R_RGTC1_SNORM,
 572    MESA_FORMAT_RG_RGTC2_UNORM,
 573    MESA_FORMAT_RG_RGTC2_SNORM,
 574    /*@}*/
 575
 576    /*@{*/
 577    MESA_FORMAT_L_LATC1_UNORM,
 578    MESA_FORMAT_L_LATC1_SNORM,
 579    MESA_FORMAT_LA_LATC2_UNORM,
 580    MESA_FORMAT_LA_LATC2_SNORM,
 581    /*@}*/
 582
 583    MESA_FORMAT_ETC1_RGB8,
 584    MESA_FORMAT_ETC2_RGB8,
 585    MESA_FORMAT_ETC2_SRGB8,
 586    MESA_FORMAT_ETC2_RGBA8_EAC,
 587    MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
 588    MESA_FORMAT_ETC2_R11_EAC,
 589    MESA_FORMAT_ETC2_RG11_EAC,
 590    MESA_FORMAT_ETC2_SIGNED_R11_EAC,
 591    MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
 592    MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
 593    MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
 594
 595    /* Type A format(s) */
 596    MESA_FORMAT_A_SNORM8,      /* char[i] = A */
 597    MESA_FORMAT_L_SNORM8,      /* char[i] = L */
 598
 599    /* Type P format(s) */
 600    MESA_FORMAT_L8A8_SNORM,                           /* LLLL LLLL AAAA AAAA */
 601
 602    /* Type A format(s) */
 603    MESA_FORMAT_I_SNORM8,      /* char[i] = I */
 604    MESA_FORMAT_A_SNORM16,     /* short[i] = A */
 605    MESA_FORMAT_L_SNORM16,     /* short[i] = L */
 606    MESA_FORMAT_LA_SNORM16,    /* short[i * 2] = L, [i * 2 + 1] = A */
 607    MESA_FORMAT_I_SNORM16,     /* short[i] = I */
 608
 609    /* Type P format(s) */
 610    MESA_FORMAT_R9G9B9E5_FLOAT,
 611    MESA_FORMAT_R11G11B10_FLOAT,
 612
 613    /* Type A format(s) */
 614    MESA_FORMAT_Z_FLOAT32,
 615
 616    /* Type P formats */
 617    MESA_FORMAT_Z32_FLOAT_S8X24_UINT,
 618
 619    MESA_FORMAT_B10G10R10A2_UINT,
 620    MESA_FORMAT_R10G10B10A2_UINT,
 621
 622    MESA_FORMAT_B4G4R4X4_UNORM,                       /* BBBB GGGG RRRR xxxx */
 623    MESA_FORMAT_B5G5R5X1_UNORM,                       /* BBBB BGGG GGRR RRRx */
 624    MESA_FORMAT_R8G8B8X8_SNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 625    MESA_FORMAT_R8G8B8X8_SRGB,    /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 626
 627    /* Type A formats */
 628    MESA_FORMAT_RGBX_UINT8,    /* uchar[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 629    MESA_FORMAT_RGBX_SINT8,    /* char[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x  */
 630
 631    /* Type P format(s) */
 632    MESA_FORMAT_B10G10R10X2_UNORM,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 633
 634    /* Type A formats */
 635    MESA_FORMAT_RGBX_UNORM16,  /* ushort[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 636    MESA_FORMAT_RGBX_SNORM16,  /* ... */
 637    MESA_FORMAT_RGBX_FLOAT16,  /* ... */
 638    MESA_FORMAT_RGBX_UINT16,   /* ... */
 639    MESA_FORMAT_RGBX_SINT16,   /* ... */
 640
 641    MESA_FORMAT_RGBX_FLOAT32,  /* float[i * 4] = R, [i * 4 + 1] = G, [i * 4 + 2] = B, [i * 4 + 3] = x */
 642    MESA_FORMAT_RGBX_UINT32,   /* ... */
 643    MESA_FORMAT_RGBX_SINT32,   /* ... */
 644
 645    /* Type P formats */
 646    MESA_FORMAT_R10G10B10A2_UNORM,
 647    MESA_FORMAT_G8R8_SNORM,
 648    MESA_FORMAT_G16R16_SNORM,
 649
 650    MESA_FORMAT_COUNT
 651 } mesa_format;
 652
 653
 654 extern const char *
 655 _mesa_get_format_name(mesa_format format);
 656
 657 extern GLint
 658 _mesa_get_format_bytes(mesa_format format);
 659
 660 extern GLint
 661 _mesa_get_format_bits(mesa_format format, GLenum pname);
 662
 663 extern GLuint
 664 _mesa_get_format_max_bits(mesa_format format);
 665
 666 extern GLenum
 667 _mesa_get_format_datatype(mesa_format format);
 668
 669 extern GLenum
 670 _mesa_get_format_base_format(mesa_format format);
 671
 672 extern void
 673 _mesa_get_format_block_size(mesa_format format, GLuint *bw, GLuint *bh);
 674
 675 extern GLboolean
 676 _mesa_is_format_compressed(mesa_format format);
 677
 678 extern GLboolean
 679 _mesa_is_format_packed_depth_stencil(mesa_format format);
 680
 681 extern GLboolean
 682 _mesa_is_format_integer_color(mesa_format format);
 683
 684 extern GLboolean
 685 _mesa_is_format_unsigned(mesa_format format);
 686
 687 extern GLboolean
 688 _mesa_is_format_signed(mesa_format format);
 689
 690 extern GLenum
 691 _mesa_get_format_color_encoding(mesa_format format);
 692
 693 extern GLuint
 694 _mesa_format_image_size(mesa_format format, GLsizei width,
 695                         GLsizei height, GLsizei depth);
 696
 697 extern uint64_t
 698 _mesa_format_image_size64(mesa_format format, GLsizei width,
 699                           GLsizei height, GLsizei depth);
 700
 701 extern GLint
 702 _mesa_format_row_stride(mesa_format format, GLsizei width);
 703
 704 extern void
 705 _mesa_format_to_type_and_comps(mesa_format format,
 706                                GLenum *datatype, GLuint *comps);
 707
 708 extern void
 709 _mesa_test_formats(void);
 710
 711 extern mesa_format
 712 _mesa_get_srgb_format_linear(mesa_format format);
 713
 714 extern mesa_format
 715 _mesa_get_uncompressed_format(mesa_format format);
 716
 717 extern GLuint
 718 _mesa_format_num_components(mesa_format format);
 719
 720 GLboolean
 721 _mesa_format_matches_format_and_type(mesa_format mesa_format,
 722                                      GLenum format, GLenum type,
 723                                      GLboolean swapBytes);
 724
 725 #ifdef __cplusplus
 726 }
 727 #endif
 728
 729 #endif /* FORMATS_H */