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