107f21300156645daf5bd8f61308375ee21a8a67
[mesa.git] / 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 GLboolean
74 _mesa_texstore_can_use_memcpy(struct gl_context *ctx,
75 GLenum baseInternalFormat, gl_format dstFormat,
76 GLenum srcFormat, GLenum srcType,
77 const struct gl_pixelstore_attrib *srcPacking);
78
79
80 extern GLubyte *
81 _mesa_make_temp_ubyte_image(struct gl_context *ctx, GLuint dims,
82 GLenum logicalBaseFormat,
83 GLenum textureBaseFormat,
84 GLint srcWidth, GLint srcHeight, GLint srcDepth,
85 GLenum srcFormat, GLenum srcType,
86 const GLvoid *srcAddr,
87 const struct gl_pixelstore_attrib *srcPacking);
88
89 GLfloat *
90 _mesa_make_temp_float_image(struct gl_context *ctx, GLuint dims,
91 GLenum logicalBaseFormat,
92 GLenum textureBaseFormat,
93 GLint srcWidth, GLint srcHeight, GLint srcDepth,
94 GLenum srcFormat, GLenum srcType,
95 const GLvoid *srcAddr,
96 const struct gl_pixelstore_attrib *srcPacking,
97 GLbitfield transferOps);
98
99 extern void
100 _mesa_store_teximage(struct gl_context *ctx,
101 GLuint dims,
102 struct gl_texture_image *texImage,
103 GLenum format, GLenum type, const GLvoid *pixels,
104 const struct gl_pixelstore_attrib *packing);
105
106
107 extern void
108 _mesa_store_texsubimage(struct gl_context *ctx, GLuint dims,
109 struct gl_texture_image *texImage,
110 GLint xoffset, GLint yoffset, GLint zoffset,
111 GLint width, GLint height, GLint depth,
112 GLenum format, GLenum type, const GLvoid *pixels,
113 const struct gl_pixelstore_attrib *packing);
114
115
116 extern void
117 _mesa_store_compressed_teximage(struct gl_context *ctx, GLuint dims,
118 struct gl_texture_image *texImage,
119 GLsizei imageSize, const GLvoid *data);
120
121
122 extern void
123 _mesa_store_compressed_texsubimage(struct gl_context *ctx, GLuint dims,
124 struct gl_texture_image *texImage,
125 GLint xoffset, GLint yoffset, GLint zoffset,
126 GLsizei width, GLsizei height, GLsizei depth,
127 GLenum format,
128 GLsizei imageSize, const GLvoid *data);
129
130
131 #endif