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 "main/mtypes.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_RGB888,          /*           RRRR RRRR GGGG GGGG BBBB BBBB */
  58    MESA_FORMAT_BGR888,          /*           BBBB BBBB GGGG GGGG RRRR RRRR */
  59    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
  60    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
  61    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
  62    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
  63    MESA_FORMAT_RGBA5551,        /*                     RRRR RGGG GGBB BBBA */
  64    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
  65    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
  66    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
  67    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
  68    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
  69    MESA_FORMAT_A8,              /*                               AAAA AAAA */
  70    MESA_FORMAT_L8,              /*                               LLLL LLLL */
  71    MESA_FORMAT_I8,              /*                               IIII IIII */
  72    MESA_FORMAT_CI8,             /*                               CCCC CCCC */
  73    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
  74    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
  75    MESA_FORMAT_Z24_S8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
  76    MESA_FORMAT_S8_Z24,          /* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  77    MESA_FORMAT_Z16,             /*                     ZZZZ ZZZZ ZZZZ ZZZZ */
  78    MESA_FORMAT_Z32,             /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  79    MESA_FORMAT_S8,              /*                               SSSS SSSS */
  80    /*@}*/
  81
  82    /**
  83     * \name 8-bit/channel sRGB formats
  84     */
  85    /*@{*/
  86    MESA_FORMAT_SRGB8,
  87    MESA_FORMAT_SRGBA8,
  88    MESA_FORMAT_SARGB8,
  89    MESA_FORMAT_SL8,
  90    MESA_FORMAT_SLA8,
  91    MESA_FORMAT_SRGB_DXT1,
  92    MESA_FORMAT_SRGBA_DXT1,
  93    MESA_FORMAT_SRGBA_DXT3,
  94    MESA_FORMAT_SRGBA_DXT5,
  95    /*@}*/
  96
  97    /**
  98     * \name Compressed texture formats.
  99     */
 100    /*@{*/
 101    MESA_FORMAT_RGB_FXT1,
 102    MESA_FORMAT_RGBA_FXT1,
 103    MESA_FORMAT_RGB_DXT1,
 104    MESA_FORMAT_RGBA_DXT1,
 105    MESA_FORMAT_RGBA_DXT3,
 106    MESA_FORMAT_RGBA_DXT5,
 107    /*@}*/
 108
 109    /**
 110     * \name Floating point texture formats.
 111     */
 112    /*@{*/
 113    MESA_FORMAT_RGBA_FLOAT32,
 114    MESA_FORMAT_RGBA_FLOAT16,
 115    MESA_FORMAT_RGB_FLOAT32,
 116    MESA_FORMAT_RGB_FLOAT16,
 117    MESA_FORMAT_ALPHA_FLOAT32,
 118    MESA_FORMAT_ALPHA_FLOAT16,
 119    MESA_FORMAT_LUMINANCE_FLOAT32,
 120    MESA_FORMAT_LUMINANCE_FLOAT16,
 121    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT32,
 122    MESA_FORMAT_LUMINANCE_ALPHA_FLOAT16,
 123    MESA_FORMAT_INTENSITY_FLOAT32,
 124    MESA_FORMAT_INTENSITY_FLOAT16,
 125    /*@}*/
 126
 127    /**
 128     * \name Signed fixed point texture formats.
 129     */
 130    /*@{*/
 131    MESA_FORMAT_DUDV8,
 132    MESA_FORMAT_SIGNED_RGBA8888,
 133    MESA_FORMAT_SIGNED_RGBA8888_REV,
 134    /*@}*/
 135
 136    MESA_FORMAT_COUNT,
 137 } gl_format;
 138
 139
 140 /**
 141  * Information about texture formats.
 142  */
 143 struct gl_format_info
 144 {
 145    gl_format Name;
 146
 147    /**
 148     * Base format is one of GL_RGB, GL_RGBA, GL_ALPHA, GL_LUMINANCE,
 149     * GL_LUMINANCE_ALPHA, GL_INTENSITY, GL_COLOR_INDEX, GL_DEPTH_COMPONENT.
 150     */
 151    GLenum BaseFormat;
 152
 153    /**
 154     * Logical data type: one of  GL_UNSIGNED_NORMALIZED, GL_SIGNED_NORMALED,
 155     * GL_UNSIGNED_INT, GL_SIGNED_INT, GL_FLOAT.
 156     */
 157    GLenum DataType;
 158
 159    GLubyte RedBits;
 160    GLubyte GreenBits;
 161    GLubyte BlueBits;
 162    GLubyte AlphaBits;
 163    GLubyte LuminanceBits;
 164    GLubyte IntensityBits;
 165    GLubyte IndexBits;
 166    GLubyte DepthBits;
 167    GLubyte StencilBits;
 168
 169    /**
 170     * To describe compressed formats.  If not compressed, Width=Height=1.
 171     */
 172    GLubyte BlockWidth, BlockHeight;
 173    GLubyte BytesPerBlock;
 174 };
 175
 176
 177
 178 extern GLuint
 179 _mesa_get_format_bytes(gl_format format);
 180
 181 extern GLint
 182 _mesa_get_format_bits(gl_format format, GLenum pname);
 183
 184 extern GLenum
 185 _mesa_get_format_datatype(gl_format format);
 186
 187 extern GLenum
 188 _mesa_get_format_base_format(gl_format format);
 189
 190 extern GLboolean
 191 _mesa_is_format_compressed(gl_format format);
 192
 193 extern void
 194 _mesa_format_to_type_and_comps2(gl_format format,
 195                                 GLenum *datatype, GLuint *comps);
 196
 197 extern GLuint
 198 _mesa_format_image_size(gl_format format, GLsizei width,
 199                         GLsizei height, GLsizei depth);
 200
 201 extern GLint
 202 _mesa_format_row_stride(gl_format format, GLsizei width);
 203
 204
 205 extern void
 206 _mesa_test_formats(void);
 207
 208 #endif /* FORMATS_H */