dll/opengl/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  * Max number of bytes for any non-compressed pixel format below, or for
  51  * intermediate pixel storage in Mesa.  This should never be less than
  52  * 16.  Maybe 32 someday?
  53  */
  54 #define MAX_PIXEL_BYTES 16
  55
  56
  57 /**
  58  * Mesa texture/renderbuffer image formats.
  59  */
  60 typedef enum
  61 {
  62    MESA_FORMAT_NONE = 0,
  63
  64    /**
  65     * \name Basic hardware formats
  66     */
  67    /*@{*/
  68                                 /* msb <------ TEXEL BITS -----------> lsb */
  69                                 /* ---- ---- ---- ---- ---- ---- ---- ---- */
  70    MESA_FORMAT_RGBA8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
  71    MESA_FORMAT_RGBA8888_REV,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
  72    MESA_FORMAT_ARGB8888,        /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
  73    MESA_FORMAT_ARGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
  74    MESA_FORMAT_RGBX8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB XXXX XXXX */
  75    MESA_FORMAT_RGBX8888_REV,    /* xxxx xxxx BBBB BBBB GGGG GGGG RRRR RRRR */
  76    MESA_FORMAT_XRGB8888,        /* xxxx xxxx RRRR RRRR GGGG GGGG BBBB BBBB */
  77    MESA_FORMAT_XRGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR xxxx xxxx */
  78    MESA_FORMAT_RGB888,          /*           RRRR RRRR GGGG GGGG BBBB BBBB */
  79    MESA_FORMAT_BGR888,          /*           BBBB BBBB GGGG GGGG RRRR RRRR */
  80    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
  81    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
  82    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
  83    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
  84    MESA_FORMAT_RGBA5551,        /*                     RRRR RGGG GGBB BBBA */
  85    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
  86    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
  87    MESA_FORMAT_AL44,            /*                               AAAA LLLL */
  88    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
  89    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
  90    MESA_FORMAT_AL1616,          /* AAAA AAAA AAAA AAAA LLLL LLLL LLLL LLLL */
  91    MESA_FORMAT_AL1616_REV,      /* LLLL LLLL LLLL LLLL AAAA AAAA AAAA AAAA */
  92    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
  93    MESA_FORMAT_A8,              /*                               AAAA AAAA */
  94    MESA_FORMAT_A16,             /*                     AAAA AAAA AAAA AAAA */
  95    MESA_FORMAT_L8,              /*                               LLLL LLLL */
  96    MESA_FORMAT_L16,             /*                     LLLL LLLL LLLL LLLL */
  97    MESA_FORMAT_I8,              /*                               IIII IIII */
  98    MESA_FORMAT_I16,             /*                     IIII IIII IIII IIII */
  99    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
 100    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
 101    MESA_FORMAT_Z16,             /*                     ZZZZ ZZZZ ZZZZ ZZZZ */
 102    MESA_FORMAT_X8_Z24,          /* xxxx xxxx ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 103    MESA_FORMAT_Z24_X8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ xxxx xxxx */
 104    MESA_FORMAT_Z32,             /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
 105    MESA_FORMAT_S8,              /*                               SSSS SSSS */
 106    /*@}*/
 107
 108    /**
 109     * \name Non-normalized signed integer formats.
 110     * XXX Note: these are just stand-ins for some better hardware
 111     * formats TBD such as BGRA or ARGB.
 112     */
 113    MESA_FORMAT_ALPHA_UINT8,
 114    MESA_FORMAT_ALPHA_UINT16,
 115    MESA_FORMAT_ALPHA_UINT32,
 116    MESA_FORMAT_ALPHA_INT8,
 117    MESA_FORMAT_ALPHA_INT16,
 118    MESA_FORMAT_ALPHA_INT32,
 119
 120    MESA_FORMAT_INTENSITY_UINT8,
 121    MESA_FORMAT_INTENSITY_UINT16,
 122    MESA_FORMAT_INTENSITY_UINT32,
 123    MESA_FORMAT_INTENSITY_INT8,
 124    MESA_FORMAT_INTENSITY_INT16,
 125    MESA_FORMAT_INTENSITY_INT32,
 126
 127    MESA_FORMAT_LUMINANCE_UINT8,
 128    MESA_FORMAT_LUMINANCE_UINT16,
 129    MESA_FORMAT_LUMINANCE_UINT32,
 130    MESA_FORMAT_LUMINANCE_INT8,
 131    MESA_FORMAT_LUMINANCE_INT16,
 132    MESA_FORMAT_LUMINANCE_INT32,
 133
 134    MESA_FORMAT_LUMINANCE_ALPHA_UINT8,
 135    MESA_FORMAT_LUMINANCE_ALPHA_UINT16,
 136    MESA_FORMAT_LUMINANCE_ALPHA_UINT32,
 137    MESA_FORMAT_LUMINANCE_ALPHA_INT8,
 138    MESA_FORMAT_LUMINANCE_ALPHA_INT16,
 139    MESA_FORMAT_LUMINANCE_ALPHA_INT32,
 140
 141    MESA_FORMAT_RGB_INT8,
 142    MESA_FORMAT_RGBA_INT8,
 143    MESA_FORMAT_RGB_INT16,
 144    MESA_FORMAT_RGBA_INT16,
 145    MESA_FORMAT_RGB_INT32,
 146    MESA_FORMAT_RGBA_INT32,
 147
 148    /**
 149     * \name Non-normalized unsigned integer formats.
 150     */
 151    MESA_FORMAT_RGB_UINT8,
 152    MESA_FORMAT_RGBA_UINT8,
 153    MESA_FORMAT_RGB_UINT16,
 154    MESA_FORMAT_RGBA_UINT16,
 155    MESA_FORMAT_RGB_UINT32,
 156    MESA_FORMAT_RGBA_UINT32,
 157
 158                                   /* msb <------ TEXEL BITS -----------> lsb */
 159                                   /* ---- ---- ---- ---- ---- ---- ---- ---- */
 160    /**
 161     * \name Signed fixed point texture formats.
 162     */
 163    /*@{*/
 164    MESA_FORMAT_SIGNED_RGBA_16,    /* ... */
 165    MESA_FORMAT_RGBA_16,           /* ... */
 166    /*@}*/
 167
 168    MESA_FORMAT_COUNT
 169 } gl_format;
 170
 171
 172 extern const char *
 173 _mesa_get_format_name(gl_format format);
 174
 175 extern GLint
 176 _mesa_get_format_bytes(gl_format format);
 177
 178 extern GLint
 179 _mesa_get_format_bits(gl_format format, GLenum pname);
 180
 181 extern GLuint
 182 _mesa_get_format_max_bits(gl_format format);
 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 void
 191 _mesa_get_format_block_size(gl_format format, GLuint *bw, GLuint *bh);
 192
 193 extern GLboolean
 194 _mesa_is_format_integer_color(gl_format format);
 195
 196 extern GLuint
 197 _mesa_format_image_size(gl_format format, GLsizei width,
 198                         GLsizei height, GLsizei depth);
 199
 200 extern uint64_t
 201 _mesa_format_image_size64(gl_format format, GLsizei width,
 202                           GLsizei height, GLsizei depth);
 203
 204 extern GLint
 205 _mesa_format_row_stride(gl_format format, GLsizei width);
 206
 207 extern void
 208 _mesa_format_to_type_and_comps(gl_format format,
 209                                GLenum *datatype, GLuint *comps);
 210
 211 extern void
 212 _mesa_test_formats(void);
 213
 214 extern GLuint
 215 _mesa_format_num_components(gl_format format);
 216
 217 GLboolean
 218 _mesa_format_matches_format_and_type(gl_format gl_format,
 219                                      GLenum format, GLenum type);
 220
 221
 222 #ifdef __cplusplus
 223 }
 224 #endif
 225
 226 #endif /* FORMATS_H */