2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
28 #include "bufferobj.h"
32 #include "framebuffer.h"
34 #include "format_unpack.h"
40 #include "glformats.h"
42 #include "format_utils.h"
43 #include "pixeltransfer.h"
47 * Return true if the conversion L=R+G+B is needed.
50 need_rgb_to_luminance_conversion(mesa_format texFormat
, GLenum format
)
52 GLenum baseTexFormat
= _mesa_get_format_base_format(texFormat
);
54 return (baseTexFormat
== GL_RG
||
55 baseTexFormat
== GL_RGB
||
56 baseTexFormat
== GL_RGBA
) &&
57 (format
== GL_LUMINANCE
|| format
== GL_LUMINANCE_ALPHA
);
62 * Return transfer op flags for this ReadPixels operation.
65 get_readpixels_transfer_ops(const struct gl_context
*ctx
, mesa_format texFormat
,
66 GLenum format
, GLenum type
, GLboolean uses_blit
)
68 GLbitfield transferOps
= ctx
->_ImageTransferState
;
70 if (format
== GL_DEPTH_COMPONENT
||
71 format
== GL_DEPTH_STENCIL
||
72 format
== GL_STENCIL_INDEX
) {
76 /* Pixel transfer ops (scale, bias, table lookup) do not apply
79 if (_mesa_is_enum_format_integer(format
)) {
84 /* For blit-based ReadPixels packing, the clamping is done automatically
85 * unless the type is float. */
86 if (_mesa_get_clamp_read_color(ctx
) &&
87 (type
== GL_FLOAT
|| type
== GL_HALF_FLOAT
)) {
88 transferOps
|= IMAGE_CLAMP_BIT
;
92 /* For CPU-based ReadPixels packing, the clamping must always be done
93 * for non-float types, */
94 if (_mesa_get_clamp_read_color(ctx
) ||
95 (type
!= GL_FLOAT
&& type
!= GL_HALF_FLOAT
)) {
96 transferOps
|= IMAGE_CLAMP_BIT
;
100 /* If the format is unsigned normalized, we can ignore clamping
101 * because the values are already in the range [0,1] so it won't
102 * have any effect anyway.
104 if (_mesa_get_format_datatype(texFormat
) == GL_UNSIGNED_NORMALIZED
&&
105 !need_rgb_to_luminance_conversion(texFormat
, format
)) {
106 transferOps
&= ~IMAGE_CLAMP_BIT
;
114 * Return true if memcpy cannot be used for ReadPixels.
116 * If uses_blit is true, the function returns true if a simple 3D engine blit
117 * cannot be used for ReadPixels packing.
119 * NOTE: This doesn't take swizzling and format conversions between
120 * the readbuffer and the pixel pack buffer into account.
123 _mesa_readpixels_needs_slow_path(const struct gl_context
*ctx
, GLenum format
,
124 GLenum type
, GLboolean uses_blit
)
126 struct gl_renderbuffer
*rb
=
127 _mesa_get_read_renderbuffer_for_format(ctx
, format
);
132 /* There are different rules depending on the base format. */
134 case GL_DEPTH_STENCIL
:
135 return !_mesa_has_depthstencil_combined(ctx
->ReadBuffer
) ||
136 ctx
->Pixel
.DepthScale
!= 1.0f
|| ctx
->Pixel
.DepthBias
!= 0.0f
||
137 ctx
->Pixel
.IndexShift
|| ctx
->Pixel
.IndexOffset
||
138 ctx
->Pixel
.MapStencilFlag
;
140 case GL_DEPTH_COMPONENT
:
141 return ctx
->Pixel
.DepthScale
!= 1.0f
|| ctx
->Pixel
.DepthBias
!= 0.0f
;
143 case GL_STENCIL_INDEX
:
144 return ctx
->Pixel
.IndexShift
|| ctx
->Pixel
.IndexOffset
||
145 ctx
->Pixel
.MapStencilFlag
;
149 if (need_rgb_to_luminance_conversion(rb
->Format
, format
)) {
153 /* Conversion between signed and unsigned integers needs masking
154 * (it isn't just memcpy). */
155 srcType
= _mesa_get_format_datatype(rb
->Format
);
157 if ((srcType
== GL_INT
&&
158 (type
== GL_UNSIGNED_INT
||
159 type
== GL_UNSIGNED_SHORT
||
160 type
== GL_UNSIGNED_BYTE
)) ||
161 (srcType
== GL_UNSIGNED_INT
&&
168 /* And finally, see if there are any transfer ops. */
169 return get_readpixels_transfer_ops(ctx
, rb
->Format
, format
, type
,
177 readpixels_can_use_memcpy(const struct gl_context
*ctx
, GLenum format
, GLenum type
,
178 const struct gl_pixelstore_attrib
*packing
)
180 struct gl_renderbuffer
*rb
=
181 _mesa_get_read_renderbuffer_for_format(ctx
, format
);
185 if (_mesa_readpixels_needs_slow_path(ctx
, format
, type
, GL_FALSE
)) {
189 /* The base internal format and the base Mesa format must match. */
190 if (rb
->_BaseFormat
!= _mesa_get_format_base_format(rb
->Format
)) {
194 /* The Mesa format must match the input format and type. */
195 if (!_mesa_format_matches_format_and_type(rb
->Format
, format
, type
,
196 packing
->SwapBytes
)) {
205 readpixels_memcpy(struct gl_context
*ctx
,
207 GLsizei width
, GLsizei height
,
208 GLenum format
, GLenum type
,
210 const struct gl_pixelstore_attrib
*packing
)
212 struct gl_renderbuffer
*rb
=
213 _mesa_get_read_renderbuffer_for_format(ctx
, format
);
215 int dstStride
, stride
, j
, texelBytes
;
217 /* Fail if memcpy cannot be used. */
218 if (!readpixels_can_use_memcpy(ctx
, format
, type
, packing
)) {
222 dstStride
= _mesa_image_row_stride(packing
, width
, format
, type
);
223 dst
= (GLubyte
*) _mesa_image_address2d(packing
, pixels
, width
, height
,
226 ctx
->Driver
.MapRenderbuffer(ctx
, rb
, x
, y
, width
, height
, GL_MAP_READ_BIT
,
229 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
230 return GL_TRUE
; /* don't bother trying the slow path */
233 texelBytes
= _mesa_get_format_bytes(rb
->Format
);
236 for (j
= 0; j
< height
; j
++) {
237 memcpy(dst
, map
, width
* texelBytes
);
242 ctx
->Driver
.UnmapRenderbuffer(ctx
, rb
);
248 * Optimized path for conversion of depth values to GL_DEPTH_COMPONENT,
252 read_uint_depth_pixels( struct gl_context
*ctx
,
254 GLsizei width
, GLsizei height
,
255 GLenum type
, GLvoid
*pixels
,
256 const struct gl_pixelstore_attrib
*packing
)
258 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
259 struct gl_renderbuffer
*rb
= fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
261 int stride
, dstStride
, j
;
263 if (ctx
->Pixel
.DepthScale
!= 1.0 || ctx
->Pixel
.DepthBias
!= 0.0)
266 if (packing
->SwapBytes
)
269 if (_mesa_get_format_datatype(rb
->Format
) != GL_UNSIGNED_NORMALIZED
)
272 ctx
->Driver
.MapRenderbuffer(ctx
, rb
, x
, y
, width
, height
, GL_MAP_READ_BIT
,
276 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
277 return GL_TRUE
; /* don't bother trying the slow path */
280 dstStride
= _mesa_image_row_stride(packing
, width
, GL_DEPTH_COMPONENT
, type
);
281 dst
= (GLubyte
*) _mesa_image_address2d(packing
, pixels
, width
, height
,
282 GL_DEPTH_COMPONENT
, type
, 0, 0);
284 for (j
= 0; j
< height
; j
++) {
285 _mesa_unpack_uint_z_row(rb
->Format
, width
, map
, (GLuint
*)dst
);
290 ctx
->Driver
.UnmapRenderbuffer(ctx
, rb
);
296 * Read pixels for format=GL_DEPTH_COMPONENT.
299 read_depth_pixels( struct gl_context
*ctx
,
301 GLsizei width
, GLsizei height
,
302 GLenum type
, GLvoid
*pixels
,
303 const struct gl_pixelstore_attrib
*packing
)
305 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
306 struct gl_renderbuffer
*rb
= fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
309 int dstStride
, stride
;
310 GLfloat
*depthValues
;
315 /* clipping should have been done already */
318 assert(x
+ width
<= (GLint
) rb
->Width
);
319 assert(y
+ height
<= (GLint
) rb
->Height
);
321 if (type
== GL_UNSIGNED_INT
&&
322 read_uint_depth_pixels(ctx
, x
, y
, width
, height
, type
, pixels
, packing
)) {
326 dstStride
= _mesa_image_row_stride(packing
, width
, GL_DEPTH_COMPONENT
, type
);
327 dst
= (GLubyte
*) _mesa_image_address2d(packing
, pixels
, width
, height
,
328 GL_DEPTH_COMPONENT
, type
, 0, 0);
330 ctx
->Driver
.MapRenderbuffer(ctx
, rb
, x
, y
, width
, height
, GL_MAP_READ_BIT
,
333 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
337 depthValues
= malloc(width
* sizeof(GLfloat
));
340 /* General case (slower) */
341 for (j
= 0; j
< height
; j
++, y
++) {
342 _mesa_unpack_float_z_row(rb
->Format
, width
, map
, depthValues
);
343 _mesa_pack_depth_span(ctx
, width
, dst
, type
, depthValues
, packing
);
350 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
355 ctx
->Driver
.UnmapRenderbuffer(ctx
, rb
);
360 * Read pixels for format=GL_STENCIL_INDEX.
363 read_stencil_pixels( struct gl_context
*ctx
,
365 GLsizei width
, GLsizei height
,
366 GLenum type
, GLvoid
*pixels
,
367 const struct gl_pixelstore_attrib
*packing
)
369 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
370 struct gl_renderbuffer
*rb
= fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
372 GLubyte
*map
, *stencil
;
378 ctx
->Driver
.MapRenderbuffer(ctx
, rb
, x
, y
, width
, height
, GL_MAP_READ_BIT
,
381 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
385 stencil
= malloc(width
* sizeof(GLubyte
));
388 /* process image row by row */
389 for (j
= 0; j
< height
; j
++) {
392 _mesa_unpack_ubyte_stencil_row(rb
->Format
, width
, map
, stencil
);
393 dest
= _mesa_image_address2d(packing
, pixels
, width
, height
,
394 GL_STENCIL_INDEX
, type
, j
, 0);
396 _mesa_pack_stencil_span(ctx
, width
, type
, dest
, stencil
, packing
);
402 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
407 ctx
->Driver
.UnmapRenderbuffer(ctx
, rb
);
411 * Read R, G, B, A, RGB, L, or LA pixels.
414 read_rgba_pixels( struct gl_context
*ctx
,
416 GLsizei width
, GLsizei height
,
417 GLenum format
, GLenum type
, GLvoid
*pixels
,
418 const struct gl_pixelstore_attrib
*packing
)
420 GLbitfield transferOps
;
421 bool dst_is_integer
, dst_is_luminance
, needs_rebase
;
422 int dst_stride
, src_stride
, rb_stride
;
423 uint32_t dst_format
, src_format
;
425 mesa_format rb_format
;
428 bool src_is_uint
= false;
429 uint8_t rebase_swizzle
[4];
430 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
431 struct gl_renderbuffer
*rb
= fb
->_ColorReadBuffer
;
436 transferOps
= get_readpixels_transfer_ops(ctx
, rb
->Format
, format
, type
,
438 /* Describe the dst format */
439 dst_is_integer
= _mesa_is_enum_format_integer(format
);
440 dst_stride
= _mesa_image_row_stride(packing
, width
, format
, type
);
441 dst_format
= _mesa_format_from_format_and_type(format
, type
);
442 dst_is_luminance
= format
== GL_LUMINANCE
||
443 format
== GL_LUMINANCE_ALPHA
||
444 format
== GL_LUMINANCE_INTEGER_EXT
||
445 format
== GL_LUMINANCE_ALPHA_INTEGER_EXT
;
446 dst
= (GLubyte
*) _mesa_image_address2d(packing
, pixels
, width
, height
,
449 /* Map the source render buffer */
450 ctx
->Driver
.MapRenderbuffer(ctx
, rb
, x
, y
, width
, height
, GL_MAP_READ_BIT
,
453 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
456 rb_format
= _mesa_get_srgb_format_linear(rb
->Format
);
459 * Depending on the base formats involved in the conversion we might need to
460 * rebase some values, so for these formats we compute a rebase swizzle.
462 if (rb
->_BaseFormat
== GL_LUMINANCE
|| rb
->_BaseFormat
== GL_INTENSITY
) {
464 rebase_swizzle
[0] = MESA_FORMAT_SWIZZLE_X
;
465 rebase_swizzle
[1] = MESA_FORMAT_SWIZZLE_ZERO
;
466 rebase_swizzle
[2] = MESA_FORMAT_SWIZZLE_ZERO
;
467 rebase_swizzle
[3] = MESA_FORMAT_SWIZZLE_ONE
;
468 } else if (rb
->_BaseFormat
== GL_LUMINANCE_ALPHA
) {
470 rebase_swizzle
[0] = MESA_FORMAT_SWIZZLE_X
;
471 rebase_swizzle
[1] = MESA_FORMAT_SWIZZLE_ZERO
;
472 rebase_swizzle
[2] = MESA_FORMAT_SWIZZLE_ZERO
;
473 rebase_swizzle
[3] = MESA_FORMAT_SWIZZLE_W
;
474 } else if (_mesa_get_format_base_format(rb_format
) != rb
->_BaseFormat
) {
476 _mesa_compute_rgba2base2rgba_component_mapping(rb
->_BaseFormat
,
479 needs_rebase
= false;
482 /* Since _mesa_format_convert does not handle transferOps we need to handle
483 * them before we call the function. This requires to convert to RGBA float
484 * first so we can call _mesa_apply_rgba_transfer_ops. If the dst format is
485 * integer transferOps do not apply.
487 * Converting to luminance also requires converting to RGBA first, so we can
488 * then compute luminance values as L=R+G+B. Notice that this is different
489 * from GetTexImage, where we compute L=R.
491 assert(!transferOps
|| (transferOps
&& !dst_is_integer
));
493 needs_rgba
= transferOps
|| dst_is_luminance
;
496 uint32_t rgba_format
;
500 /* Convert to RGBA float or int/uint depending on the type of the src */
501 if (dst_is_integer
) {
502 src_is_uint
= _mesa_is_format_unsigned(rb_format
);
504 rgba_format
= RGBA32_UINT
;
505 rgba_stride
= width
* 4 * sizeof(GLuint
);
507 rgba_format
= RGBA32_INT
;
508 rgba_stride
= width
* 4 * sizeof(GLint
);
511 rgba_format
= RGBA32_FLOAT
;
512 rgba_stride
= width
* 4 * sizeof(GLfloat
);
515 /* If we are lucky and the dst format matches the RGBA format we need to
516 * convert to, then we can convert directly into the dst buffer and avoid
517 * the final conversion/copy from the rgba buffer to the dst buffer.
519 if (dst_format
== rgba_format
) {
520 need_convert
= false;
524 rgba
= malloc(height
* rgba_stride
);
526 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
531 /* Convert to RGBA now */
532 _mesa_format_convert(rgba
, rgba_format
, rgba_stride
,
533 map
, rb_format
, rb_stride
,
535 needs_rebase
? rebase_swizzle
: NULL
);
537 /* Handle transfer ops if necessary */
539 _mesa_apply_rgba_transfer_ops(ctx
, transferOps
, width
* height
, rgba
);
541 /* If we had to rebase, we have already taken care of that */
542 needs_rebase
= false;
544 /* If we were lucky and our RGBA conversion matches the dst format, then
550 /* Otherwise, we need to convert from RGBA to dst next */
552 src_format
= rgba_format
;
553 src_stride
= rgba_stride
;
555 /* No RGBA conversion needed, convert directly to dst */
557 src_format
= rb_format
;
558 src_stride
= rb_stride
;
561 /* Do the conversion.
563 * If the dst format is Luminance, we need to do the conversion by computing
566 if (!dst_is_luminance
) {
567 _mesa_format_convert(dst
, dst_format
, dst_stride
,
568 src
, src_format
, src_stride
,
570 needs_rebase
? rebase_swizzle
: NULL
);
571 } else if (!dst_is_integer
) {
572 /* Compute float Luminance values from RGBA float */
573 int luminance_stride
, luminance_bytes
;
575 uint32_t luminance_format
;
577 luminance_stride
= width
* sizeof(GL_FLOAT
);
578 if (format
== GL_LUMINANCE_ALPHA
)
579 luminance_stride
*= 2;
580 luminance_bytes
= height
* luminance_stride
;
581 luminance
= malloc(luminance_bytes
);
583 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
587 _mesa_pack_luminance_from_rgba_float(width
* height
, src
,
588 luminance
, format
, transferOps
);
590 /* Convert from Luminance float to dst (this will hadle type conversion
591 * from float to the type of dst if necessary)
593 luminance_format
= _mesa_format_from_format_and_type(format
, GL_FLOAT
);
594 _mesa_format_convert(dst
, dst_format
, dst_stride
,
595 luminance
, luminance_format
, luminance_stride
,
596 width
, height
, NULL
);
598 _mesa_pack_luminance_from_rgba_integer(width
* height
, src
, !src_is_uint
,
606 /* Handle byte swapping if required */
607 if (packing
->SwapBytes
) {
608 GLint swapSize
= _mesa_sizeof_packed_type(type
);
609 if (swapSize
== 2 || swapSize
== 4) {
610 int swapsPerPixel
= _mesa_bytes_per_pixel(format
, type
) / swapSize
;
611 assert(_mesa_bytes_per_pixel(format
, type
) % swapSize
== 0);
613 _mesa_swap2((GLushort
*) dst
, width
* height
* swapsPerPixel
);
614 else if (swapSize
== 4)
615 _mesa_swap4((GLuint
*) dst
, width
* height
* swapsPerPixel
);
620 ctx
->Driver
.UnmapRenderbuffer(ctx
, rb
);
624 * For a packed depth/stencil buffer being read as depth/stencil, just memcpy the
625 * data (possibly swapping 8/24 vs 24/8 as we go).
628 fast_read_depth_stencil_pixels(struct gl_context
*ctx
,
630 GLsizei width
, GLsizei height
,
631 GLubyte
*dst
, int dstStride
)
633 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
634 struct gl_renderbuffer
*rb
= fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
635 struct gl_renderbuffer
*stencilRb
= fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
642 if (rb
->Format
!= MESA_FORMAT_S8_UINT_Z24_UNORM
&&
643 rb
->Format
!= MESA_FORMAT_Z24_UNORM_S8_UINT
)
646 ctx
->Driver
.MapRenderbuffer(ctx
, rb
, x
, y
, width
, height
, GL_MAP_READ_BIT
,
649 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
650 return GL_TRUE
; /* don't bother trying the slow path */
653 for (i
= 0; i
< height
; i
++) {
654 _mesa_unpack_uint_24_8_depth_stencil_row(rb
->Format
, width
,
660 ctx
->Driver
.UnmapRenderbuffer(ctx
, rb
);
667 * For non-float-depth and stencil buffers being read as 24/8 depth/stencil,
668 * copy the integer data directly instead of converting depth to float and
672 fast_read_depth_stencil_pixels_separate(struct gl_context
*ctx
,
674 GLsizei width
, GLsizei height
,
675 uint32_t *dst
, int dstStride
)
677 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
678 struct gl_renderbuffer
*depthRb
= fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
679 struct gl_renderbuffer
*stencilRb
= fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
680 GLubyte
*depthMap
, *stencilMap
, *stencilVals
;
681 int depthStride
, stencilStride
, i
, j
;
683 if (_mesa_get_format_datatype(depthRb
->Format
) != GL_UNSIGNED_NORMALIZED
)
686 ctx
->Driver
.MapRenderbuffer(ctx
, depthRb
, x
, y
, width
, height
,
687 GL_MAP_READ_BIT
, &depthMap
, &depthStride
);
689 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
690 return GL_TRUE
; /* don't bother trying the slow path */
693 ctx
->Driver
.MapRenderbuffer(ctx
, stencilRb
, x
, y
, width
, height
,
694 GL_MAP_READ_BIT
, &stencilMap
, &stencilStride
);
696 ctx
->Driver
.UnmapRenderbuffer(ctx
, depthRb
);
697 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
698 return GL_TRUE
; /* don't bother trying the slow path */
701 stencilVals
= malloc(width
* sizeof(GLubyte
));
704 for (j
= 0; j
< height
; j
++) {
705 _mesa_unpack_uint_z_row(depthRb
->Format
, width
, depthMap
, dst
);
706 _mesa_unpack_ubyte_stencil_row(stencilRb
->Format
, width
,
707 stencilMap
, stencilVals
);
709 for (i
= 0; i
< width
; i
++) {
710 dst
[i
] = (dst
[i
] & 0xffffff00) | stencilVals
[i
];
713 depthMap
+= depthStride
;
714 stencilMap
+= stencilStride
;
715 dst
+= dstStride
/ 4;
719 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
724 ctx
->Driver
.UnmapRenderbuffer(ctx
, depthRb
);
725 ctx
->Driver
.UnmapRenderbuffer(ctx
, stencilRb
);
731 slow_read_depth_stencil_pixels_separate(struct gl_context
*ctx
,
733 GLsizei width
, GLsizei height
,
735 const struct gl_pixelstore_attrib
*packing
,
736 GLubyte
*dst
, int dstStride
)
738 struct gl_framebuffer
*fb
= ctx
->ReadBuffer
;
739 struct gl_renderbuffer
*depthRb
= fb
->Attachment
[BUFFER_DEPTH
].Renderbuffer
;
740 struct gl_renderbuffer
*stencilRb
= fb
->Attachment
[BUFFER_STENCIL
].Renderbuffer
;
741 GLubyte
*depthMap
, *stencilMap
;
742 int depthStride
, stencilStride
, j
;
743 GLubyte
*stencilVals
;
747 /* The depth and stencil buffers might be separate, or a single buffer.
748 * If one buffer, only map it once.
750 ctx
->Driver
.MapRenderbuffer(ctx
, depthRb
, x
, y
, width
, height
,
751 GL_MAP_READ_BIT
, &depthMap
, &depthStride
);
753 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
757 if (stencilRb
!= depthRb
) {
758 ctx
->Driver
.MapRenderbuffer(ctx
, stencilRb
, x
, y
, width
, height
,
759 GL_MAP_READ_BIT
, &stencilMap
,
762 ctx
->Driver
.UnmapRenderbuffer(ctx
, depthRb
);
763 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
768 stencilMap
= depthMap
;
769 stencilStride
= depthStride
;
772 stencilVals
= malloc(width
* sizeof(GLubyte
));
773 depthVals
= malloc(width
* sizeof(GLfloat
));
775 if (stencilVals
&& depthVals
) {
776 for (j
= 0; j
< height
; j
++) {
777 _mesa_unpack_float_z_row(depthRb
->Format
, width
, depthMap
, depthVals
);
778 _mesa_unpack_ubyte_stencil_row(stencilRb
->Format
, width
,
779 stencilMap
, stencilVals
);
781 _mesa_pack_depth_stencil_span(ctx
, width
, type
, (GLuint
*)dst
,
782 depthVals
, stencilVals
, packing
);
784 depthMap
+= depthStride
;
785 stencilMap
+= stencilStride
;
790 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glReadPixels");
796 ctx
->Driver
.UnmapRenderbuffer(ctx
, depthRb
);
797 if (stencilRb
!= depthRb
) {
798 ctx
->Driver
.UnmapRenderbuffer(ctx
, stencilRb
);
804 * Read combined depth/stencil values.
805 * We'll have already done error checking to be sure the expected
806 * depth and stencil buffers really exist.
809 read_depth_stencil_pixels(struct gl_context
*ctx
,
811 GLsizei width
, GLsizei height
,
812 GLenum type
, GLvoid
*pixels
,
813 const struct gl_pixelstore_attrib
*packing
)
815 const GLboolean scaleOrBias
816 = ctx
->Pixel
.DepthScale
!= 1.0 || ctx
->Pixel
.DepthBias
!= 0.0;
817 const GLboolean stencilTransfer
= ctx
->Pixel
.IndexShift
818 || ctx
->Pixel
.IndexOffset
|| ctx
->Pixel
.MapStencilFlag
;
822 dst
= (GLubyte
*) _mesa_image_address2d(packing
, pixels
,
824 GL_DEPTH_STENCIL_EXT
,
826 dstStride
= _mesa_image_row_stride(packing
, width
,
827 GL_DEPTH_STENCIL_EXT
, type
);
829 /* Fast 24/8 reads. */
830 if (type
== GL_UNSIGNED_INT_24_8
&&
831 !scaleOrBias
&& !stencilTransfer
&& !packing
->SwapBytes
) {
832 if (fast_read_depth_stencil_pixels(ctx
, x
, y
, width
, height
,
836 if (fast_read_depth_stencil_pixels_separate(ctx
, x
, y
, width
, height
,
837 (uint32_t *)dst
, dstStride
))
841 slow_read_depth_stencil_pixels_separate(ctx
, x
, y
, width
, height
,
849 * Software fallback routine for ctx->Driver.ReadPixels().
850 * By time we get here, all error checking will have been done.
853 _mesa_readpixels(struct gl_context
*ctx
,
854 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
855 GLenum format
, GLenum type
,
856 const struct gl_pixelstore_attrib
*packing
,
859 struct gl_pixelstore_attrib clippedPacking
= *packing
;
862 _mesa_update_state(ctx
);
864 /* Do all needed clipping here, so that we can forget about it later */
865 if (_mesa_clip_readpixels(ctx
, &x
, &y
, &width
, &height
, &clippedPacking
)) {
867 pixels
= _mesa_map_pbo_dest(ctx
, &clippedPacking
, pixels
);
870 /* Try memcpy first. */
871 if (readpixels_memcpy(ctx
, x
, y
, width
, height
, format
, type
,
873 _mesa_unmap_pbo_dest(ctx
, &clippedPacking
);
877 /* Otherwise take the slow path. */
879 case GL_STENCIL_INDEX
:
880 read_stencil_pixels(ctx
, x
, y
, width
, height
, type
, pixels
,
883 case GL_DEPTH_COMPONENT
:
884 read_depth_pixels(ctx
, x
, y
, width
, height
, type
, pixels
,
887 case GL_DEPTH_STENCIL_EXT
:
888 read_depth_stencil_pixels(ctx
, x
, y
, width
, height
, type
, pixels
,
892 /* all other formats should be color formats */
893 read_rgba_pixels(ctx
, x
, y
, width
, height
, format
, type
, pixels
,
897 _mesa_unmap_pbo_dest(ctx
, &clippedPacking
);
904 read_pixels_es3_error_check(GLenum format
, GLenum type
,
905 const struct gl_renderbuffer
*rb
)
907 const GLenum internalFormat
= rb
->InternalFormat
;
908 const GLenum data_type
= _mesa_get_format_datatype(rb
->Format
);
909 GLboolean is_unsigned_int
= GL_FALSE
;
910 GLboolean is_signed_int
= GL_FALSE
;
912 if (!_mesa_is_color_format(internalFormat
)) {
913 return GL_INVALID_OPERATION
;
916 is_unsigned_int
= _mesa_is_enum_format_unsigned_int(internalFormat
);
917 if (!is_unsigned_int
) {
918 is_signed_int
= _mesa_is_enum_format_signed_int(internalFormat
);
923 if (type
== GL_FLOAT
&& data_type
== GL_FLOAT
)
924 return GL_NO_ERROR
; /* EXT_color_buffer_float */
925 if (type
== GL_UNSIGNED_BYTE
&& data_type
== GL_UNSIGNED_NORMALIZED
)
927 if (internalFormat
== GL_RGB10_A2
&&
928 type
== GL_UNSIGNED_INT_2_10_10_10_REV
)
930 if (internalFormat
== GL_RGB10_A2UI
&& type
== GL_UNSIGNED_BYTE
)
934 /* GL_EXT_read_format_bgra */
935 if (type
== GL_UNSIGNED_BYTE
||
936 type
== GL_UNSIGNED_SHORT_4_4_4_4_REV
||
937 type
== GL_UNSIGNED_SHORT_1_5_5_5_REV
)
940 case GL_RGBA_INTEGER
:
941 if ((is_signed_int
&& type
== GL_INT
) ||
942 (is_unsigned_int
&& type
== GL_UNSIGNED_INT
))
947 return GL_INVALID_OPERATION
;
952 _mesa_ReadnPixelsARB( GLint x
, GLint y
, GLsizei width
, GLsizei height
,
953 GLenum format
, GLenum type
, GLsizei bufSize
,
956 GLenum err
= GL_NO_ERROR
;
957 struct gl_renderbuffer
*rb
;
959 GET_CURRENT_CONTEXT(ctx
);
961 FLUSH_VERTICES(ctx
, 0);
962 FLUSH_CURRENT(ctx
, 0);
964 if (MESA_VERBOSE
& VERBOSE_API
)
965 _mesa_debug(ctx
, "glReadPixels(%d, %d, %s, %s, %p)\n",
967 _mesa_lookup_enum_by_nr(format
),
968 _mesa_lookup_enum_by_nr(type
),
971 if (width
< 0 || height
< 0) {
972 _mesa_error( ctx
, GL_INVALID_VALUE
,
973 "glReadPixels(width=%d height=%d)", width
, height
);
978 _mesa_update_state(ctx
);
980 if (ctx
->ReadBuffer
->_Status
!= GL_FRAMEBUFFER_COMPLETE_EXT
) {
981 _mesa_error(ctx
, GL_INVALID_FRAMEBUFFER_OPERATION_EXT
,
982 "glReadPixels(incomplete framebuffer)" );
986 rb
= _mesa_get_read_renderbuffer_for_format(ctx
, format
);
988 _mesa_error(ctx
, GL_INVALID_OPERATION
,
989 "glReadPixels(read buffer)");
993 /* OpenGL ES 1.x and OpenGL ES 2.0 impose additional restrictions on the
994 * combinations of format and type that can be used.
996 * Technically, only two combinations are actually allowed:
997 * GL_RGBA/GL_UNSIGNED_BYTE, and some implementation-specific internal
998 * preferred combination. This code doesn't know what that preferred
999 * combination is, and Mesa can handle anything valid. Just work instead.
1001 if (_mesa_is_gles(ctx
)) {
1002 if (ctx
->API
== API_OPENGLES2
&&
1003 _mesa_is_color_format(format
) &&
1004 _mesa_get_color_read_format(ctx
) == format
&&
1005 _mesa_get_color_read_type(ctx
) == type
) {
1007 } else if (ctx
->Version
< 30) {
1008 err
= _mesa_es_error_check_format_and_type(format
, type
, 2);
1009 if (err
== GL_NO_ERROR
) {
1010 if (type
== GL_FLOAT
|| type
== GL_HALF_FLOAT_OES
) {
1011 err
= GL_INVALID_OPERATION
;
1015 err
= read_pixels_es3_error_check(format
, type
, rb
);
1018 if (err
== GL_NO_ERROR
&& (format
== GL_DEPTH_COMPONENT
1019 || format
== GL_DEPTH_STENCIL
)) {
1020 err
= GL_INVALID_ENUM
;
1023 if (err
!= GL_NO_ERROR
) {
1024 _mesa_error(ctx
, err
, "glReadPixels(invalid format %s and/or type %s)",
1025 _mesa_lookup_enum_by_nr(format
),
1026 _mesa_lookup_enum_by_nr(type
));
1031 err
= _mesa_error_check_format_and_type(ctx
, format
, type
);
1032 if (err
!= GL_NO_ERROR
) {
1033 _mesa_error(ctx
, err
, "glReadPixels(invalid format %s and/or type %s)",
1034 _mesa_lookup_enum_by_nr(format
),
1035 _mesa_lookup_enum_by_nr(type
));
1039 if (_mesa_is_user_fbo(ctx
->ReadBuffer
) &&
1040 ctx
->ReadBuffer
->Visual
.samples
> 0) {
1041 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glReadPixels(multisample FBO)");
1045 if (!_mesa_source_buffer_exists(ctx
, format
)) {
1046 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glReadPixels(no readbuffer)");
1050 /* Check that the destination format and source buffer are both
1051 * integer-valued or both non-integer-valued.
1053 if (ctx
->Extensions
.EXT_texture_integer
&& _mesa_is_color_format(format
)) {
1054 const struct gl_renderbuffer
*rb
= ctx
->ReadBuffer
->_ColorReadBuffer
;
1055 const GLboolean srcInteger
= _mesa_is_format_integer_color(rb
->Format
);
1056 const GLboolean dstInteger
= _mesa_is_enum_format_integer(format
);
1057 if (dstInteger
!= srcInteger
) {
1058 _mesa_error(ctx
, GL_INVALID_OPERATION
,
1059 "glReadPixels(integer / non-integer format mismatch");
1064 if (width
== 0 || height
== 0)
1065 return; /* nothing to do */
1067 if (!_mesa_validate_pbo_access(2, &ctx
->Pack
, width
, height
, 1,
1068 format
, type
, bufSize
, pixels
)) {
1069 if (_mesa_is_bufferobj(ctx
->Pack
.BufferObj
)) {
1070 _mesa_error(ctx
, GL_INVALID_OPERATION
,
1071 "glReadPixels(out of bounds PBO access)");
1073 _mesa_error(ctx
, GL_INVALID_OPERATION
,
1074 "glReadnPixelsARB(out of bounds access:"
1075 " bufSize (%d) is too small)", bufSize
);
1080 if (_mesa_is_bufferobj(ctx
->Pack
.BufferObj
) &&
1081 _mesa_check_disallowed_mapping(ctx
->Pack
.BufferObj
)) {
1082 /* buffer is mapped - that's an error */
1083 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glReadPixels(PBO is mapped)");
1087 ctx
->Driver
.ReadPixels(ctx
, x
, y
, width
, height
,
1088 format
, type
, &ctx
->Pack
, pixels
);
1092 _mesa_ReadPixels( GLint x
, GLint y
, GLsizei width
, GLsizei height
,
1093 GLenum format
, GLenum type
, GLvoid
*pixels
)
1095 _mesa_ReadnPixelsARB(x
, y
, width
, height
, format
, type
, INT_MAX
, pixels
);