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 #include <stdbool.h>
  38 #include <stdint.h>
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44
  45 /**
  46  * OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
  47  * for GL_LUMINANCE4_ALPHA4.
  48  */
  49 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
  50
  51
  52 /**
  53  * Max number of bytes for any non-compressed pixel format below, or for
  54  * intermediate pixel storage in Mesa.  This should never be less than
  55  * 16.  Maybe 32 someday?
  56  */
  57 #define MAX_PIXEL_BYTES 16
  58
  59 /**
  60  * Specifies the layout of a pixel format.  See the MESA_FORMAT
  61  * documentation below.
  62  */
  63 enum mesa_format_layout {
  64    MESA_FORMAT_LAYOUT_ARRAY,
  65    MESA_FORMAT_LAYOUT_PACKED,
  66    MESA_FORMAT_LAYOUT_S3TC,
  67    MESA_FORMAT_LAYOUT_RGTC,
  68    MESA_FORMAT_LAYOUT_LATC,
  69    MESA_FORMAT_LAYOUT_FXT1,
  70    MESA_FORMAT_LAYOUT_ETC1,
  71    MESA_FORMAT_LAYOUT_ETC2,
  72    MESA_FORMAT_LAYOUT_BPTC,
  73    MESA_FORMAT_LAYOUT_ASTC,
  74    MESA_FORMAT_LAYOUT_ATC,
  75    MESA_FORMAT_LAYOUT_OTHER,
  76 };
  77
  78 /**
  79  * An enum representing different possible swizzling values.  This is used
  80  * to interpret the output of _mesa_get_format_swizzle
  81  */
  82 enum {
  83    MESA_FORMAT_SWIZZLE_X = 0,
  84    MESA_FORMAT_SWIZZLE_Y = 1,
  85    MESA_FORMAT_SWIZZLE_Z = 2,
  86    MESA_FORMAT_SWIZZLE_W = 3,
  87    MESA_FORMAT_SWIZZLE_ZERO = 4,
  88    MESA_FORMAT_SWIZZLE_ONE = 5,
  89    MESA_FORMAT_SWIZZLE_NONE = 6,
  90 };
  91
  92 /**
  93  * An uint32_t that encodes the information necessary to represent an
  94  * array format
  95  */
  96 typedef uint32_t mesa_array_format;
  97
  98 /**
  99  * Encoding for valid array format data types
 100  */
 101 enum mesa_array_format_datatype {
 102    MESA_ARRAY_FORMAT_TYPE_UBYTE = 0x0,
 103    MESA_ARRAY_FORMAT_TYPE_USHORT = 0x1,
 104    MESA_ARRAY_FORMAT_TYPE_UINT = 0x2,
 105    MESA_ARRAY_FORMAT_TYPE_BYTE = 0x4,
 106    MESA_ARRAY_FORMAT_TYPE_SHORT = 0x5,
 107    MESA_ARRAY_FORMAT_TYPE_INT = 0x6,
 108    MESA_ARRAY_FORMAT_TYPE_HALF = 0xd,
 109    MESA_ARRAY_FORMAT_TYPE_FLOAT = 0xe,
 110 };
 111
 112 enum mesa_array_format_base_format {
 113    MESA_ARRAY_FORMAT_BASE_FORMAT_RGBA_VARIANTS = 0x0,
 114    MESA_ARRAY_FORMAT_BASE_FORMAT_DEPTH = 0x1,
 115    MESA_ARRAY_FORMAT_BASE_FORMAT_STENCIL = 0x2,
 116 };
 117
 118 /**
 119  * An enum useful to encode/decode information stored in a mesa_array_format
 120  */
 121 enum {
 122    MESA_ARRAY_FORMAT_TYPE_IS_SIGNED = 0x4,
 123    MESA_ARRAY_FORMAT_TYPE_IS_FLOAT = 0x8,
 124    MESA_ARRAY_FORMAT_TYPE_NORMALIZED = 0x10,
 125    MESA_ARRAY_FORMAT_DATATYPE_MASK = 0xf,
 126    MESA_ARRAY_FORMAT_TYPE_MASK = 0x1f,
 127    MESA_ARRAY_FORMAT_TYPE_SIZE_MASK = 0x3,
 128    MESA_ARRAY_FORMAT_NUM_CHANS_MASK = 0xe0,
 129    MESA_ARRAY_FORMAT_SWIZZLE_X_MASK = 0x00700,
 130    MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK = 0x03800,
 131    MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK = 0x1c000,
 132    MESA_ARRAY_FORMAT_SWIZZLE_W_MASK = 0xe0000,
 133    MESA_ARRAY_FORMAT_BASE_FORMAT_MASK = 0x300000,
 134    MESA_ARRAY_FORMAT_BIT = 0x80000000
 135 };
 136
 137 #define MESA_ARRAY_FORMAT(BASE_FORMAT, SIZE, SIGNED, IS_FLOAT, NORM, NUM_CHANS, \
 138                           SWIZZLE_X, SWIZZLE_Y, SWIZZLE_Z, SWIZZLE_W) ( \
 139    (((SIZE >> 1)      ) & MESA_ARRAY_FORMAT_TYPE_SIZE_MASK) |      \
 140    (((SIGNED)    << 2 ) & MESA_ARRAY_FORMAT_TYPE_IS_SIGNED) |      \
 141    (((IS_FLOAT)  << 3 ) & MESA_ARRAY_FORMAT_TYPE_IS_FLOAT) |       \
 142    (((NORM)      << 4 ) & MESA_ARRAY_FORMAT_TYPE_NORMALIZED) |     \
 143    (((NUM_CHANS) << 5 ) & MESA_ARRAY_FORMAT_NUM_CHANS_MASK) |      \
 144    (((SWIZZLE_X) << 8 ) & MESA_ARRAY_FORMAT_SWIZZLE_X_MASK) |      \
 145    (((SWIZZLE_Y) << 11) & MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK) |      \
 146    (((SWIZZLE_Z) << 14) & MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK) |      \
 147    (((SWIZZLE_W) << 17) & MESA_ARRAY_FORMAT_SWIZZLE_W_MASK) |      \
 148    (((BASE_FORMAT) << 20) & MESA_ARRAY_FORMAT_BASE_FORMAT_MASK) |  \
 149    MESA_ARRAY_FORMAT_BIT)
 150
 151 /**
 152  * Various helpers to access the data encoded in a mesa_array_format
 153  */
 154 static inline bool
 155 _mesa_array_format_is_signed(mesa_array_format f)
 156 {
 157    return (f & MESA_ARRAY_FORMAT_TYPE_IS_SIGNED) != 0;
 158 }
 159
 160 static inline bool
 161 _mesa_array_format_is_float(mesa_array_format f)
 162 {
 163    return (f & MESA_ARRAY_FORMAT_TYPE_IS_FLOAT) != 0;
 164 }
 165
 166 static inline bool
 167 _mesa_array_format_is_normalized(mesa_array_format f)
 168 {
 169    return (f & MESA_ARRAY_FORMAT_TYPE_NORMALIZED) !=0;
 170 }
 171
 172 static inline enum mesa_array_format_base_format
 173 _mesa_array_format_get_base_format(mesa_array_format f)
 174 {
 175    return (enum mesa_array_format_base_format)
 176       ((f & MESA_ARRAY_FORMAT_BASE_FORMAT_MASK) >> 20);
 177 }
 178
 179 static inline enum mesa_array_format_datatype
 180 _mesa_array_format_get_datatype(mesa_array_format f)
 181 {
 182    return (enum mesa_array_format_datatype)
 183             (f & MESA_ARRAY_FORMAT_DATATYPE_MASK);
 184 }
 185
 186 static inline int
 187 _mesa_array_format_datatype_get_size(enum mesa_array_format_datatype type)
 188 {
 189    return 1 << (type & MESA_ARRAY_FORMAT_TYPE_SIZE_MASK);
 190 }
 191
 192 static inline int
 193 _mesa_array_format_get_type_size(mesa_array_format f)
 194 {
 195    return 1 << (f & MESA_ARRAY_FORMAT_TYPE_SIZE_MASK);
 196 }
 197
 198 static inline int
 199 _mesa_array_format_get_num_channels(mesa_array_format f)
 200 {
 201    return (f & MESA_ARRAY_FORMAT_NUM_CHANS_MASK) >> 5;
 202 }
 203
 204 static inline void
 205 _mesa_array_format_get_swizzle(mesa_array_format f, uint8_t *swizzle)
 206 {
 207    swizzle[0] = (f & MESA_ARRAY_FORMAT_SWIZZLE_X_MASK) >> 8;
 208    swizzle[1] = (f & MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK) >> 11;
 209    swizzle[2] = (f & MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK) >> 14;
 210    swizzle[3] = (f & MESA_ARRAY_FORMAT_SWIZZLE_W_MASK) >> 17;
 211 }
 212
 213 static inline void
 214 _mesa_array_format_set_swizzle(mesa_array_format *f,
 215                                int32_t x, int32_t y, int32_t z, int32_t w)
 216 {
 217    *f &= ~(MESA_ARRAY_FORMAT_SWIZZLE_X_MASK |
 218            MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK |
 219            MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK |
 220            MESA_ARRAY_FORMAT_SWIZZLE_W_MASK);
 221
 222    *f |= ((x << 8 ) & MESA_ARRAY_FORMAT_SWIZZLE_X_MASK) |
 223          ((y << 11) & MESA_ARRAY_FORMAT_SWIZZLE_Y_MASK) |
 224          ((z << 14) & MESA_ARRAY_FORMAT_SWIZZLE_Z_MASK) |
 225          ((w << 17) & MESA_ARRAY_FORMAT_SWIZZLE_W_MASK);
 226 }
 227
 228 /**
 229  * A helper to know if the format stored in a uint32_t is a mesa_format
 230  * or a mesa_array_format
 231  */
 232 static inline bool
 233 _mesa_format_is_mesa_array_format(uint32_t f)
 234 {
 235    return (f & MESA_ARRAY_FORMAT_BIT) != 0;
 236 }
 237
 238 /**
 239  * Mesa texture/renderbuffer image formats.
 240  */
 241 typedef enum
 242 {
 243    MESA_FORMAT_NONE = 0,
 244
 245    /**
 246     * \name Basic hardware formats
 247     *
 248     * The mesa format name specification is as follows:
 249     *
 250     *  There shall be 3 naming format base types: those for component array
 251     *  formats (type A); those for compressed formats (type C); and those for
 252     *  packed component formats (type P). With type A formats, color component
 253     *  order does not change with endianess. Each format name shall begin with
 254     *  MESA_FORMAT_, followed by a component label (from the Component Label
 255     *  list below) for each component in the order that the component(s) occur
 256     *  in the format, except for non-linear color formats where the first
 257     *  letter shall be 'S'. For type P formats, each component label is
 258     *  followed by the number of bits that represent it in the fundamental
 259     *  data type used by the format.
 260     *
 261     *  Following the listing of the component labels shall be an underscore; a
 262     *  compression type followed by an underscore for Type C formats only; a
 263     *  storage type from the list below; and a bit with for type A formats,
 264     *  which is the bit width for each array element.
 265     *
 266     *
 267     *  ----------    Format Base Type A: Array ----------
 268     *  MESA_FORMAT_[component list]_[storage type][array element bit width]
 269     *
 270     *  examples:
 271     *  MESA_FORMAT_A_SNORM8     - uchar[i] = A
 272     *  MESA_FORMAT_RGBA_16 - ushort[i * 4 + 0] = R, ushort[i * 4 + 1] = G,
 273     *                             ushort[i * 4 + 2] = B, ushort[i * 4 + 3] = A
 274     *  MESA_FORMAT_Z_UNORM32    - float[i] = Z
 275     *
 276     *
 277     *
 278     *  ----------    Format Base Type C: Compressed ----------
 279     *  MESA_FORMAT_[component list*][_*][compression type][storage type*]
 280     *  * where required
 281     *
 282     *  examples:
 283     *  MESA_FORMAT_RGB_ETC1
 284     *  MESA_FORMAT_RGBA_ETC2
 285     *  MESA_FORMAT_LATC1_UNORM
 286     *  MESA_FORMAT_RGBA_FXT1
 287     *
 288     *
 289     *
 290     *  ----------    Format Base Type P: Packed  ----------
 291     *  MESA_FORMAT_[[component list,bit width][storage type*][_]][_][storage type**]
 292     *   * when type differs between component
 293     *   ** when type applies to all components
 294     *
 295     *  examples:                   msb <------ TEXEL BITS -----------> lsb
 296     *  MESA_FORMAT_A8B8G8R8_UNORM, RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA
 297     *  MESA_FORMAT_R5G6B5_UNORM                        BBBB BGGG GGGR RRRR
 298     *  MESA_FORMAT_B4G4R4X4_UNORM                      XXXX RRRR GGGG BBBB
 299     *  MESA_FORMAT_Z32_FLOAT_S8X24_UINT
 300     *  MESA_FORMAT_R10G10B10A2_UINT
 301     *  MESA_FORMAT_R9G9B9E5_FLOAT
 302     *
 303     *
 304     *
 305     *  ----------    Component Labels: ----------
 306     *  A - Alpha
 307     *  B - Blue
 308     *  DU - Delta U
 309     *  DV - Delta V
 310     *  E - Shared Exponent
 311     *  G - Green
 312     *  I - Intensity
 313     *  L - Luminance
 314     *  R - Red
 315     *  S - Stencil (when not followed by RGB or RGBA)
 316     *  U - Chrominance
 317     *  V - Chrominance
 318     *  Y - Luma
 319     *  X - Packing bits
 320     *  Z - Depth
 321     *
 322     *
 323     *
 324     *  ----------    Type C Compression Types: ----------
 325     *  DXT1 - Color component labels shall be given
 326     *  DXT3 - Color component labels shall be given
 327     *  DXT5 - Color component labels shall be given
 328     *  ETC1 - No other information required
 329     *  ETC2 - No other information required
 330     *  FXT1 - Color component labels shall be given
 331     *  FXT3 - Color component labels shall be given
 332     *  LATC1 - Fundamental data type shall be given
 333     *  LATC2 - Fundamental data type shall be given
 334     *  RGTC1 - Color component labels and data type shall be given
 335     *  RGTC2 - Color component labels and data type shall be given
 336     *
 337     *
 338     *
 339     *  ----------    Storage Types: ----------
 340     *  FLOAT
 341     *  SINT
 342     *  UINT
 343     *  SNORM
 344     *  UNORM
 345     *  SRGB - RGB components, or L are UNORMs in sRGB color space.
 346     *         Alpha, if present is linear.
 347     *
 348     */
 349
 350    /* Packed unorm formats */    /* msb <------ TEXEL BITS -----------> lsb */
 351                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 352    MESA_FORMAT_A8B8G8R8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 353    MESA_FORMAT_X8B8G8R8_UNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 354    MESA_FORMAT_R8G8B8A8_UNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 355    MESA_FORMAT_R8G8B8X8_UNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 356    MESA_FORMAT_B8G8R8A8_UNORM,   /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 357    MESA_FORMAT_B8G8R8X8_UNORM,   /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
 358    MESA_FORMAT_A8R8G8B8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 359    MESA_FORMAT_X8R8G8B8_UNORM,   /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
 360    MESA_FORMAT_L16A16_UNORM,     /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 361    MESA_FORMAT_A16L16_UNORM,     /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
 362    MESA_FORMAT_B5G6R5_UNORM,                         /* RRRR RGGG GGGB BBBB */
 363    MESA_FORMAT_R5G6B5_UNORM,                         /* BBBB BGGG GGGR RRRR */
 364    MESA_FORMAT_B4G4R4A4_UNORM,                       /* AAAA RRRR GGGG BBBB */
 365    MESA_FORMAT_B4G4R4X4_UNORM,                       /* xxxx RRRR GGGG BBBB */
 366    MESA_FORMAT_A4R4G4B4_UNORM,                       /* BBBB GGGG RRRR AAAA */
 367    MESA_FORMAT_A1B5G5R5_UNORM,                       /* RRRR RGGG GGBB BBBA */
 368    MESA_FORMAT_X1B5G5R5_UNORM,                       /* BBBB BGGG GGRR RRRX */
 369    MESA_FORMAT_B5G5R5A1_UNORM,                       /* ARRR RRGG GGGB BBBB */
 370    MESA_FORMAT_B5G5R5X1_UNORM,                       /* xRRR RRGG GGGB BBBB */
 371    MESA_FORMAT_A1R5G5B5_UNORM,                       /* BBBB BGGG GGRR RRRA */
 372    MESA_FORMAT_L8A8_UNORM,                           /* AAAA AAAA LLLL LLLL */
 373    MESA_FORMAT_A8L8_UNORM,                           /* LLLL LLLL AAAA AAAA */
 374    MESA_FORMAT_R8G8_UNORM,                           /* GGGG GGGG RRRR RRRR */
 375    MESA_FORMAT_G8R8_UNORM,                           /* RRRR RRRR GGGG GGGG */
 376    MESA_FORMAT_L4A4_UNORM,                                     /* AAAA LLLL */
 377    MESA_FORMAT_B2G3R3_UNORM,                                   /* RRRG GGBB */
 378
 379    MESA_FORMAT_R16G16_UNORM,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 380    MESA_FORMAT_G16R16_UNORM,     /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 381    MESA_FORMAT_B10G10R10A2_UNORM,/* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 382    MESA_FORMAT_B10G10R10X2_UNORM,/* xxRR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 383    MESA_FORMAT_R10G10B10A2_UNORM,/* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
 384    MESA_FORMAT_R10G10B10X2_UNORM,/* xxBB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
 385
 386    MESA_FORMAT_S8_UINT_Z24_UNORM,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
 387    MESA_FORMAT_X8_UINT_Z24_UNORM,/* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 388    MESA_FORMAT_Z24_UNORM_S8_UINT,/* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 389    MESA_FORMAT_Z24_UNORM_X8_UINT,/* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 390
 391    /* Other formats */
 392    MESA_FORMAT_R3G3B2_UNORM,                                   /* BBGG GRRR */
 393    MESA_FORMAT_A4B4G4R4_UNORM,                       /* RRRR GGGG BBBB AAAA */
 394    MESA_FORMAT_R4G4B4A4_UNORM,                       /* AAAA BBBB GGGG RRRR */
 395    MESA_FORMAT_R5G5B5A1_UNORM,                       /* ABBB BBGG GGGR RRRR */
 396    MESA_FORMAT_A2B10G10R10_UNORM,/* RRRR RRRR RRGG GGGG GGGG BBBB BBBB BBAA */
 397    MESA_FORMAT_A2R10G10B10_UNORM,/* BBBB BBBB BBGG GGGG GGGG RRRR RRRR RRAA */
 398
 399    MESA_FORMAT_YCBCR,            /*                     YYYY YYYY UorV UorV */
 400    MESA_FORMAT_YCBCR_REV,        /*                     UorV UorV YYYY YYYY */
 401
 402    /* Array unorm formats */
 403    MESA_FORMAT_A_UNORM8,      /* ubyte[i] = A */
 404    MESA_FORMAT_A_UNORM16,     /* ushort[i] = A */
 405    MESA_FORMAT_L_UNORM8,      /* ubyte[i] = L */
 406    MESA_FORMAT_L_UNORM16,     /* ushort[i] = L */
 407    MESA_FORMAT_I_UNORM8,      /* ubyte[i] = I */
 408    MESA_FORMAT_I_UNORM16,     /* ushort[i] = I */
 409    MESA_FORMAT_R_UNORM8,      /* ubyte[i] = R */
 410    MESA_FORMAT_R_UNORM16,     /* ushort[i] = R */
 411    MESA_FORMAT_BGR_UNORM8,    /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
 412    MESA_FORMAT_RGB_UNORM8,    /* ubyte[i*3] = R, [i*3+1] = G, [i*3+2] = B */
 413    MESA_FORMAT_RGBA_UNORM16,  /* ushort[i] = R, [1] = G, [2] = B, [3] = A */
 414    MESA_FORMAT_RGBX_UNORM16,
 415
 416    MESA_FORMAT_Z_UNORM16,     /* ushort[i] = Z */
 417    MESA_FORMAT_Z_UNORM32,     /* uint[i] = Z */
 418    MESA_FORMAT_S_UINT8,       /* ubyte[i] = S */
 419
 420    /* Packed signed/normalized formats */
 421                                  /* msb <------ TEXEL BITS -----------> lsb */
 422                                  /* ---- ---- ---- ---- ---- ---- ---- ---- */
 423    MESA_FORMAT_A8B8G8R8_SNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 424    MESA_FORMAT_X8B8G8R8_SNORM,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 425    MESA_FORMAT_R8G8B8A8_SNORM,   /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 426    MESA_FORMAT_R8G8B8X8_SNORM,   /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 427    MESA_FORMAT_R16G16_SNORM,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 428    MESA_FORMAT_G16R16_SNORM,     /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 429    MESA_FORMAT_R8G8_SNORM,       /*                     GGGG GGGG RRRR RRRR */
 430    MESA_FORMAT_G8R8_SNORM,       /*                     RRRR RRRR GGGG GGGG */
 431    MESA_FORMAT_L8A8_SNORM,       /*                     AAAA AAAA LLLL LLLL */
 432    MESA_FORMAT_A8L8_SNORM,       /*                     LLLL LLLL AAAA AAAA */
 433
 434    /* Array signed/normalized formats */
 435    MESA_FORMAT_A_SNORM8,      /* byte[i] = A */
 436    MESA_FORMAT_A_SNORM16,     /* short[i] = A */
 437    MESA_FORMAT_L_SNORM8,      /* byte[i] = L */
 438    MESA_FORMAT_L_SNORM16,     /* short[i] = L */
 439    MESA_FORMAT_I_SNORM8,      /* byte[i] = I */
 440    MESA_FORMAT_I_SNORM16,     /* short[i] = I */
 441    MESA_FORMAT_R_SNORM8,      /* byte[i] = R */
 442    MESA_FORMAT_R_SNORM16,     /* short[i] = R */
 443    MESA_FORMAT_LA_SNORM16,    /* short[i * 2] = L, [i * 2 + 1] = A */
 444    MESA_FORMAT_RGB_SNORM16,   /* short[i*3] = R, [i*3+1] = G, [i*3+2] = B */
 445    MESA_FORMAT_RGBA_SNORM16,  /* ... */
 446    MESA_FORMAT_RGBX_SNORM16,  /* ... */
 447
 448    /* Packed sRGB formats */
 449    MESA_FORMAT_A8B8G8R8_SRGB,    /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 450    MESA_FORMAT_B8G8R8A8_SRGB,    /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 451    MESA_FORMAT_A8R8G8B8_SRGB,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 452    MESA_FORMAT_B8G8R8X8_SRGB,    /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
 453    MESA_FORMAT_X8R8G8B8_SRGB,    /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
 454    MESA_FORMAT_R8G8B8A8_SRGB,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 455    MESA_FORMAT_R8G8B8X8_SRGB,    /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
 456    MESA_FORMAT_X8B8G8R8_SRGB,    /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 457    MESA_FORMAT_L8A8_SRGB,                            /* AAAA AAAA LLLL LLLL */
 458    MESA_FORMAT_A8L8_SRGB,                            /* LLLL LLLL AAAA AAAA */
 459    MESA_FORMAT_R_SRGB8,          /* RRRR RRRR */
 460
 461    /* Array sRGB formats */
 462    MESA_FORMAT_L_SRGB8,       /* ubyte[i] = L */
 463    MESA_FORMAT_BGR_SRGB8,     /* ubyte[i*3] = B, [i*3+1] = G, [i*3+2] = R */
 464
 465    /* Packed float formats */
 466    MESA_FORMAT_R9G9B9E5_FLOAT,
 467    MESA_FORMAT_R11G11B10_FLOAT,   /* BBBB BBBB BBGG GGGG GGGG GRRR RRRR RRRR */
 468    MESA_FORMAT_Z32_FLOAT_S8X24_UINT, /* (float, x24s8) */
 469
 470    /* Array float formats */
 471    MESA_FORMAT_A_FLOAT16,
 472    MESA_FORMAT_A_FLOAT32,
 473    MESA_FORMAT_L_FLOAT16,
 474    MESA_FORMAT_L_FLOAT32,
 475    MESA_FORMAT_LA_FLOAT16,
 476    MESA_FORMAT_LA_FLOAT32,
 477    MESA_FORMAT_I_FLOAT16,
 478    MESA_FORMAT_I_FLOAT32,
 479    MESA_FORMAT_R_FLOAT16,
 480    MESA_FORMAT_R_FLOAT32,
 481    MESA_FORMAT_RG_FLOAT16,
 482    MESA_FORMAT_RG_FLOAT32,
 483    MESA_FORMAT_RGB_FLOAT16,
 484    MESA_FORMAT_RGB_FLOAT32,
 485    MESA_FORMAT_RGBA_FLOAT16,
 486    MESA_FORMAT_RGBA_FLOAT32,  /* float[0] = R, [1] = G, [2] = B, [3] = A */
 487    MESA_FORMAT_RGBX_FLOAT16,
 488    MESA_FORMAT_RGBX_FLOAT32,
 489    MESA_FORMAT_Z_FLOAT32,
 490
 491    /* Packed signed/unsigned non-normalized integer formats */
 492
 493    MESA_FORMAT_A8B8G8R8_UINT,    /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 494    MESA_FORMAT_A8R8G8B8_UINT,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
 495    MESA_FORMAT_R8G8B8A8_UINT,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 496    MESA_FORMAT_B8G8R8A8_UINT,    /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 497    MESA_FORMAT_B10G10R10A2_UINT, /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 498    MESA_FORMAT_R10G10B10A2_UINT, /* AABB BBBB BBBB GGGG GGGG GGRR RRRR RRRR */
 499    MESA_FORMAT_A2B10G10R10_UINT, /* RRRR RRRR RRGG GGGG GGGG BBBB BBBB BBAA */
 500    MESA_FORMAT_A2R10G10B10_UINT, /* BBBB BBBB BBGG GGGG GGGG RRRR RRRR RRAA */
 501    MESA_FORMAT_B5G6R5_UINT,                          /* RRRR RGGG GGGB BBBB */
 502    MESA_FORMAT_R5G6B5_UINT,                          /* BBBB BGGG GGGR RRRR */
 503    MESA_FORMAT_B2G3R3_UINT,                                    /* RRRG GGBB */
 504    MESA_FORMAT_R3G3B2_UINT,                                    /* BBGG GRRR */
 505    MESA_FORMAT_A4B4G4R4_UINT,                        /* RRRR GGGG BBBB AAAA */
 506    MESA_FORMAT_R4G4B4A4_UINT,                        /* AAAA BBBB GGGG RRRR */
 507    MESA_FORMAT_B4G4R4A4_UINT,                        /* AAAA RRRR GGGG BBBB */
 508    MESA_FORMAT_A4R4G4B4_UINT,                        /* BBBB GGGG RRRR AAAA */
 509    MESA_FORMAT_A1B5G5R5_UINT,                        /* RRRR RGGG GGBB BBBA */
 510    MESA_FORMAT_B5G5R5A1_UINT,                        /* ARRR RRGG GGGB BBBB */
 511    MESA_FORMAT_A1R5G5B5_UINT,                        /* BBBB BGGG GGRR RRRA */
 512    MESA_FORMAT_R5G5B5A1_UINT,                        /* ABBB BBGG GGGR RRRR */
 513
 514    /* Array signed/unsigned non-normalized integer formats */
 515    MESA_FORMAT_A_UINT8,
 516    MESA_FORMAT_A_UINT16,
 517    MESA_FORMAT_A_UINT32,
 518    MESA_FORMAT_A_SINT8,
 519    MESA_FORMAT_A_SINT16,
 520    MESA_FORMAT_A_SINT32,
 521
 522    MESA_FORMAT_I_UINT8,
 523    MESA_FORMAT_I_UINT16,
 524    MESA_FORMAT_I_UINT32,
 525    MESA_FORMAT_I_SINT8,
 526    MESA_FORMAT_I_SINT16,
 527    MESA_FORMAT_I_SINT32,
 528
 529    MESA_FORMAT_L_UINT8,
 530    MESA_FORMAT_L_UINT16,
 531    MESA_FORMAT_L_UINT32,
 532    MESA_FORMAT_L_SINT8,
 533    MESA_FORMAT_L_SINT16,
 534    MESA_FORMAT_L_SINT32,
 535
 536    MESA_FORMAT_LA_UINT8,
 537    MESA_FORMAT_LA_UINT16,
 538    MESA_FORMAT_LA_UINT32,
 539    MESA_FORMAT_LA_SINT8,
 540    MESA_FORMAT_LA_SINT16,
 541    MESA_FORMAT_LA_SINT32,
 542
 543    MESA_FORMAT_R_UINT8,
 544    MESA_FORMAT_R_UINT16,
 545    MESA_FORMAT_R_UINT32,
 546    MESA_FORMAT_R_SINT8,
 547    MESA_FORMAT_R_SINT16,
 548    MESA_FORMAT_R_SINT32,
 549
 550    MESA_FORMAT_RG_UINT8,
 551    MESA_FORMAT_RG_UINT16,
 552    MESA_FORMAT_RG_UINT32,
 553    MESA_FORMAT_RG_SINT8,
 554    MESA_FORMAT_RG_SINT16,
 555    MESA_FORMAT_RG_SINT32,
 556
 557    MESA_FORMAT_RGB_UINT8,
 558    MESA_FORMAT_RGB_UINT16,
 559    MESA_FORMAT_RGB_UINT32,
 560    MESA_FORMAT_RGB_SINT8,
 561    MESA_FORMAT_RGB_SINT16,
 562    MESA_FORMAT_RGB_SINT32,
 563
 564    MESA_FORMAT_RGBA_UINT8,
 565    MESA_FORMAT_RGBA_UINT16,
 566    MESA_FORMAT_RGBA_UINT32,
 567    MESA_FORMAT_RGBA_SINT8,
 568    MESA_FORMAT_RGBA_SINT16,
 569    MESA_FORMAT_RGBA_SINT32,
 570
 571    MESA_FORMAT_RGBX_UINT8,
 572    MESA_FORMAT_RGBX_UINT16,
 573    MESA_FORMAT_RGBX_UINT32,
 574    MESA_FORMAT_RGBX_SINT8,
 575    MESA_FORMAT_RGBX_SINT16,
 576    MESA_FORMAT_RGBX_SINT32,
 577
 578    /* DXT compressed formats */
 579    MESA_FORMAT_RGB_DXT1,
 580    MESA_FORMAT_RGBA_DXT1,
 581    MESA_FORMAT_RGBA_DXT3,
 582    MESA_FORMAT_RGBA_DXT5,
 583
 584    /* DXT sRGB compressed formats */
 585    MESA_FORMAT_SRGB_DXT1,
 586    MESA_FORMAT_SRGBA_DXT1,
 587    MESA_FORMAT_SRGBA_DXT3,
 588    MESA_FORMAT_SRGBA_DXT5,
 589
 590    /* FXT1 compressed formats */
 591    MESA_FORMAT_RGB_FXT1,
 592    MESA_FORMAT_RGBA_FXT1,
 593
 594    /* RGTC compressed formats */
 595    MESA_FORMAT_R_RGTC1_UNORM,
 596    MESA_FORMAT_R_RGTC1_SNORM,
 597    MESA_FORMAT_RG_RGTC2_UNORM,
 598    MESA_FORMAT_RG_RGTC2_SNORM,
 599
 600    /* LATC1/2 compressed formats */
 601    MESA_FORMAT_L_LATC1_UNORM,
 602    MESA_FORMAT_L_LATC1_SNORM,
 603    MESA_FORMAT_LA_LATC2_UNORM,
 604    MESA_FORMAT_LA_LATC2_SNORM,
 605
 606    /* ETC1/2 compressed formats */
 607    MESA_FORMAT_ETC1_RGB8,
 608    MESA_FORMAT_ETC2_RGB8,
 609    MESA_FORMAT_ETC2_SRGB8,
 610    MESA_FORMAT_ETC2_RGBA8_EAC,
 611    MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
 612    MESA_FORMAT_ETC2_R11_EAC,
 613    MESA_FORMAT_ETC2_RG11_EAC,
 614    MESA_FORMAT_ETC2_SIGNED_R11_EAC,
 615    MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
 616    MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
 617    MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
 618
 619    /* BPTC compressed formats */
 620    MESA_FORMAT_BPTC_RGBA_UNORM,
 621    MESA_FORMAT_BPTC_SRGB_ALPHA_UNORM,
 622    MESA_FORMAT_BPTC_RGB_SIGNED_FLOAT,
 623    MESA_FORMAT_BPTC_RGB_UNSIGNED_FLOAT,
 624
 625    /* ASTC compressed formats */
 626    MESA_FORMAT_RGBA_ASTC_4x4,
 627    MESA_FORMAT_RGBA_ASTC_5x4,
 628    MESA_FORMAT_RGBA_ASTC_5x5,
 629    MESA_FORMAT_RGBA_ASTC_6x5,
 630    MESA_FORMAT_RGBA_ASTC_6x6,
 631    MESA_FORMAT_RGBA_ASTC_8x5,
 632    MESA_FORMAT_RGBA_ASTC_8x6,
 633    MESA_FORMAT_RGBA_ASTC_8x8,
 634    MESA_FORMAT_RGBA_ASTC_10x5,
 635    MESA_FORMAT_RGBA_ASTC_10x6,
 636    MESA_FORMAT_RGBA_ASTC_10x8,
 637    MESA_FORMAT_RGBA_ASTC_10x10,
 638    MESA_FORMAT_RGBA_ASTC_12x10,
 639    MESA_FORMAT_RGBA_ASTC_12x12,
 640
 641    MESA_FORMAT_SRGB8_ALPHA8_ASTC_4x4,
 642    MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x4,
 643    MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x5,
 644    MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x5,
 645    MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x6,
 646    MESA_FORMAT_SRGB8_ALPHA8_ASTC_8x5,
 647    MESA_FORMAT_SRGB8_ALPHA8_ASTC_8x6,
 648    MESA_FORMAT_SRGB8_ALPHA8_ASTC_8x8,
 649    MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x5,
 650    MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x6,
 651    MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x8,
 652    MESA_FORMAT_SRGB8_ALPHA8_ASTC_10x10,
 653    MESA_FORMAT_SRGB8_ALPHA8_ASTC_12x10,
 654    MESA_FORMAT_SRGB8_ALPHA8_ASTC_12x12,
 655
 656    MESA_FORMAT_RGBA_ASTC_3x3x3,
 657    MESA_FORMAT_RGBA_ASTC_4x3x3,
 658    MESA_FORMAT_RGBA_ASTC_4x4x3,
 659    MESA_FORMAT_RGBA_ASTC_4x4x4,
 660    MESA_FORMAT_RGBA_ASTC_5x4x4,
 661    MESA_FORMAT_RGBA_ASTC_5x5x4,
 662    MESA_FORMAT_RGBA_ASTC_5x5x5,
 663    MESA_FORMAT_RGBA_ASTC_6x5x5,
 664    MESA_FORMAT_RGBA_ASTC_6x6x5,
 665    MESA_FORMAT_RGBA_ASTC_6x6x6,
 666    MESA_FORMAT_SRGB8_ALPHA8_ASTC_3x3x3,
 667    MESA_FORMAT_SRGB8_ALPHA8_ASTC_4x3x3,
 668    MESA_FORMAT_SRGB8_ALPHA8_ASTC_4x4x3,
 669    MESA_FORMAT_SRGB8_ALPHA8_ASTC_4x4x4,
 670    MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x4x4,
 671    MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x5x4,
 672    MESA_FORMAT_SRGB8_ALPHA8_ASTC_5x5x5,
 673    MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x5x5,
 674    MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x6x5,
 675    MESA_FORMAT_SRGB8_ALPHA8_ASTC_6x6x6,
 676
 677    /* ATC compressed formats */
 678    MESA_FORMAT_ATC_RGB,
 679    MESA_FORMAT_ATC_RGBA_EXPLICIT,
 680    MESA_FORMAT_ATC_RGBA_INTERPOLATED,
 681
 682    MESA_FORMAT_COUNT
 683 } mesa_format;
 684
 685
 686 extern const char *
 687 _mesa_get_format_name(mesa_format format);
 688
 689 extern int
 690 _mesa_get_format_bytes(mesa_format format);
 691
 692 extern GLint
 693 _mesa_get_format_bits(mesa_format format, GLenum pname);
 694
 695 extern unsigned int
 696 _mesa_get_format_max_bits(mesa_format format);
 697
 698 extern enum mesa_format_layout
 699 _mesa_get_format_layout(mesa_format format);
 700
 701 extern GLenum
 702 _mesa_get_format_datatype(mesa_format format);
 703
 704 extern GLenum
 705 _mesa_get_format_base_format(uint32_t format);
 706
 707 extern void
 708 _mesa_get_format_block_size(mesa_format format,
 709                             unsigned int *bw, unsigned int *bh);
 710
 711 extern void
 712 _mesa_get_format_block_size_3d(mesa_format format, unsigned int *bw,
 713                                unsigned int *bh, unsigned int *bd);
 714
 715 extern mesa_array_format
 716 _mesa_array_format_flip_channels(mesa_array_format format);
 717
 718 extern void
 719 _mesa_get_format_swizzle(mesa_format format, uint8_t swizzle_out[4]);
 720
 721 extern uint32_t
 722 _mesa_format_to_array_format(mesa_format format);
 723
 724 extern mesa_format
 725 _mesa_format_from_array_format(uint32_t array_format);
 726
 727 extern bool
 728 _mesa_is_format_compressed(mesa_format format);
 729
 730 extern bool
 731 _mesa_is_format_packed_depth_stencil(mesa_format format);
 732
 733 extern bool
 734 _mesa_is_format_integer_color(mesa_format format);
 735
 736 extern bool
 737 _mesa_is_format_unsigned(mesa_format format);
 738
 739 extern bool
 740 _mesa_is_format_signed(mesa_format format);
 741
 742 extern bool
 743 _mesa_is_format_integer(mesa_format format);
 744
 745 extern bool
 746 _mesa_is_format_etc2(mesa_format format);
 747
 748 bool
 749 _mesa_is_format_astc_2d(mesa_format format);
 750
 751 bool
 752 _mesa_is_format_color_format(mesa_format format);
 753
 754 bool
 755 _mesa_is_format_srgb(mesa_format format);
 756
 757 extern uint32_t
 758 _mesa_format_image_size(mesa_format format, int width,
 759                         int height, int depth);
 760
 761 extern uint64_t
 762 _mesa_format_image_size64(mesa_format format, int width,
 763                           int height, int depth);
 764
 765 extern int32_t
 766 _mesa_format_row_stride(mesa_format format, int width);
 767
 768 extern void
 769 _mesa_uncompressed_format_to_type_and_comps(mesa_format format,
 770                                GLenum *datatype, GLuint *comps);
 771
 772 extern void
 773 _mesa_test_formats(void);
 774
 775 extern mesa_format
 776 _mesa_get_srgb_format_linear(mesa_format format);
 777
 778 extern mesa_format
 779 _mesa_get_linear_format_srgb(mesa_format format);
 780
 781 extern mesa_format
 782 _mesa_get_intensity_format_red(mesa_format format);
 783
 784 extern mesa_format
 785 _mesa_get_uncompressed_format(mesa_format format);
 786
 787 extern unsigned int
 788 _mesa_format_num_components(mesa_format format);
 789
 790 extern bool
 791 _mesa_format_has_color_component(mesa_format format, int component);
 792
 793 bool
 794 _mesa_format_matches_format_and_type(mesa_format mesa_format,
 795                                      GLenum format, GLenum type,
 796                                      bool swapBytes, GLenum *error);
 797
 798 mesa_format
 799 _mesa_format_fallback_rgbx_to_rgba(mesa_format format);
 800
 801 #ifdef __cplusplus
 802 }
 803 #endif
 804
 805 #endif /* FORMATS_H */