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 dstRowStride, \
  62         GLubyte **dstSlices, \
  63         GLint srcWidth, GLint srcHeight, GLint srcDepth, \
  64         GLenum srcFormat, GLenum srcType, \
  65         const GLvoid *srcAddr, \
  66         const struct gl_pixelstore_attrib *srcPacking
  67
  68
  69 extern GLboolean
  70 _mesa_texstore(TEXSTORE_PARAMS);
  71
  72
  73 extern GLubyte *
  74 _mesa_make_temp_ubyte_image(struct gl_context *ctx, GLuint dims,
  75                            GLenum logicalBaseFormat,
  76                            GLenum textureBaseFormat,
  77                            GLint srcWidth, GLint srcHeight, GLint srcDepth,
  78                            GLenum srcFormat, GLenum srcType,
  79                            const GLvoid *srcAddr,
  80                            const struct gl_pixelstore_attrib *srcPacking);
  81
  82 GLfloat *
  83 _mesa_make_temp_float_image(struct gl_context *ctx, GLuint dims,
  84                             GLenum logicalBaseFormat,
  85                             GLenum textureBaseFormat,
  86                             GLint srcWidth, GLint srcHeight, GLint srcDepth,
  87                             GLenum srcFormat, GLenum srcType,
  88                             const GLvoid *srcAddr,
  89                             const struct gl_pixelstore_attrib *srcPacking,
  90                             GLbitfield transferOps);
  91
  92 extern void
  93 _mesa_store_teximage(struct gl_context *ctx,
  94                      GLuint dims,
  95                      struct gl_texture_image *texImage,
  96                      GLenum format, GLenum type, const GLvoid *pixels,
  97                      const struct gl_pixelstore_attrib *packing);
  98
  99
 100 extern void
 101 _mesa_store_texsubimage(struct gl_context *ctx, GLuint dims,
 102                         struct gl_texture_image *texImage,
 103                         GLint xoffset, GLint yoffset, GLint zoffset,
 104                         GLint width, GLint height, GLint depth,
 105                         GLenum format, GLenum type, const GLvoid *pixels,
 106                         const struct gl_pixelstore_attrib *packing);
 107
 108
 109 extern void
 110 _mesa_store_compressed_teximage(struct gl_context *ctx, GLuint dims,
 111                                 struct gl_texture_image *texImage,
 112                                 GLsizei imageSize, const GLvoid *data);
 113
 114
 115 extern void
 116 _mesa_store_compressed_texsubimage(struct gl_context *ctx, GLuint dims,
 117                                    struct gl_texture_image *texImage,
 118                                    GLint xoffset, GLint yoffset, GLint zoffset,
 119                                    GLsizei width, GLsizei height, GLsizei depth,
 120                                    GLenum format,
 121                                    GLsizei imageSize, const GLvoid *data);
 122
 123
 124 #endif