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