Home | History | Annotate | Download | only in main
      1 /*
      2  * Mesa 3-D graphics library
      3  *
      4  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
      5  * Copyright (c) 2008 VMware, Inc.
      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  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
     21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
     22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
     23  * 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 	mesa_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 extern GLboolean
     73 _mesa_texstore_needs_transfer_ops(struct gl_context *ctx,
     74                                   GLenum baseInternalFormat,
     75                                   mesa_format dstFormat);
     76 
     77 extern void
     78 _mesa_memcpy_texture(struct gl_context *ctx,
     79                      GLuint dimensions,
     80                      mesa_format dstFormat,
     81                      GLint dstRowStride,
     82                      GLubyte **dstSlices,
     83                      GLint srcWidth, GLint srcHeight, GLint srcDepth,
     84                      GLenum srcFormat, GLenum srcType,
     85                      const GLvoid *srcAddr,
     86                      const struct gl_pixelstore_attrib *srcPacking);
     87 
     88 extern GLboolean
     89 _mesa_texstore_can_use_memcpy(struct gl_context *ctx,
     90                               GLenum baseInternalFormat, mesa_format dstFormat,
     91                               GLenum srcFormat, GLenum srcType,
     92                               const struct gl_pixelstore_attrib *srcPacking);
     93 
     94 
     95 extern void
     96 _mesa_store_teximage(struct gl_context *ctx,
     97                      GLuint dims,
     98                      struct gl_texture_image *texImage,
     99                      GLenum format, GLenum type, const GLvoid *pixels,
    100                      const struct gl_pixelstore_attrib *packing);
    101 
    102 
    103 extern void
    104 _mesa_store_texsubimage(struct gl_context *ctx, GLuint dims,
    105                         struct gl_texture_image *texImage,
    106                         GLint xoffset, GLint yoffset, GLint zoffset,
    107                         GLint width, GLint height, GLint depth,
    108                         GLenum format, GLenum type, const GLvoid *pixels,
    109                         const struct gl_pixelstore_attrib *packing);
    110 
    111 
    112 extern void
    113 _mesa_store_cleartexsubimage(struct gl_context *ctx,
    114                              struct gl_texture_image *texImage,
    115                              GLint xoffset, GLint yoffset, GLint zoffset,
    116                              GLsizei width, GLsizei height, GLsizei depth,
    117                              const GLvoid *clearValue);
    118 
    119 extern void
    120 _mesa_store_compressed_teximage(struct gl_context *ctx, GLuint dims,
    121                                 struct gl_texture_image *texImage,
    122                                 GLsizei imageSize, const GLvoid *data);
    123 
    124 
    125 extern void
    126 _mesa_store_compressed_texsubimage(struct gl_context *ctx, GLuint dims,
    127                                    struct gl_texture_image *texImage,
    128                                    GLint xoffset, GLint yoffset, GLint zoffset,
    129                                    GLsizei width, GLsizei height, GLsizei depth,
    130                                    GLenum format,
    131                                    GLsizei imageSize, const GLvoid *data);
    132 
    133 
    134 struct compressed_pixelstore {
    135    int SkipBytes;
    136    int CopyBytesPerRow;
    137    int CopyRowsPerSlice;
    138    int TotalBytesPerRow;
    139    int TotalRowsPerSlice;
    140    int CopySlices;
    141 };
    142 
    143 
    144 extern void
    145 _mesa_compute_compressed_pixelstore(GLuint dims, mesa_format texFormat,
    146                                     GLsizei width, GLsizei height,
    147                                     GLsizei depth,
    148                                     const struct gl_pixelstore_attrib *packing,
    149                                     struct compressed_pixelstore *store);
    150 
    151 
    152 #endif
    153