src/mesa/main/formats.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.7
   4  *
   5  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   6  * Copyright (c) 2008-2009  VMware, Inc.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included
  16  * in all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  24  * OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27 /*
  28  * Authors:
  29  *   Brian Paul
  30  */
  31
  32
  33 #ifndef FORMATS_H
  34 #define FORMATS_H
  35
  36
  37 #include <GL/gl.h>
  38
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  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 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
  48
  49
  50 /**
  51  * Max number of bytes for any non-compressed pixel format below, or for
  52  * intermediate pixel storage in Mesa.  This should never be less than
  53  * 16.  Maybe 32 someday?
  54  */
  55 #define MAX_PIXEL_BYTES 16
  56
  57
  58 /**
  59  * Mesa texture/renderbuffer image formats.
  60  */
  61 typedef enum
  62 {
  63    MESA_FORMAT_NONE = 0,
  64
  65    /**
  66     * \name Basic hardware formats
  67     */
  68    /*@{*/
  69                                 /* msb <------ TEXEL BITS -----------> lsb */
  70                                 /* ---- ---- ---- ---- ---- ---- ---- ---- */
  71    MESA_FORMAT_RGBA8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
  72    MESA_FORMAT_RGBA8888_REV,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
  73    MESA_FORMAT_ARGB8888,        /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
  74    MESA_FORMAT_ARGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
  75    MESA_FORMAT_RGBX8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB XXXX XXXX */
  76    MESA_FORMAT_RGBX8888_REV,    /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
  77    MESA_FORMAT_XRGB8888,        /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
  78    MESA_FORMAT_XRGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
  79    MESA_FORMAT_RGB888,          /*           RRRR RRRR GGGG GGGG BBBB BBBB */
  80    MESA_FORMAT_BGR888,          /*           BBBB BBBB GGGG GGGG RRRR RRRR */
  81    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
  82    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
  83    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
  84    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
  85    MESA_FORMAT_RGBA5551,        /*                     RRRR RGGG GGBB BBBA */
  86    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
  87    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
  88    MESA_FORMAT_AL44,            /*                               AAAA LLLL */
  89    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
  90    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
  91    MESA_FORMAT_AL1616,          /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
  92    MESA_FORMAT_AL1616_REV,      /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
  93    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
  94    MESA_FORMAT_A8,              /*                               AAAA AAAA */
  95    MESA_FORMAT_A16,             /*                     AAAA AAAA AAAA AAAA */
  96    MESA_FORMAT_L8,              /*                               LLLL LLLL */
  97    MESA_FORMAT_L16,             /*                     LLLL LLLL LLLL LLLL */
  98    MESA_FORMAT_I8,              /*                               IIII IIII */
  99    MESA_FORMAT_I16,             /*                     IIII IIII IIII IIII */
 100    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
 101    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
 102    MESA_FORMAT_R8,              /*                               RRRR RRRR */
 103    MESA_FORMAT_GR88,            /*                     GGGG GGGG RRRR RRRR */
 104    MESA_FORMAT_RG88,            /*                     RRRR RRRR GGGG GGGG */
 105    MESA_FORMAT_R16,             /*                     RRRR RRRR RRRR RRRR */
 106    MESA_FORMAT_GR1616,          /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 107    MESA_FORMAT_RG1616,          /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
 108    MESA_FORMAT_ARGB2101010,     /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 109    MESA_FORMAT_Z24_S8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
 110    MESA_FORMAT_S8_Z24,          /* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 111    MESA_FORMAT_Z16,             /*                     ZZZZ ZZZZ ZZZZ ZZZZ */
 112    MESA_FORMAT_X8_Z24,          /* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 113    MESA_FORMAT_Z24_X8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 114    MESA_FORMAT_Z32,             /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 115    MESA_FORMAT_S8,              /*                               SSSS SSSS */
 116    /*@}*/
 117
 118    /**
 119     * \name 8-bit/channel sRGB formats
 120     */
 121    /*@{*/
 122    MESA_FORMAT_SRGB8,           /*           RRRR RRRR GGGG GGGG BBBB BBBB */
 123    MESA_FORMAT_SRGBA8,          /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 124    MESA_FORMAT_SARGB8,          /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 125    MESA_FORMAT_SL8,             /*                               LLLL LLLL */
 126    MESA_FORMAT_SLA8,            /*                     AAAA AAAA LLLL LLLL */
 127    MESA_FORMAT_SRGB_DXT1,
 128    MESA_FORMAT_SRGBA_DXT1,
 129    MESA_FORMAT_SRGBA_DXT3,
 130    MESA_FORMAT_SRGBA_DXT5,
 131    /*@}*/
 132
 133    /**
 134     * \name Compressed texture formats.
 135     */
 136    /*@{*/
 137    MESA_FORMAT_RGB_FXT1,
 138    MESA_FORMAT_RGBA_FXT1,
 139    MESA_FORMAT_RGB_DXT1,
 140    MESA_FORMAT_RGBA_DXT1,
 141    MESA_FORMAT_RGBA_DXT3,
 142    MESA_FORMAT_RGBA_DXT5,
 143    /*@}*/
 144
 145    /**
 146     * \name Floating point texture formats.
 147     */
 148    /*@{*/
 149    MESA_FORMAT_RGBA_FLOAT32,
 150    MESA_FORMAT_RGBA_FLOAT16,
 151    MESA_FORMAT_RGB_FLOAT32,
 152    MESA_FORMAT_RGB_FLOAT16,
 153    MESA_FORMAT_ALPHA_FLOAT32,
 154    MESA_FORMAT_ALPHA_FLOAT16,
 155    MESA_FORMAT_LUMINANCE_FLOAT32,
 156    MESA_FORMAT_LUMINANCE_FLOAT16,
 157    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT32,
 158    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT16,
 159    MESA_FORMAT_INTENSITY_FLOAT32,
 160    MESA_FORMAT_INTENSITY_FLOAT16,
 161    MESA_FORMAT_R_FLOAT32,
 162    MESA_FORMAT_R_FLOAT16,
 163    MESA_FORMAT_RG_FLOAT32,
 164    MESA_FORMAT_RG_FLOAT16,
 165    /*@}*/
 166
 167    /**
 168     * \name Non-normalized signed integer formats.
 169     * XXX Note: these are just stand-ins for some better hardware
 170     * formats TBD such as BGRA or ARGB.
 171     */
 172    MESA_FORMAT_ALPHA_UINT8,
 173    MESA_FORMAT_ALPHA_UINT16,
 174    MESA_FORMAT_ALPHA_UINT32,
 175    MESA_FORMAT_ALPHA_INT8,
 176    MESA_FORMAT_ALPHA_INT16,
 177    MESA_FORMAT_ALPHA_INT32,
 178
 179    MESA_FORMAT_INTENSITY_UINT8,
 180    MESA_FORMAT_INTENSITY_UINT16,
 181    MESA_FORMAT_INTENSITY_UINT32,
 182    MESA_FORMAT_INTENSITY_INT8,
 183    MESA_FORMAT_INTENSITY_INT16,
 184    MESA_FORMAT_INTENSITY_INT32,
 185
 186    MESA_FORMAT_LUMINANCE_UINT8,
 187    MESA_FORMAT_LUMINANCE_UINT16,
 188    MESA_FORMAT_LUMINANCE_UINT32,
 189    MESA_FORMAT_LUMINANCE_INT8,
 190    MESA_FORMAT_LUMINANCE_INT16,
 191    MESA_FORMAT_LUMINANCE_INT32,
 192
 193    MESA_FORMAT_LUMINANCE_ALPHA_UINT8,
 194    MESA_FORMAT_LUMINANCE_ALPHA_UINT16,
 195    MESA_FORMAT_LUMINANCE_ALPHA_UINT32,
 196    MESA_FORMAT_LUMINANCE_ALPHA_INT8,
 197    MESA_FORMAT_LUMINANCE_ALPHA_INT16,
 198    MESA_FORMAT_LUMINANCE_ALPHA_INT32,
 199
 200    MESA_FORMAT_R_INT8,
 201    MESA_FORMAT_RG_INT8,
 202    MESA_FORMAT_RGB_INT8,
 203    MESA_FORMAT_RGBA_INT8,
 204    MESA_FORMAT_R_INT16,
 205    MESA_FORMAT_RG_INT16,
 206    MESA_FORMAT_RGB_INT16,
 207    MESA_FORMAT_RGBA_INT16,
 208    MESA_FORMAT_R_INT32,
 209    MESA_FORMAT_RG_INT32,
 210    MESA_FORMAT_RGB_INT32,
 211    MESA_FORMAT_RGBA_INT32,
 212
 213    /**
 214     * \name Non-normalized unsigned integer formats.
 215     */
 216    MESA_FORMAT_R_UINT8,
 217    MESA_FORMAT_RG_UINT8,
 218    MESA_FORMAT_RGB_UINT8,
 219    MESA_FORMAT_RGBA_UINT8,
 220    MESA_FORMAT_R_UINT16,
 221    MESA_FORMAT_RG_UINT16,
 222    MESA_FORMAT_RGB_UINT16,
 223    MESA_FORMAT_RGBA_UINT16,
 224    MESA_FORMAT_R_UINT32,
 225    MESA_FORMAT_RG_UINT32,
 226    MESA_FORMAT_RGB_UINT32,
 227    MESA_FORMAT_RGBA_UINT32,
 228
 229                                   /* msb <------ TEXEL BITS -----------> lsb */
 230                                   /* ---- ---- ---- ---- ---- ---- ---- ---- */
 231    /**
 232     * \name Signed fixed point texture formats.
 233     */
 234    /*@{*/
 235    MESA_FORMAT_DUDV8,             /*                     DUDU DUDU DVDV DVDV */
 236    MESA_FORMAT_SIGNED_R8,         /*                               RRRR RRRR */
 237    MESA_FORMAT_SIGNED_RG88_REV,   /*                     GGGG GGGG RRRR RRRR */
 238    MESA_FORMAT_SIGNED_RGBX8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 239    MESA_FORMAT_SIGNED_RGBA8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 240    MESA_FORMAT_SIGNED_RGBA8888_REV,/*AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 241    MESA_FORMAT_SIGNED_R16,        /*                     RRRR RRRR RRRR RRRR */
 242    MESA_FORMAT_SIGNED_GR1616,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 243    MESA_FORMAT_SIGNED_RGB_16,     /* ushort[0]=R, ushort[1]=G, ushort[2]=B */
 244    MESA_FORMAT_SIGNED_RGBA_16,    /* ... */
 245    MESA_FORMAT_RGBA_16,           /* ... */
 246    /*@}*/
 247
 248    /*@{*/
 249    MESA_FORMAT_RED_RGTC1,
 250    MESA_FORMAT_SIGNED_RED_RGTC1,
 251    MESA_FORMAT_RG_RGTC2,
 252    MESA_FORMAT_SIGNED_RG_RGTC2,
 253    /*@}*/
 254
 255    /*@{*/
 256    MESA_FORMAT_L_LATC1,
 257    MESA_FORMAT_SIGNED_L_LATC1,
 258    MESA_FORMAT_LA_LATC2,
 259    MESA_FORMAT_SIGNED_LA_LATC2,
 260    /*@}*/
 261
 262    MESA_FORMAT_ETC1_RGB8,
 263    MESA_FORMAT_ETC2_RGB8,
 264    MESA_FORMAT_ETC2_SRGB8,
 265    MESA_FORMAT_ETC2_RGBA8_EAC,
 266    MESA_FORMAT_ETC2_SRGB8_ALPHA8_EAC,
 267    MESA_FORMAT_ETC2_R11_EAC,
 268    MESA_FORMAT_ETC2_RG11_EAC,
 269    MESA_FORMAT_ETC2_SIGNED_R11_EAC,
 270    MESA_FORMAT_ETC2_SIGNED_RG11_EAC,
 271    MESA_FORMAT_ETC2_RGB8_PUNCHTHROUGH_ALPHA1,
 272    MESA_FORMAT_ETC2_SRGB8_PUNCHTHROUGH_ALPHA1,
 273
 274    MESA_FORMAT_SIGNED_A8,         /*                               AAAA AAAA */
 275    MESA_FORMAT_SIGNED_L8,         /*                               LLLL LLLL */
 276    MESA_FORMAT_SIGNED_AL88,       /*                     AAAA AAAA LLLL LLLL */
 277    MESA_FORMAT_SIGNED_I8,         /*                               IIII IIII */
 278    MESA_FORMAT_SIGNED_A16,        /*                     AAAA AAAA AAAA AAAA */
 279    MESA_FORMAT_SIGNED_L16,        /*                     LLLL LLLL LLLL LLLL */
 280    MESA_FORMAT_SIGNED_AL1616,     /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 281    MESA_FORMAT_SIGNED_I16,        /*                     IIII IIII IIII IIII */
 282
 283    MESA_FORMAT_RGB9_E5_FLOAT,
 284    MESA_FORMAT_R11_G11_B10_FLOAT,
 285
 286    MESA_FORMAT_Z32_FLOAT,
 287    MESA_FORMAT_Z32_FLOAT_X24S8,
 288
 289    MESA_FORMAT_ARGB2101010_UINT,
 290    MESA_FORMAT_ABGR2101010_UINT,
 291
 292    MESA_FORMAT_XRGB4444_UNORM,
 293    MESA_FORMAT_XRGB1555_UNORM,
 294    MESA_FORMAT_XBGR8888_SNORM,
 295    MESA_FORMAT_XBGR8888_SRGB,
 296    MESA_FORMAT_XBGR8888_UINT,
 297    MESA_FORMAT_XBGR8888_SINT,
 298    MESA_FORMAT_XRGB2101010_UNORM,
 299    MESA_FORMAT_XBGR16161616_UNORM,
 300    MESA_FORMAT_XBGR16161616_SNORM,
 301    MESA_FORMAT_XBGR16161616_FLOAT,
 302    MESA_FORMAT_XBGR16161616_UINT,
 303    MESA_FORMAT_XBGR16161616_SINT,
 304    MESA_FORMAT_XBGR32323232_FLOAT,
 305    MESA_FORMAT_XBGR32323232_UINT,
 306    MESA_FORMAT_XBGR32323232_SINT,
 307
 308    MESA_FORMAT_COUNT
 309 } gl_format;
 310
 311
 312 extern const char *
 313 _mesa_get_format_name(gl_format format);
 314
 315 extern GLint
 316 _mesa_get_format_bytes(gl_format format);
 317
 318 extern GLint
 319 _mesa_get_format_bits(gl_format format, GLenum pname);
 320
 321 extern GLuint
 322 _mesa_get_format_max_bits(gl_format format);
 323
 324 extern GLenum
 325 _mesa_get_format_datatype(gl_format format);
 326
 327 extern GLenum
 328 _mesa_get_format_base_format(gl_format format);
 329
 330 extern void
 331 _mesa_get_format_block_size(gl_format format, GLuint *bw, GLuint *bh);
 332
 333 extern GLboolean
 334 _mesa_is_format_compressed(gl_format format);
 335
 336 extern GLboolean
 337 _mesa_is_format_packed_depth_stencil(gl_format format);
 338
 339 extern GLboolean
 340 _mesa_is_format_integer_color(gl_format format);
 341
 342 extern GLboolean
 343 _mesa_is_format_unsigned(gl_format format);
 344
 345 extern GLenum
 346 _mesa_get_format_color_encoding(gl_format format);
 347
 348 extern GLuint
 349 _mesa_format_image_size(gl_format format, GLsizei width,
 350                         GLsizei height, GLsizei depth);
 351
 352 extern uint64_t
 353 _mesa_format_image_size64(gl_format format, GLsizei width,
 354                           GLsizei height, GLsizei depth);
 355
 356 extern GLint
 357 _mesa_format_row_stride(gl_format format, GLsizei width);
 358
 359 extern void
 360 _mesa_format_to_type_and_comps(gl_format format,
 361                                GLenum *datatype, GLuint *comps);
 362
 363 extern void
 364 _mesa_test_formats(void);
 365
 366 extern gl_format
 367 _mesa_get_srgb_format_linear(gl_format format);
 368
 369 extern gl_format
 370 _mesa_get_uncompressed_format(gl_format format);
 371
 372 extern GLuint
 373 _mesa_format_num_components(gl_format format);
 374
 375 GLboolean
 376 _mesa_format_matches_format_and_type(gl_format gl_format,
 377                                      GLenum format, GLenum type,
 378                                      GLboolean swapBytes);
 379
 380 #ifdef __cplusplus
 381 }
 382 #endif
 383
 384 #endif /* FORMATS_H */