src/mesa/main/texstore.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  * Copyright (c) 2008 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 /**
  28  * \file texstore.h
  29  * Texture image storage routines.
  30  *
  31  * \author Brian Paul
  32  */
  33
  34
  35 #ifndef TEXSTORE_H
  36 #define TEXSTORE_H
  37
  38
  39 #include "mtypes.h"
  40 #include "formats.h"
  41
  42
  43 /**
  44  * This macro defines the (many) parameters to the texstore functions.
  45  * \param dims  either 1 or 2 or 3
  46  * \param baseInternalFormat  user-specified base internal format
  47  * \param dstFormat  destination Mesa texture format
  48  * \param dstX/Y/Zoffset  destination x/y/z offset (ala TexSubImage), in texels
  49  * \param dstRowStride  destination image row stride, in bytes
  50  * \param dstSlices  array of addresses of image slices (for 3D, array texture)
  51  * \param srcWidth/Height/Depth  source image size, in pixels
  52  * \param srcFormat  incoming image format
  53  * \param srcType  incoming image data type
  54  * \param srcAddr  source image address
  55  * \param srcPacking  source image packing parameters
  56  */
  57 #define TEXSTORE_PARAMS \
  58         struct gl_context *ctx, GLuint dims, \
  59         GLenum baseInternalFormat, \
  60         gl_format dstFormat, \
  61         GLint dstXoffset, GLint dstYoffset, GLint dstZoffset, \
  62         GLint dstRowStride, \
  63         GLubyte **dstSlices, \
  64         GLint srcWidth, GLint srcHeight, GLint srcDepth, \
  65         GLenum srcFormat, GLenum srcType, \
  66         const GLvoid *srcAddr, \
  67         const struct gl_pixelstore_attrib *srcPacking
  68
  69
  70 extern GLboolean
  71 _mesa_texstore(TEXSTORE_PARAMS);
  72
  73
  74 extern GLubyte *
  75 _mesa_make_temp_ubyte_image(struct gl_context *ctx, GLuint dims,
  76                            GLenum logicalBaseFormat,
  77                            GLenum textureBaseFormat,
  78                            GLint srcWidth, GLint srcHeight, GLint srcDepth,
  79                            GLenum srcFormat, GLenum srcType,
  80                            const GLvoid *srcAddr,
  81                            const struct gl_pixelstore_attrib *srcPacking);
  82
  83 GLfloat *
  84 _mesa_make_temp_float_image(struct gl_context *ctx, GLuint dims,
  85                             GLenum logicalBaseFormat,
  86                             GLenum textureBaseFormat,
  87                             GLint srcWidth, GLint srcHeight, GLint srcDepth,
  88                             GLenum srcFormat, GLenum srcType,
  89                             const GLvoid *srcAddr,
  90                             const struct gl_pixelstore_attrib *srcPacking,
  91                             GLbitfield transferOps);
  92
  93 extern void
  94 _mesa_store_teximage1d(struct gl_context *ctx,
  95                        struct gl_texture_image *texImage,
  96                        GLint internalFormat,
  97                        GLint width, GLint border,
  98                        GLenum format, GLenum type, const GLvoid *pixels,
  99                        const struct gl_pixelstore_attrib *packing);
 100
 101
 102 extern void
 103 _mesa_store_teximage2d(struct gl_context *ctx,
 104                        struct gl_texture_image *texImage,
 105                        GLint internalFormat,
 106                        GLint width, GLint height, GLint border,
 107                        GLenum format, GLenum type, const GLvoid *pixels,
 108                        const struct gl_pixelstore_attrib *packing);
 109
 110
 111 extern void
 112 _mesa_store_teximage3d(struct gl_context *ctx,
 113                        struct gl_texture_image *texImage,
 114                        GLint internalFormat,
 115                        GLint width, GLint height, GLint depth, GLint border,
 116                        GLenum format, GLenum type, const GLvoid *pixels,
 117                        const struct gl_pixelstore_attrib *packing);
 118
 119
 120 extern void
 121 _mesa_store_texsubimage1d(struct gl_context *ctx,
 122                           struct gl_texture_image *texImage,
 123                           GLint xoffset, GLint width,
 124                           GLenum format, GLenum type, const GLvoid *pixels,
 125                           const struct gl_pixelstore_attrib *packing);
 126
 127
 128 extern void
 129 _mesa_store_texsubimage2d(struct gl_context *ctx,
 130                           struct gl_texture_image *texImage,
 131                           GLint xoffset, GLint yoffset,
 132                           GLint width, GLint height,
 133                           GLenum format, GLenum type, const GLvoid *pixels,
 134                           const struct gl_pixelstore_attrib *packing);
 135
 136
 137 extern void
 138 _mesa_store_texsubimage3d(struct gl_context *ctx,
 139                           struct gl_texture_image *texImage,
 140                           GLint xoffset, GLint yoffset, GLint zoffset,
 141                           GLint width, GLint height, GLint depth,
 142                           GLenum format, GLenum type, const GLvoid *pixels,
 143                           const struct gl_pixelstore_attrib *packing);
 144
 145
 146 extern void
 147 _mesa_store_compressed_teximage1d(struct gl_context *ctx,
 148                                   struct gl_texture_image *texImage,
 149                                   GLint internalFormat,
 150                                   GLint width, GLint border,
 151                                   GLsizei imageSize, const GLvoid *data);
 152
 153 extern void
 154 _mesa_store_compressed_teximage2d(struct gl_context *ctx,
 155                                   struct gl_texture_image *texImage,
 156                                   GLint internalFormat,
 157                                   GLint width, GLint height, GLint border,
 158                                   GLsizei imageSize, const GLvoid *data);
 159
 160 extern void
 161 _mesa_store_compressed_teximage3d(struct gl_context *ctx,
 162                                   struct gl_texture_image *texImage,
 163                                   GLint internalFormat,
 164                                   GLint width, GLint height, GLint depth,
 165                                   GLint border,
 166                                   GLsizei imageSize, const GLvoid *data);
 167
 168
 169 extern void
 170 _mesa_store_compressed_texsubimage1d(struct gl_context *ctx,
 171                                      struct gl_texture_image *texImage,
 172                                      GLint xoffset, GLsizei width,
 173                                      GLenum format,
 174                                      GLsizei imageSize, const GLvoid *data);
 175
 176 extern void
 177 _mesa_store_compressed_texsubimage2d(struct gl_context *ctx,
 178                                      struct gl_texture_image *texImage,
 179                                      GLint xoffset, GLint yoffset,
 180                                      GLsizei width, GLsizei height,
 181                                      GLenum format,
 182                                      GLsizei imageSize, const GLvoid *data);
 183
 184 extern void
 185 _mesa_store_compressed_texsubimage3d(struct gl_context *ctx,
 186                                      struct gl_texture_image *texImage,
 187                                      GLint xoffset, GLint yoffset, GLint zoffset,
 188                                      GLsizei width, GLsizei height, GLsizei depth,
 189                                      GLenum format,
 190                                      GLsizei imageSize, const GLvoid *data);
 191
 192
 193 #endif