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  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  22  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 /*
  27  * Authors:
  28  *   Brian Paul
  29  */
  30
  31
  32 #ifndef FORMATS_H
  33 #define FORMATS_H
  34
  35
  36 #include <GL/gl.h>
  37
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43
  44 /* OpenGL doesn't have GL_UNSIGNED_BYTE_4_4, so we must define our own type
  45  * for GL_LUMINANCE4_ALPHA4. */
  46 #define MESA_UNSIGNED_BYTE_4_4 (GL_UNSIGNED_BYTE<<1)
  47
  48
  49 /**
  50  * Mesa texture/renderbuffer image formats.
  51  */
  52 typedef enum
  53 {
  54    MESA_FORMAT_NONE = 0,
  55
  56    /**
  57     * \name Basic hardware formats
  58     */
  59    /*@{*/
  60                                 /* msb <------ TEXEL BITS -----------> lsb */
  61                                 /* ---- ---- ---- ---- ---- ---- ---- ---- */
  62    MESA_FORMAT_RGBA8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
  63    MESA_FORMAT_RGBA8888_REV,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
  64    MESA_FORMAT_ARGB8888,        /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
  65    MESA_FORMAT_ARGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
  66    MESA_FORMAT_RGBX8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB XXXX XXXX */
  67    MESA_FORMAT_RGBX8888_REV,    /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
  68    MESA_FORMAT_XRGB8888,        /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
  69    MESA_FORMAT_XRGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
  70    MESA_FORMAT_RGB888,          /*           RRRR RRRR GGGG GGGG BBBB BBBB */
  71    MESA_FORMAT_BGR888,          /*           BBBB BBBB GGGG GGGG RRRR RRRR */
  72    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
  73    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
  74    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
  75    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
  76    MESA_FORMAT_RGBA5551,        /*                     RRRR RGGG GGBB BBBA */
  77    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
  78    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
  79    MESA_FORMAT_AL44,            /*                               AAAA LLLL */
  80    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
  81    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
  82    MESA_FORMAT_AL1616,          /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
  83    MESA_FORMAT_AL1616_REV,      /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
  84    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
  85    MESA_FORMAT_A8,              /*                               AAAA AAAA */
  86    MESA_FORMAT_A16,             /*                     AAAA AAAA AAAA AAAA */
  87    MESA_FORMAT_L8,              /*                               LLLL LLLL */
  88    MESA_FORMAT_L16,             /*                     LLLL LLLL LLLL LLLL */
  89    MESA_FORMAT_I8,              /*                               IIII IIII */
  90    MESA_FORMAT_I16,             /*                     IIII IIII IIII IIII */
  91    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
  92    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
  93    MESA_FORMAT_R8,              /*                               RRRR RRRR */
  94    MESA_FORMAT_GR88,            /*                     GGGG GGGG RRRR RRRR */
  95    MESA_FORMAT_RG88,            /*                     RRRR RRRR GGGG GGGG */
  96    MESA_FORMAT_R16,             /*                     RRRR RRRR RRRR RRRR */
  97    MESA_FORMAT_RG1616,          /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
  98    MESA_FORMAT_RG1616_REV,      /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
  99    MESA_FORMAT_ARGB2101010,     /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
 100    MESA_FORMAT_Z24_S8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
 101    MESA_FORMAT_S8_Z24,          /* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 102    MESA_FORMAT_Z16,             /*                     ZZZZ ZZZZ ZZZZ ZZZZ */
 103    MESA_FORMAT_X8_Z24,          /* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 104    MESA_FORMAT_Z24_X8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 105    MESA_FORMAT_Z32,             /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 106    MESA_FORMAT_S8,              /*                               SSSS SSSS */
 107    /*@}*/
 108
 109    /**
 110     * \name 8-bit/channel sRGB formats
 111     */
 112    /*@{*/
 113    MESA_FORMAT_SRGB8,           /*           RRRR RRRR GGGG GGGG BBBB BBBB */
 114    MESA_FORMAT_SRGBA8,          /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 115    MESA_FORMAT_SARGB8,          /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
 116    MESA_FORMAT_SL8,             /*                               LLLL LLLL */
 117    MESA_FORMAT_SLA8,            /*                     AAAA AAAA LLLL LLLL */
 118    MESA_FORMAT_SRGB_DXT1,
 119    MESA_FORMAT_SRGBA_DXT1,
 120    MESA_FORMAT_SRGBA_DXT3,
 121    MESA_FORMAT_SRGBA_DXT5,
 122    /*@}*/
 123
 124    /**
 125     * \name Compressed texture formats.
 126     */
 127    /*@{*/
 128    MESA_FORMAT_RGB_FXT1,
 129    MESA_FORMAT_RGBA_FXT1,
 130    MESA_FORMAT_RGB_DXT1,
 131    MESA_FORMAT_RGBA_DXT1,
 132    MESA_FORMAT_RGBA_DXT3,
 133    MESA_FORMAT_RGBA_DXT5,
 134    /*@}*/
 135
 136    /**
 137     * \name Floating point texture formats.
 138     */
 139    /*@{*/
 140    MESA_FORMAT_RGBA_FLOAT32,
 141    MESA_FORMAT_RGBA_FLOAT16,
 142    MESA_FORMAT_RGB_FLOAT32,
 143    MESA_FORMAT_RGB_FLOAT16,
 144    MESA_FORMAT_ALPHA_FLOAT32,
 145    MESA_FORMAT_ALPHA_FLOAT16,
 146    MESA_FORMAT_LUMINANCE_FLOAT32,
 147    MESA_FORMAT_LUMINANCE_FLOAT16,
 148    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT32,
 149    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT16,
 150    MESA_FORMAT_INTENSITY_FLOAT32,
 151    MESA_FORMAT_INTENSITY_FLOAT16,
 152    MESA_FORMAT_R_FLOAT32,
 153    MESA_FORMAT_R_FLOAT16,
 154    MESA_FORMAT_RG_FLOAT32,
 155    MESA_FORMAT_RG_FLOAT16,
 156    /*@}*/
 157
 158    /**
 159     * \name Non-normalized signed integer formats.
 160     * XXX Note: these are just stand-ins for some better hardware
 161     * formats TBD such as BGRA or ARGB.
 162     */
 163    MESA_FORMAT_ALPHA_UINT8,
 164    MESA_FORMAT_ALPHA_UINT16,
 165    MESA_FORMAT_ALPHA_UINT32,
 166    MESA_FORMAT_ALPHA_INT8,
 167    MESA_FORMAT_ALPHA_INT16,
 168    MESA_FORMAT_ALPHA_INT32,
 169
 170    MESA_FORMAT_INTENSITY_UINT8,
 171    MESA_FORMAT_INTENSITY_UINT16,
 172    MESA_FORMAT_INTENSITY_UINT32,
 173    MESA_FORMAT_INTENSITY_INT8,
 174    MESA_FORMAT_INTENSITY_INT16,
 175    MESA_FORMAT_INTENSITY_INT32,
 176
 177    MESA_FORMAT_LUMINANCE_UINT8,
 178    MESA_FORMAT_LUMINANCE_UINT16,
 179    MESA_FORMAT_LUMINANCE_UINT32,
 180    MESA_FORMAT_LUMINANCE_INT8,
 181    MESA_FORMAT_LUMINANCE_INT16,
 182    MESA_FORMAT_LUMINANCE_INT32,
 183
 184    MESA_FORMAT_LUMINANCE_ALPHA_UINT8,
 185    MESA_FORMAT_LUMINANCE_ALPHA_UINT16,
 186    MESA_FORMAT_LUMINANCE_ALPHA_UINT32,
 187    MESA_FORMAT_LUMINANCE_ALPHA_INT8,
 188    MESA_FORMAT_LUMINANCE_ALPHA_INT16,
 189    MESA_FORMAT_LUMINANCE_ALPHA_INT32,
 190
 191    MESA_FORMAT_R_INT8,
 192    MESA_FORMAT_RG_INT8,
 193    MESA_FORMAT_RGB_INT8,
 194    MESA_FORMAT_RGBA_INT8,
 195    MESA_FORMAT_R_INT16,
 196    MESA_FORMAT_RG_INT16,
 197    MESA_FORMAT_RGB_INT16,
 198    MESA_FORMAT_RGBA_INT16,
 199    MESA_FORMAT_R_INT32,
 200    MESA_FORMAT_RG_INT32,
 201    MESA_FORMAT_RGB_INT32,
 202    MESA_FORMAT_RGBA_INT32,
 203
 204    /**
 205     * \name Non-normalized unsigned integer formats.
 206     */
 207    MESA_FORMAT_R_UINT8,
 208    MESA_FORMAT_RG_UINT8,
 209    MESA_FORMAT_RGB_UINT8,
 210    MESA_FORMAT_RGBA_UINT8,
 211    MESA_FORMAT_R_UINT16,
 212    MESA_FORMAT_RG_UINT16,
 213    MESA_FORMAT_RGB_UINT16,
 214    MESA_FORMAT_RGBA_UINT16,
 215    MESA_FORMAT_R_UINT32,
 216    MESA_FORMAT_RG_UINT32,
 217    MESA_FORMAT_RGB_UINT32,
 218    MESA_FORMAT_RGBA_UINT32,
 219
 220                                   /* msb <------ TEXEL BITS -----------> lsb */
 221                                   /* ---- ---- ---- ---- ---- ---- ---- ---- */
 222    /**
 223     * \name Signed fixed point texture formats.
 224     */
 225    /*@{*/
 226    MESA_FORMAT_DUDV8,             /*                     DUDU DUDU DVDV DVDV */
 227    MESA_FORMAT_SIGNED_R8,         /*                               RRRR RRRR */
 228    MESA_FORMAT_SIGNED_RG88_REV,   /*                     GGGG GGGG RRRR RRRR */
 229    MESA_FORMAT_SIGNED_RGBX8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 230    MESA_FORMAT_SIGNED_RGBA8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 231    MESA_FORMAT_SIGNED_RGBA8888_REV,/*AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 232    MESA_FORMAT_SIGNED_R16,        /*                     RRRR RRRR RRRR RRRR */
 233    MESA_FORMAT_SIGNED_GR1616,     /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
 234    MESA_FORMAT_SIGNED_RGB_16,     /* ushort[0]=R, ushort[1]=G, ushort[2]=B */
 235    MESA_FORMAT_SIGNED_RGBA_16,    /* ... */
 236    MESA_FORMAT_RGBA_16,           /* ... */
 237    /*@}*/
 238
 239    /*@{*/
 240    MESA_FORMAT_RED_RGTC1,
 241    MESA_FORMAT_SIGNED_RED_RGTC1,
 242    MESA_FORMAT_RG_RGTC2,
 243    MESA_FORMAT_SIGNED_RG_RGTC2,
 244    /*@}*/
 245
 246    /*@{*/
 247    MESA_FORMAT_L_LATC1,
 248    MESA_FORMAT_SIGNED_L_LATC1,
 249    MESA_FORMAT_LA_LATC2,
 250    MESA_FORMAT_SIGNED_LA_LATC2,
 251    /*@}*/
 252
 253    MESA_FORMAT_ETC1_RGB8,
 254
 255    MESA_FORMAT_SIGNED_A8,         /*                               AAAA AAAA */
 256    MESA_FORMAT_SIGNED_L8,         /*                               LLLL LLLL */
 257    MESA_FORMAT_SIGNED_AL88,       /*                     AAAA AAAA LLLL LLLL */
 258    MESA_FORMAT_SIGNED_I8,         /*                               IIII IIII */
 259    MESA_FORMAT_SIGNED_A16,        /*                     AAAA AAAA AAAA AAAA */
 260    MESA_FORMAT_SIGNED_L16,        /*                     LLLL LLLL LLLL LLLL */
 261    MESA_FORMAT_SIGNED_AL1616,     /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
 262    MESA_FORMAT_SIGNED_I16,        /*                     IIII IIII IIII IIII */
 263
 264    MESA_FORMAT_RGB9_E5_FLOAT,
 265    MESA_FORMAT_R11_G11_B10_FLOAT,
 266
 267    MESA_FORMAT_Z32_FLOAT,
 268    MESA_FORMAT_Z32_FLOAT_X24S8,
 269
 270    MESA_FORMAT_ARGB2101010_UINT,
 271
 272    MESA_FORMAT_COUNT
 273 } gl_format;
 274
 275
 276 extern const char *
 277 _mesa_get_format_name(gl_format format);
 278
 279 extern GLint
 280 _mesa_get_format_bytes(gl_format format);
 281
 282 extern GLint
 283 _mesa_get_format_bits(gl_format format, GLenum pname);
 284
 285 extern GLenum
 286 _mesa_get_format_datatype(gl_format format);
 287
 288 extern GLenum
 289 _mesa_get_format_base_format(gl_format format);
 290
 291 extern void
 292 _mesa_get_format_block_size(gl_format format, GLuint *bw, GLuint *bh);
 293
 294 extern GLboolean
 295 _mesa_is_format_compressed(gl_format format);
 296
 297 extern GLboolean
 298 _mesa_is_format_packed_depth_stencil(gl_format format);
 299
 300 extern GLboolean
 301 _mesa_is_format_integer_color(gl_format format);
 302
 303 extern GLenum
 304 _mesa_get_format_color_encoding(gl_format format);
 305
 306 extern GLuint
 307 _mesa_format_image_size(gl_format format, GLsizei width,
 308                         GLsizei height, GLsizei depth);
 309
 310 extern uint64_t
 311 _mesa_format_image_size64(gl_format format, GLsizei width,
 312                           GLsizei height, GLsizei depth);
 313
 314 extern GLint
 315 _mesa_format_row_stride(gl_format format, GLsizei width);
 316
 317 extern void
 318 _mesa_format_to_type_and_comps(gl_format format,
 319                                GLenum *datatype, GLuint *comps);
 320
 321 extern void
 322 _mesa_test_formats(void);
 323
 324 extern gl_format
 325 _mesa_get_srgb_format_linear(gl_format format);
 326
 327 extern gl_format
 328 _mesa_get_uncompressed_format(gl_format format);
 329
 330 extern GLuint
 331 _mesa_format_num_components(gl_format format);
 332
 333 GLboolean
 334 _mesa_format_matches_format_and_type(gl_format gl_format,
 335                                      GLenum format, GLenum type);
 336
 337
 338 #ifdef __cplusplus
 339 }
 340 #endif
 341
 342 #endif /* FORMATS_H */