-/* $Id: texformat.h,v 1.12 2002/09/27 02:45:38 brianp Exp $ */
+/**
+ * \file texformat.h
+ * Texture formats definitions.
+ *
+ * \author Gareth Hughes
+ */
/*
* Mesa 3-D graphics library
- * Version: 4.1
+ * Version: 5.1
*
- * Copyright (C) 1999-2002 Brian Paul All Rights Reserved.
+ * Copyright (C) 1999-2003 Brian Paul All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- *
- * Author:
- * Gareth Hughes <gareth@valinux.com>
*/
+
#ifndef TEXFORMAT_H
#define TEXFORMAT_H
#include "mtypes.h"
-/*
- * The Mesa internal texture image types.
+/**
+ * Mesa internal texture image types.
+ *
* All texture images must be stored in one of these formats.
+ *
+ * NOTE: when you add a new format, be sure to update the do_row()
+ * function in texstore.c used for auto mipmap generation.
*/
enum _format {
- /* Hardware-friendly formats. Drivers can override the default
- * formats and convert texture images to one of these as required.
- * The driver's ChooseTextureFormat() function will choose one of
- * these formats.
- * These formats are all little endian, as shown below. They will be
- * most useful for x86-based PC graphics card drivers.
+ /**
+ * \name Hardware-friendly formats.
+ *
+ * Drivers can override the default formats and convert texture images to
+ * one of these as required. The driver's
+ * dd_function_table::ChooseTextureFormat function will choose one of these
+ * formats. These formats are all little endian, as shown below. They will
+ * be most useful for x86-based PC graphics card drivers.
*
- * NOTE: In the default case, some of these formats will be
- * duplicates of the generic formats listed below. However, these
- * formats guarantee their internal component sizes, while GLchan may
- * vary betwen GLubyte, GLushort and GLfloat.
+ * \note In the default case, some of these formats will be duplicates of
+ * the generic formats listed below. However, these formats guarantee their
+ * internal component sizes, while GLchan may vary between GLubyte, GLushort
+ * and GLfloat.
*/
+ /*@{*/
/* msb <------ TEXEL BITS -----------> lsb */
/* ---- ---- ---- ---- ---- ---- ---- ---- */
MESA_FORMAT_RGBA8888, /* RRRR RRRR GGGG GGGG BBBB BBBB AAAA AAAA */
MESA_FORMAT_CI8, /* CCCC CCCC */
MESA_FORMAT_YCBCR, /* YYYY YYYY UorV UorV */
MESA_FORMAT_YCBCR_REV, /* UorV UorV YYYY YYYY */
+ /*@}*/
-#if 0
- /* upcoming little-endian formats: */
+ /**
+ * \name Compressed texture formats.
+ */
+ /*@{*/
+ MESA_FORMAT_RGB_FXT1,
+ MESA_FORMAT_RGBA_FXT1,
+ MESA_FORMAT_RGB_DXT1,
+ MESA_FORMAT_RGBA_DXT1,
+ MESA_FORMAT_RGBA_DXT3,
+ MESA_FORMAT_RGBA_DXT5,
+ /*@}*/
+#if 0
+ /**
+ * \name Upcoming little-endian formats
+ */
+ /*@{*/
/* msb <------ TEXEL BITS -----------> lsb */
/* ---- ---- ---- ---- ---- ---- ---- ---- */
MESA_FORMAT_ABGR8888, /* AAAA AAAA BBBB BBBB GGGG GGGG RRRR RRRR */
MESA_FORMAT_BGRA5551, /* BBBB BGGG GGRR RRRA */
MESA_FORMAT_LA88, /* LLLL LLLL AAAA AAAA */
MESA_FORMAT_BGR233, /* BBGG GRRR */
+ /*@}*/
#endif
- /* Generic GLchan-based formats. These are the default formats used
- * by the software rasterizer and, unless the driver overrides the
- * texture image functions, incoming images will be converted to one
- * of these formats. Components are arrays of GLchan values, so
- * there will be no big/little endian issues.
+ /**
+ * \name Generic GLchan-based formats.
+ *
+ * These are the default formats used by the software rasterizer and, unless
+ * the driver overrides the texture image functions, incoming images will be
+ * converted to one of these formats. Components are arrays of GLchan
+ * values, so there will be no big/little endian issues.
*
- * NOTE: Because these are based on the GLchan datatype, one cannot
- * assume 8 bits per channel with these formats. If you require
- * GLubyte channels, use one of the hardware formats above.
+ * \note Because these are based on the GLchan data type, one cannot assume
+ * 8 bits per channel with these formats. If you require GLubyte channels,
+ * use one of the hardware formats above.
*/
+ /*@{*/
MESA_FORMAT_RGBA,
MESA_FORMAT_RGB,
MESA_FORMAT_ALPHA,
MESA_FORMAT_LUMINANCE_ALPHA,
MESA_FORMAT_INTENSITY,
MESA_FORMAT_COLOR_INDEX,
- MESA_FORMAT_DEPTH_COMPONENT
+ /*@}*/
+
+ /**
+ * \name Floating point texture formats.
+ */
+ /*@{*/
+ MESA_FORMAT_DEPTH_COMPONENT,
+ MESA_FORMAT_RGBA_FLOAT32,
+ MESA_FORMAT_RGBA_FLOAT16,
+ MESA_FORMAT_RGB_FLOAT32,
+ MESA_FORMAT_RGB_FLOAT16
+ /*@}*/
};
_mesa_base_compressed_texformat(GLcontext *ctx, GLint intFormat);
-/* The default formats, GLchan per component:
- */
+/** The default formats, GLchan per component */
+/*@{*/
extern const struct gl_texture_format _mesa_texformat_rgba;
extern const struct gl_texture_format _mesa_texformat_rgb;
extern const struct gl_texture_format _mesa_texformat_alpha;
extern const struct gl_texture_format _mesa_texformat_luminance_alpha;
extern const struct gl_texture_format _mesa_texformat_intensity;
extern const struct gl_texture_format _mesa_texformat_color_index;
-extern const struct gl_texture_format _mesa_texformat_depth_component;
+/*@}*/
-/* The hardware-friendly formats:
- */
+/** Floating point texture formats */
+/*@{*/
+extern const struct gl_texture_format _mesa_texformat_depth_component;
+extern const struct gl_texture_format _mesa_texformat_rgba_float32;
+extern const struct gl_texture_format _mesa_texformat_rgba_float16;
+extern const struct gl_texture_format _mesa_texformat_rgb_float32;
+extern const struct gl_texture_format _mesa_texformat_rgb_float16;
+/*@}*/
+
+/** \name The hardware-friendly formats */
+/*@{*/
extern const struct gl_texture_format _mesa_texformat_rgba8888;
extern const struct gl_texture_format _mesa_texformat_argb8888;
extern const struct gl_texture_format _mesa_texformat_rgb888;
extern const struct gl_texture_format _mesa_texformat_ci8;
extern const struct gl_texture_format _mesa_texformat_ycbcr;
extern const struct gl_texture_format _mesa_texformat_ycbcr_rev;
-
-/* The null format:
- */
+extern const struct gl_texture_format _mesa_texformat_rgb_fxt1;
+extern const struct gl_texture_format _mesa_texformat_rgba_fxt1;
+extern const struct gl_texture_format _mesa_texformat_rgb_dxt1;
+extern const struct gl_texture_format _mesa_texformat_rgba_dxt1;
+extern const struct gl_texture_format _mesa_texformat_rgba_dxt3;
+extern const struct gl_texture_format _mesa_texformat_rgba_dxt5;
+/*@}*/
+
+/** \name The null format */
+/*@{*/
extern const struct gl_texture_format _mesa_null_texformat;
+/*@}*/
#endif
projects / mesa.git / blobdiff