src/mesa/main/texformat.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.1
   4  *
   5  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \file texformat.h
  28  * Texture formats definitions.
  29  *
  30  * \author Gareth Hughes
  31  */
  32
  33
  34 #ifndef TEXFORMAT_H
  35 #define TEXFORMAT_H
  36
  37
  38 #include "mtypes.h"
  39
  40
  41 /**
  42  * Mesa internal texture image formats.
  43  * All texture images are stored in one of these formats.
  44  *
  45  * NOTE: when you add a new format, be sure to update the do_row()
  46  * function in texstore.c used for auto mipmap generation.
  47  */
  48 enum _format {
  49    /**
  50     * \name Hardware-friendly formats.
  51     *
  52     * Drivers can override the default formats and convert texture images to
  53     * one of these as required.  The driver's
  54     * dd_function_table::ChooseTextureFormat function will choose one of these
  55     * formats.
  56     *
  57     * \note In the default case, some of these formats will be duplicates of
  58     * the generic formats listed below.  However, these formats guarantee their
  59     * internal component sizes, while GLchan may vary between GLubyte, GLushort
  60     * and GLfloat.
  61     */
  62    /*@{*/
  63                                 /* msb <------ TEXEL BITS -----------> lsb */
  64                                 /* ---- ---- ---- ---- ---- ---- ---- ---- */
  65    MESA_FORMAT_RGBA8888,        /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
  66    MESA_FORMAT_RGBA8888_REV,    /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
  67    MESA_FORMAT_ARGB8888,        /* AAAA AAAA RRRR RRRR GGGG GGGG BBBB BBBB */
  68    MESA_FORMAT_ARGB8888_REV,    /* BBBB BBBB GGGG GGGG RRRR RRRR AAAA AAAA */
  69    MESA_FORMAT_RGB888,          /*           RRRR RRRR GGGG GGGG BBBB BBBB */
  70    MESA_FORMAT_BGR888,          /*           BBBB BBBB GGGG GGGG RRRR RRRR */
  71    MESA_FORMAT_RGB565,          /*                     RRRR RGGG GGGB BBBB */
  72    MESA_FORMAT_RGB565_REV,      /*                     GGGB BBBB RRRR RGGG */
  73    MESA_FORMAT_ARGB4444,        /*                     AAAA RRRR GGGG BBBB */
  74    MESA_FORMAT_ARGB4444_REV,    /*                     GGGG BBBB AAAA RRRR */
  75    MESA_FORMAT_ARGB1555,        /*                     ARRR RRGG GGGB BBBB */
  76    MESA_FORMAT_ARGB1555_REV,    /*                     GGGB BBBB ARRR RRGG */
  77    MESA_FORMAT_AL88,            /*                     AAAA AAAA LLLL LLLL */
  78    MESA_FORMAT_AL88_REV,        /*                     LLLL LLLL AAAA AAAA */
  79    MESA_FORMAT_RGB332,          /*                               RRRG GGBB */
  80    MESA_FORMAT_A8,              /*                               AAAA AAAA */
  81    MESA_FORMAT_L8,              /*                               LLLL LLLL */
  82    MESA_FORMAT_I8,              /*                               IIII IIII */
  83    MESA_FORMAT_CI8,             /*                               CCCC CCCC */
  84    MESA_FORMAT_YCBCR,           /*                     YYYY YYYY UorV UorV */
  85    MESA_FORMAT_YCBCR_REV,       /*                     UorV UorV YYYY YYYY */
  86    MESA_FORMAT_Z24_S8,          /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ SSSS SSSS */
  87    MESA_FORMAT_S8_Z24,          /* SSSS SSSS ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  88    MESA_FORMAT_Z16,             /*                     ZZZZ ZZZZ ZZZZ ZZZZ */
  89    MESA_FORMAT_Z32,             /* ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ ZZZZ */
  90    /*@}*/
  91
  92 #if FEATURE_EXT_texture_sRGB
  93    /**
  94     * \name 8-bit/channel sRGB formats
  95     */
  96    /*@{*/
  97    MESA_FORMAT_SRGB8,
  98    MESA_FORMAT_SRGBA8,
  99    MESA_FORMAT_SL8,
 100    MESA_FORMAT_SLA8,
 101    MESA_FORMAT_SRGB_DXT1,
 102    /*@}*/
 103 #endif
 104
 105    /**
 106     * \name Compressed texture formats.
 107     */
 108    /*@{*/
 109    MESA_FORMAT_RGB_FXT1,
 110    MESA_FORMAT_RGBA_FXT1,
 111    MESA_FORMAT_RGB_DXT1,
 112    MESA_FORMAT_RGBA_DXT1,
 113    MESA_FORMAT_RGBA_DXT3,
 114    MESA_FORMAT_RGBA_DXT5,
 115    /*@}*/
 116
 117    /**
 118     * \name Generic GLchan-based formats.
 119     *
 120     * Software-oriented texture formats.  Texels are arrays of GLchan
 121     * values so there are no byte order issues.
 122     *
 123     * \note Because these are based on the GLchan data type, one cannot assume
 124     * 8 bits per channel with these formats.  If you require GLubyte channels,
 125     * use one of the hardware formats above.
 126     */
 127    /*@{*/
 128    MESA_FORMAT_RGBA,
 129    MESA_FORMAT_RGB,
 130    MESA_FORMAT_ALPHA,
 131    MESA_FORMAT_LUMINANCE,
 132    MESA_FORMAT_LUMINANCE_ALPHA,
 133    MESA_FORMAT_INTENSITY,
 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    /*@}*/
 153 };
 154
 155
 156 /** GLchan-valued formats */
 157 /*@{*/
 158 extern const struct gl_texture_format _mesa_texformat_rgba;
 159 extern const struct gl_texture_format _mesa_texformat_rgb;
 160 extern const struct gl_texture_format _mesa_texformat_alpha;
 161 extern const struct gl_texture_format _mesa_texformat_luminance;
 162 extern const struct gl_texture_format _mesa_texformat_luminance_alpha;
 163 extern const struct gl_texture_format _mesa_texformat_intensity;
 164 /*@}*/
 165
 166 #if FEATURE_EXT_texture_sRGB
 167 /** sRGB (nonlinear) formats */
 168 /*@{*/
 169 extern const struct gl_texture_format _mesa_texformat_srgb8;
 170 extern const struct gl_texture_format _mesa_texformat_srgba8;
 171 extern const struct gl_texture_format _mesa_texformat_sl8;
 172 extern const struct gl_texture_format _mesa_texformat_sla8;
 173 extern const struct gl_texture_format _mesa_texformat_srgb_dxt1;
 174 /*@}*/
 175 #endif
 176
 177 /** Floating point texture formats */
 178 /*@{*/
 179 extern const struct gl_texture_format _mesa_texformat_rgba_float32;
 180 extern const struct gl_texture_format _mesa_texformat_rgba_float16;
 181 extern const struct gl_texture_format _mesa_texformat_rgb_float32;
 182 extern const struct gl_texture_format _mesa_texformat_rgb_float16;
 183 extern const struct gl_texture_format _mesa_texformat_alpha_float32;
 184 extern const struct gl_texture_format _mesa_texformat_alpha_float16;
 185 extern const struct gl_texture_format _mesa_texformat_luminance_float32;
 186 extern const struct gl_texture_format _mesa_texformat_luminance_float16;
 187 extern const struct gl_texture_format _mesa_texformat_luminance_alpha_float32;
 188 extern const struct gl_texture_format _mesa_texformat_luminance_alpha_float16;
 189 extern const struct gl_texture_format _mesa_texformat_intensity_float32;
 190 extern const struct gl_texture_format _mesa_texformat_intensity_float16;
 191 /*@}*/
 192
 193 /** \name Assorted hardware-friendly formats */
 194 /*@{*/
 195 extern const struct gl_texture_format _mesa_texformat_rgba8888;
 196 extern const struct gl_texture_format _mesa_texformat_rgba8888_rev;
 197 extern const struct gl_texture_format _mesa_texformat_argb8888;
 198 extern const struct gl_texture_format _mesa_texformat_argb8888_rev;
 199 extern const struct gl_texture_format _mesa_texformat_rgb888;
 200 extern const struct gl_texture_format _mesa_texformat_bgr888;
 201 extern const struct gl_texture_format _mesa_texformat_rgb565;
 202 extern const struct gl_texture_format _mesa_texformat_rgb565_rev;
 203 extern const struct gl_texture_format _mesa_texformat_argb4444;
 204 extern const struct gl_texture_format _mesa_texformat_argb4444_rev;
 205 extern const struct gl_texture_format _mesa_texformat_argb1555;
 206 extern const struct gl_texture_format _mesa_texformat_argb1555_rev;
 207 extern const struct gl_texture_format _mesa_texformat_al88;
 208 extern const struct gl_texture_format _mesa_texformat_al88_rev;
 209 extern const struct gl_texture_format _mesa_texformat_rgb332;
 210 extern const struct gl_texture_format _mesa_texformat_a8;
 211 extern const struct gl_texture_format _mesa_texformat_l8;
 212 extern const struct gl_texture_format _mesa_texformat_i8;
 213 extern const struct gl_texture_format _mesa_texformat_ci8;
 214 extern const struct gl_texture_format _mesa_texformat_z24_s8;
 215 extern const struct gl_texture_format _mesa_texformat_s8_z24;
 216 extern const struct gl_texture_format _mesa_texformat_z16;
 217 extern const struct gl_texture_format _mesa_texformat_z32;
 218 /*@}*/
 219
 220 /** \name YCbCr formats */
 221 /*@{*/
 222 extern const struct gl_texture_format _mesa_texformat_ycbcr;
 223 extern const struct gl_texture_format _mesa_texformat_ycbcr_rev;
 224 /*@}*/
 225
 226 /** \name Compressed formats */
 227 /*@{*/
 228 extern const struct gl_texture_format _mesa_texformat_rgb_fxt1;
 229 extern const struct gl_texture_format _mesa_texformat_rgba_fxt1;
 230 extern const struct gl_texture_format _mesa_texformat_rgb_dxt1;
 231 extern const struct gl_texture_format _mesa_texformat_rgba_dxt1;
 232 extern const struct gl_texture_format _mesa_texformat_rgba_dxt3;
 233 extern const struct gl_texture_format _mesa_texformat_rgba_dxt5;
 234 /*@}*/
 235
 236 /** \name The null format */
 237 /*@{*/
 238 extern const struct gl_texture_format _mesa_null_texformat;
 239 /*@}*/
 240
 241
 242 extern const struct gl_texture_format *
 243 _mesa_choose_tex_format( GLcontext *ctx, GLint internalFormat,
 244                          GLenum format, GLenum type );
 245
 246
 247 extern void
 248 _mesa_format_to_type_and_comps(const struct gl_texture_format *format,
 249                                GLenum *datatype, GLuint *comps);
 250
 251
 252 #endif