st/mesa: stop using gl_texture_image::Data when mapping/unmapping textures
[mesa.git] / src / mesa / state_tracker / st_texture.c
1 /**************************************************************************
2 *
3 * Copyright 2007 Tungsten Graphics, Inc., Cedar Park, Texas.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * 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
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 #include <stdio.h>
29
30 #include "st_context.h"
31 #include "st_format.h"
32 #include "st_texture.h"
33 #include "st_cb_fbo.h"
34 #include "main/enums.h"
35
36 #include "pipe/p_state.h"
37 #include "pipe/p_context.h"
38 #include "pipe/p_defines.h"
39 #include "util/u_inlines.h"
40 #include "util/u_format.h"
41 #include "util/u_rect.h"
42 #include "util/u_math.h"
43
44
45 #define DBG if(0) printf
46
47
48 /**
49 * Allocate a new pipe_resource object
50 * width0, height0, depth0 are the dimensions of the level 0 image
51 * (the highest resolution). last_level indicates how many mipmap levels
52 * to allocate storage for. For non-mipmapped textures, this will be zero.
53 */
54 struct pipe_resource *
55 st_texture_create(struct st_context *st,
56 enum pipe_texture_target target,
57 enum pipe_format format,
58 GLuint last_level,
59 GLuint width0,
60 GLuint height0,
61 GLuint depth0,
62 GLuint layers,
63 GLuint bind )
64 {
65 struct pipe_resource pt, *newtex;
66 struct pipe_screen *screen = st->pipe->screen;
67
68 assert(target < PIPE_MAX_TEXTURE_TYPES);
69 assert(width0 > 0);
70 assert(height0 > 0);
71 assert(depth0 > 0);
72 if (target == PIPE_TEXTURE_CUBE)
73 assert(layers == 6);
74
75 DBG("%s target %d format %s last_level %d\n", __FUNCTION__,
76 (int) target, util_format_name(format), last_level);
77
78 assert(format);
79 assert(screen->is_format_supported(screen, format, target, 0,
80 PIPE_BIND_SAMPLER_VIEW));
81
82 memset(&pt, 0, sizeof(pt));
83 pt.target = target;
84 pt.format = format;
85 pt.last_level = last_level;
86 pt.width0 = width0;
87 pt.height0 = height0;
88 pt.depth0 = depth0;
89 pt.array_size = (target == PIPE_TEXTURE_CUBE ? 6 : layers);
90 pt.usage = PIPE_USAGE_DEFAULT;
91 pt.bind = bind;
92 pt.flags = 0;
93
94 newtex = screen->resource_create(screen, &pt);
95
96 assert(!newtex || pipe_is_referenced(&newtex->reference));
97
98 return newtex;
99 }
100
101
102 /**
103 * In OpenGL the number of 1D array texture layers is the "height" and
104 * the number of 2D array texture layers is the "depth". In Gallium the
105 * number of layers in an array texture is a separate 'array_size' field.
106 * This function converts dimensions from the former to the later.
107 */
108 void
109 st_gl_texture_dims_to_pipe_dims(GLenum texture,
110 GLuint widthIn,
111 GLuint heightIn,
112 GLuint depthIn,
113 GLuint *widthOut,
114 GLuint *heightOut,
115 GLuint *depthOut,
116 GLuint *layersOut)
117 {
118 switch (texture) {
119 case GL_TEXTURE_1D:
120 assert(heightIn == 1);
121 assert(depthIn == 1);
122 *widthOut = widthIn;
123 *heightOut = 1;
124 *depthOut = 1;
125 *layersOut = 1;
126 break;
127 case GL_TEXTURE_1D_ARRAY:
128 assert(depthIn == 1);
129 *widthOut = widthIn;
130 *heightOut = 1;
131 *depthOut = 1;
132 *layersOut = heightIn;
133 break;
134 case GL_TEXTURE_2D:
135 case GL_TEXTURE_RECTANGLE:
136 assert(depthIn == 1);
137 *widthOut = widthIn;
138 *heightOut = heightIn;
139 *depthOut = 1;
140 *layersOut = 1;
141 break;
142 case GL_TEXTURE_CUBE_MAP:
143 assert(depthIn == 1);
144 *widthOut = widthIn;
145 *heightOut = heightIn;
146 *depthOut = 1;
147 *layersOut = 6;
148 break;
149 case GL_TEXTURE_2D_ARRAY:
150 *widthOut = widthIn;
151 *heightOut = heightIn;
152 *depthOut = 1;
153 *layersOut = depthIn;
154 break;
155 default:
156 assert(0 && "Unexpected texture in st_gl_texture_dims_to_pipe_dims()");
157 /* fall-through */
158 case GL_TEXTURE_3D:
159 *widthOut = widthIn;
160 *heightOut = heightIn;
161 *depthOut = depthIn;
162 *layersOut = 1;
163 break;
164 }
165 }
166
167
168 /**
169 * Check if a texture image can be pulled into a unified mipmap texture.
170 */
171 GLboolean
172 st_texture_match_image(const struct pipe_resource *pt,
173 const struct gl_texture_image *image)
174 {
175 GLuint ptWidth, ptHeight, ptDepth, ptLayers;
176
177 /* Images with borders are never pulled into mipmap textures.
178 */
179 if (image->Border)
180 return GL_FALSE;
181
182 /* Check if this image's format matches the established texture's format.
183 */
184 if (st_mesa_format_to_pipe_format(image->TexFormat) != pt->format)
185 return GL_FALSE;
186
187 st_gl_texture_dims_to_pipe_dims(image->TexObject->Target,
188 image->Width, image->Height, image->Depth,
189 &ptWidth, &ptHeight, &ptDepth, &ptLayers);
190
191 /* Test if this image's size matches what's expected in the
192 * established texture.
193 */
194 if (ptWidth != u_minify(pt->width0, image->Level) ||
195 ptHeight != u_minify(pt->height0, image->Level) ||
196 ptDepth != u_minify(pt->depth0, image->Level) ||
197 ptLayers != pt->array_size)
198 return GL_FALSE;
199
200 return GL_TRUE;
201 }
202
203
204 /**
205 * Map a texture image and return the address for a particular 2D face/slice/
206 * layer. The stImage indicates the cube face and mipmap level. The slice
207 * of the 3D texture is passed in 'zoffset'.
208 * \param usage one of the PIPE_TRANSFER_x values
209 * \param x, y, w, h the region of interest of the 2D image.
210 * \return address of mapping or NULL if any error
211 */
212 GLubyte *
213 st_texture_image_map(struct st_context *st, struct st_texture_image *stImage,
214 GLuint zoffset, enum pipe_transfer_usage usage,
215 GLuint x, GLuint y, GLuint w, GLuint h)
216 {
217 struct pipe_context *pipe = st->pipe;
218 struct pipe_resource *pt = stImage->pt;
219
220 DBG("%s \n", __FUNCTION__);
221
222 stImage->transfer = pipe_get_transfer(st->pipe, pt, stImage->base.Level,
223 stImage->base.Face + zoffset,
224 usage, x, y, w, h);
225
226 if (stImage->transfer)
227 return pipe_transfer_map(pipe, stImage->transfer);
228 else
229 return NULL;
230 }
231
232
233 void
234 st_texture_image_unmap(struct st_context *st,
235 struct st_texture_image *stImage)
236 {
237 struct pipe_context *pipe = st->pipe;
238
239 DBG("%s\n", __FUNCTION__);
240
241 pipe_transfer_unmap(pipe, stImage->transfer);
242
243 pipe->transfer_destroy(pipe, stImage->transfer);
244 stImage->transfer = NULL;
245 }
246
247
248
249 /**
250 * Upload data to a rectangular sub-region. Lots of choices how to do this:
251 *
252 * - memcpy by span to current destination
253 * - upload data as new buffer and blit
254 *
255 * Currently always memcpy.
256 */
257 static void
258 st_surface_data(struct pipe_context *pipe,
259 struct pipe_transfer *dst,
260 unsigned dstx, unsigned dsty,
261 const void *src, unsigned src_stride,
262 unsigned srcx, unsigned srcy, unsigned width, unsigned height)
263 {
264 void *map = pipe_transfer_map(pipe, dst);
265
266 assert(dst->resource);
267 util_copy_rect(map,
268 dst->resource->format,
269 dst->stride,
270 dstx, dsty,
271 width, height,
272 src, src_stride,
273 srcx, srcy);
274
275 pipe_transfer_unmap(pipe, dst);
276 }
277
278
279 /* Upload data for a particular image.
280 */
281 void
282 st_texture_image_data(struct st_context *st,
283 struct pipe_resource *dst,
284 GLuint face,
285 GLuint level,
286 void *src,
287 GLuint src_row_stride, GLuint src_image_stride)
288 {
289 struct pipe_context *pipe = st->pipe;
290 GLuint i;
291 const GLubyte *srcUB = src;
292 struct pipe_transfer *dst_transfer;
293 GLuint layers;
294
295 if (dst->target == PIPE_TEXTURE_1D_ARRAY ||
296 dst->target == PIPE_TEXTURE_2D_ARRAY)
297 layers = dst->array_size;
298 else
299 layers = u_minify(dst->depth0, level);
300
301 DBG("%s\n", __FUNCTION__);
302
303 for (i = 0; i < layers; i++) {
304 dst_transfer = pipe_get_transfer(st->pipe, dst, level, face + i,
305 PIPE_TRANSFER_WRITE, 0, 0,
306 u_minify(dst->width0, level),
307 u_minify(dst->height0, level));
308
309 st_surface_data(pipe, dst_transfer,
310 0, 0, /* dstx, dsty */
311 srcUB,
312 src_row_stride,
313 0, 0, /* source x, y */
314 u_minify(dst->width0, level),
315 u_minify(dst->height0, level)); /* width, height */
316
317 pipe->transfer_destroy(pipe, dst_transfer);
318
319 srcUB += src_image_stride;
320 }
321 }
322
323
324 /**
325 * For debug only: get/print center pixel in the src resource.
326 */
327 static void
328 print_center_pixel(struct pipe_context *pipe, struct pipe_resource *src)
329 {
330 struct pipe_transfer *xfer;
331 struct pipe_box region;
332 ubyte *map;
333
334 region.x = src->width0 / 2;
335 region.y = src->height0 / 2;
336 region.z = 0;
337 region.width = 1;
338 region.height = 1;
339 region.depth = 1;
340
341 xfer = pipe->get_transfer(pipe, src, 0, PIPE_TRANSFER_READ, &region);
342 map = pipe->transfer_map(pipe, xfer);
343
344 printf("center pixel: %d %d %d %d\n", map[0], map[1], map[2], map[3]);
345
346 pipe->transfer_unmap(pipe, xfer);
347 pipe->transfer_destroy(pipe, xfer);
348 }
349
350
351 /**
352 * Copy the image at level=0 in 'src' to the 'dst' resource at 'dstLevel'.
353 * This is used to copy mipmap images from one texture buffer to another.
354 * This typically happens when our initial guess at the total texture size
355 * is incorrect (see the guess_and_alloc_texture() function).
356 */
357 void
358 st_texture_image_copy(struct pipe_context *pipe,
359 struct pipe_resource *dst, GLuint dstLevel,
360 struct pipe_resource *src, GLuint srcLevel,
361 GLuint face)
362 {
363 GLuint width = u_minify(dst->width0, dstLevel);
364 GLuint height = u_minify(dst->height0, dstLevel);
365 GLuint depth = u_minify(dst->depth0, dstLevel);
366 struct pipe_box src_box;
367 GLuint i;
368
369 if (u_minify(src->width0, srcLevel) != width ||
370 u_minify(src->height0, srcLevel) != height ||
371 u_minify(src->depth0, srcLevel) != depth) {
372 /* The source image size doesn't match the destination image size.
373 * This can happen in some degenerate situations such as rendering to a
374 * cube map face which was set up with mismatched texture sizes.
375 */
376 return;
377 }
378
379 src_box.x = 0;
380 src_box.y = 0;
381 src_box.width = width;
382 src_box.height = height;
383 src_box.depth = 1;
384 /* Loop over 3D image slices */
385 /* could (and probably should) use "true" 3d box here -
386 but drivers can't quite handle it yet */
387 for (i = face; i < face + depth; i++) {
388 src_box.z = i;
389
390 if (0) {
391 print_center_pixel(pipe, src);
392 }
393
394 pipe->resource_copy_region(pipe,
395 dst,
396 dstLevel,
397 0, 0, i,/* destX, Y, Z */
398 src,
399 srcLevel,
400 &src_box);
401 }
402 }
403
404
405 struct pipe_resource *
406 st_create_color_map_texture(struct gl_context *ctx)
407 {
408 struct st_context *st = st_context(ctx);
409 struct pipe_context *pipe = st->pipe;
410 struct pipe_resource *pt;
411 enum pipe_format format;
412 const uint texSize = 256; /* simple, and usually perfect */
413
414 /* find an RGBA texture format */
415 format = st_choose_format(pipe->screen, GL_RGBA, GL_NONE, GL_NONE,
416 PIPE_TEXTURE_2D, 0, PIPE_BIND_SAMPLER_VIEW);
417
418 /* create texture for color map/table */
419 pt = st_texture_create(st, PIPE_TEXTURE_2D, format, 0,
420 texSize, texSize, 1, 1, PIPE_BIND_SAMPLER_VIEW);
421 return pt;
422 }
423