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
  40 /**
  41  * Mesa texture/renderbuffer image formats.
  42  */
  43 typedef enum
  44 {
  45    MESA_FORMAT_NONE = 0,
  46
  47    /**
  48     * \name Basic hardware formats
  49     */
  50    /*@{*/
  51                                 /* msb <------ TEXEL BITS -----------> lsb */
  52                                 /* ---- ---- ---- ---- ---- ---- ---- ---- */
  53    MESA_FORMAT_RGBA8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
  54    MESA_FORMAT_RGBA8888_REV,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
  55    MESA_FORMAT_ARGB8888,        /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
  56    MESA_FORMAT_ARGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
  57    MESA_FORMAT_XRGB8888,        /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
  58    MESA_FORMAT_XRGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
  59    MESA_FORMAT_RGB888,          /*           RRRR RRRR GGGG GGGG BBBB BBBB */
  60    MESA_FORMAT_BGR888,          /*           BBBB BBBB GGGG GGGG RRRR RRRR */
  61    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
  62    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
  63    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
  64    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
  65    MESA_FORMAT_RGBA5551,        /*                     RRRR RGGG GGBB BBBA */
  66    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
  67    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
  68    MESA_FORMAT_AL44,            /*                               AAAA LLLL */
  69    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
  70    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
  71    MESA_FORMAT_AL1616,          /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
  72    MESA_FORMAT_AL1616_REV,      /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
  73    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
  74    MESA_FORMAT_A8,              /*                               AAAA AAAA */
  75    MESA_FORMAT_A16,             /*                     AAAA AAAA AAAA AAAA */
  76    MESA_FORMAT_L8,              /*                               LLLL LLLL */
  77    MESA_FORMAT_L16,             /*                     LLLL LLLL LLLL LLLL */
  78    MESA_FORMAT_I8,              /*                               IIII IIII */
  79    MESA_FORMAT_I16,             /*                     IIII IIII IIII IIII */
  80    MESA_FORMAT_CI8,             /*                               CCCC CCCC */
  81    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
  82    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
  83    MESA_FORMAT_R8,              /*                               RRRR RRRR */
  84    MESA_FORMAT_RG88,            /*                     RRRR RRRR GGGG GGGG */
  85    MESA_FORMAT_RG88_REV,        /*                     GGGG GGGG RRRR RRRR */
  86    MESA_FORMAT_R16,             /*                     RRRR RRRR RRRR RRRR */
  87    MESA_FORMAT_RG1616,          /* RRRR RRRR RRRR RRRR GGGG GGGG GGGG GGGG */
  88    MESA_FORMAT_RG1616_REV,      /* GGGG GGGG GGGG GGGG RRRR RRRR RRRR RRRR */
  89    MESA_FORMAT_ARGB2101010,     /* AARR RRRR RRRR GGGG GGGG GGBB BBBB BBBB */
  90    MESA_FORMAT_Z24_S8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
  91    MESA_FORMAT_S8_Z24,          /* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  92    MESA_FORMAT_Z16,             /*                     ZZZZ ZZZZ ZZZZ ZZZZ */
  93    MESA_FORMAT_X8_Z24,          /* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  94    MESA_FORMAT_Z24_X8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
  95    MESA_FORMAT_Z32,             /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  96    MESA_FORMAT_S8,              /*                               SSSS SSSS */
  97    /*@}*/
  98
  99    /**
 100     * \name 8-bit/channel sRGB formats
 101     */
 102    /*@{*/
 103    MESA_FORMAT_SRGB8,
 104    MESA_FORMAT_SRGBA8,
 105    MESA_FORMAT_SARGB8,
 106    MESA_FORMAT_SL8,
 107    MESA_FORMAT_SLA8,
 108    MESA_FORMAT_SRGB_DXT1,
 109    MESA_FORMAT_SRGBA_DXT1,
 110    MESA_FORMAT_SRGBA_DXT3,
 111    MESA_FORMAT_SRGBA_DXT5,
 112    /*@}*/
 113
 114    /**
 115     * \name Compressed texture formats.
 116     */
 117    /*@{*/
 118    MESA_FORMAT_RGB_FXT1,
 119    MESA_FORMAT_RGBA_FXT1,
 120    MESA_FORMAT_RGB_DXT1,
 121    MESA_FORMAT_RGBA_DXT1,
 122    MESA_FORMAT_RGBA_DXT3,
 123    MESA_FORMAT_RGBA_DXT5,
 124    /*@}*/
 125
 126    /**
 127     * \name Floating point texture formats.
 128     */
 129    /*@{*/
 130    MESA_FORMAT_RGBA_FLOAT32,
 131    MESA_FORMAT_RGBA_FLOAT16,
 132    MESA_FORMAT_RGB_FLOAT32,
 133    MESA_FORMAT_RGB_FLOAT16,
 134    MESA_FORMAT_ALPHA_FLOAT32,
 135    MESA_FORMAT_ALPHA_FLOAT16,
 136    MESA_FORMAT_LUMINANCE_FLOAT32,
 137    MESA_FORMAT_LUMINANCE_FLOAT16,
 138    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT32,
 139    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT16,
 140    MESA_FORMAT_INTENSITY_FLOAT32,
 141    MESA_FORMAT_INTENSITY_FLOAT16,
 142    /*@}*/
 143
 144    /**
 145     * \name Non-normalized signed integer formats.
 146     * XXX Note: these are just stand-ins for some better hardware
 147     * formats TBD such as BGRA or ARGB.
 148     */
 149    MESA_FORMAT_RGBA_INT8,
 150    MESA_FORMAT_RGBA_INT16,
 151    MESA_FORMAT_RGBA_INT32,
 152
 153    /**
 154     * \name Non-normalized unsigned integer formats.
 155     */
 156    MESA_FORMAT_RGBA_UINT8,
 157    MESA_FORMAT_RGBA_UINT16,
 158    MESA_FORMAT_RGBA_UINT32,
 159
 160                                   /* msb <------ TEXEL BITS -----------> lsb */
 161                                   /* ---- ---- ---- ---- ---- ---- ---- ---- */
 162    /**
 163     * \name Signed fixed point texture formats.
 164     */
 165    /*@{*/
 166    MESA_FORMAT_DUDV8,             /*                     DUDU DUDU DVDV DVDV */
 167    MESA_FORMAT_SIGNED_R8,         /*                               RRRR RRRR */
 168    MESA_FORMAT_SIGNED_RG88,       /*                     RRRR RRRR GGGG GGGG */
 169    MESA_FORMAT_SIGNED_RGBX8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB xxxx xxxx */
 170    MESA_FORMAT_SIGNED_RGBA8888,   /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
 171    MESA_FORMAT_SIGNED_RGBA8888_REV,/*AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
 172    MESA_FORMAT_SIGNED_R_16,       /* ushort[0]=R */
 173    MESA_FORMAT_SIGNED_RG_16,      /* ushort[0]=R, ushort[1]=G */
 174    MESA_FORMAT_SIGNED_RGB_16,     /* ushort[0]=R, ushort[1]=G, ushort[2]=B */
 175    MESA_FORMAT_SIGNED_RGBA_16,    /* ... */
 176    MESA_FORMAT_RGBA_16,           /* ... */
 177    /*@}*/
 178
 179    MESA_FORMAT_COUNT
 180 } gl_format;
 181
 182
 183 extern const char *
 184 _mesa_get_format_name(gl_format format);
 185
 186 extern GLuint
 187 _mesa_get_format_bytes(gl_format format);
 188
 189 extern GLint
 190 _mesa_get_format_bits(gl_format format, GLenum pname);
 191
 192 extern GLenum
 193 _mesa_get_format_datatype(gl_format format);
 194
 195 extern GLenum
 196 _mesa_get_format_base_format(gl_format format);
 197
 198 extern void
 199 _mesa_get_format_block_size(gl_format format, GLuint *bw, GLuint *bh);
 200
 201 extern GLboolean
 202 _mesa_is_format_compressed(gl_format format);
 203
 204 extern GLboolean
 205 _mesa_is_format_packed_depth_stencil(gl_format format);
 206
 207 extern GLboolean
 208 _mesa_is_format_integer_color(gl_format format);
 209
 210 extern GLenum
 211 _mesa_get_format_color_encoding(gl_format format);
 212
 213 extern GLuint
 214 _mesa_format_image_size(gl_format format, GLsizei width,
 215                         GLsizei height, GLsizei depth);
 216
 217 extern uint64_t
 218 _mesa_format_image_size64(gl_format format, GLsizei width,
 219                           GLsizei height, GLsizei depth);
 220
 221 extern GLint
 222 _mesa_format_row_stride(gl_format format, GLsizei width);
 223
 224 extern void
 225 _mesa_format_to_type_and_comps(gl_format format,
 226                                GLenum *datatype, GLuint *comps);
 227
 228 extern void
 229 _mesa_test_formats(void);
 230
 231 #endif /* FORMATS_H */