2 * Mesa 3-D graphics library
4 * Copyright (C) 2014 Intel Corporation. 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.
25 * Jason Ekstrand <jason.ekstrand@intel.com>
32 #include "copyimage.h"
36 #include "textureview.h"
37 #include "glformats.h"
39 enum mesa_block_class
{
45 * Prepare the source or destination resource. This involves error
46 * checking and returning the relevant gl_texture_image or gl_renderbuffer.
47 * Note that one of the resulting tex_image or renderbuffer pointers will be
48 * NULL and the other will be non-null.
50 * \param name the texture or renderbuffer name
51 * \param target One of GL_TEXTURE_x target or GL_RENDERBUFFER
52 * \param level mipmap level
53 * \param z src or dest Z
54 * \param depth number of slices/faces/layers to copy
55 * \param tex_image returns a pointer to a texture image
56 * \param renderbuffer returns a pointer to a renderbuffer
57 * \return true if success, false if error
60 prepare_target_err(struct gl_context
*ctx
, GLuint name
, GLenum target
,
61 int level
, int z
, int depth
,
62 struct gl_texture_image
**tex_image
,
63 struct gl_renderbuffer
**renderbuffer
,
65 GLenum
*internalFormat
,
69 const char *dbg_prefix
)
72 _mesa_error(ctx
, GL_INVALID_VALUE
,
73 "glCopyImageSubData(%sName = %d)", dbg_prefix
, name
);
78 * INVALID_ENUM is generated
79 * * if either <srcTarget> or <dstTarget>
80 * - is not RENDERBUFFER or a valid non-proxy texture target
81 * - is TEXTURE_BUFFER, or
82 * - is one of the cubemap face selectors described in table 3.17,
86 /* Not a texture target, but valid */
88 case GL_TEXTURE_1D_ARRAY
:
91 case GL_TEXTURE_CUBE_MAP
:
92 case GL_TEXTURE_RECTANGLE
:
93 case GL_TEXTURE_2D_ARRAY
:
94 case GL_TEXTURE_CUBE_MAP_ARRAY
:
95 case GL_TEXTURE_2D_MULTISAMPLE
:
96 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY
:
97 /* These are all valid */
99 case GL_TEXTURE_EXTERNAL_OES
:
100 /* Only exists in ES */
101 case GL_TEXTURE_BUFFER
:
103 _mesa_error(ctx
, GL_INVALID_ENUM
,
104 "glCopyImageSubData(%sTarget = %s)", dbg_prefix
,
105 _mesa_enum_to_string(target
));
109 if (target
== GL_RENDERBUFFER
) {
110 struct gl_renderbuffer
*rb
= _mesa_lookup_renderbuffer(ctx
, name
);
113 _mesa_error(ctx
, GL_INVALID_VALUE
,
114 "glCopyImageSubData(%sName = %u)", dbg_prefix
, name
);
119 _mesa_error(ctx
, GL_INVALID_OPERATION
,
120 "glCopyImageSubData(%sName incomplete)", dbg_prefix
);
125 _mesa_error(ctx
, GL_INVALID_VALUE
,
126 "glCopyImageSubData(%sLevel = %u)", dbg_prefix
, level
);
131 *format
= rb
->Format
;
132 *internalFormat
= rb
->InternalFormat
;
134 *height
= rb
->Height
;
135 *num_samples
= rb
->NumSamples
;
138 struct gl_texture_object
*texObj
= _mesa_lookup_texture(ctx
, name
);
142 * From GL_ARB_copy_image specification:
143 * "INVALID_VALUE is generated if either <srcName> or <dstName> does
144 * not correspond to a valid renderbuffer or texture object according
145 * to the corresponding target parameter."
147 _mesa_error(ctx
, GL_INVALID_VALUE
,
148 "glCopyImageSubData(%sName = %u)", dbg_prefix
, name
);
152 _mesa_test_texobj_completeness(ctx
, texObj
);
153 if (!texObj
->_BaseComplete
||
154 (level
!= 0 && !texObj
->_MipmapComplete
)) {
155 _mesa_error(ctx
, GL_INVALID_OPERATION
,
156 "glCopyImageSubData(%sName incomplete)", dbg_prefix
);
160 /* Note that target will not be a cube face name */
161 if (texObj
->Target
!= target
) {
163 * From GL_ARB_copy_image_specification:
164 * "INVALID_ENUM is generated if the target does not match the type
167 _mesa_error(ctx
, GL_INVALID_ENUM
,
168 "glCopyImageSubData(%sTarget = %s)", dbg_prefix
,
169 _mesa_enum_to_string(target
));
173 if (level
< 0 || level
>= MAX_TEXTURE_LEVELS
) {
174 _mesa_error(ctx
, GL_INVALID_VALUE
,
175 "glCopyImageSubData(%sLevel = %d)", dbg_prefix
, level
);
179 if (target
== GL_TEXTURE_CUBE_MAP
) {
182 assert(z
< MAX_FACES
); /* should have been caught earlier */
184 /* make sure all the cube faces are present */
185 for (i
= 0; i
< depth
; i
++) {
186 if (!texObj
->Image
[z
+i
][level
]) {
187 /* missing cube face */
188 _mesa_error(ctx
, GL_INVALID_VALUE
,
189 "glCopyImageSubData(missing cube face)");
194 *tex_image
= texObj
->Image
[z
][level
];
197 *tex_image
= _mesa_select_tex_image(texObj
, target
, level
);
201 _mesa_error(ctx
, GL_INVALID_VALUE
,
202 "glCopyImageSubData(%sLevel = %u)", dbg_prefix
, level
);
206 *renderbuffer
= NULL
;
207 *format
= (*tex_image
)->TexFormat
;
208 *internalFormat
= (*tex_image
)->InternalFormat
;
209 *width
= (*tex_image
)->Width
;
210 *height
= (*tex_image
)->Height
;
211 *num_samples
= (*tex_image
)->NumSamples
;
218 prepare_target(struct gl_context
*ctx
, GLuint name
, GLenum target
,
220 struct gl_texture_image
**texImage
,
221 struct gl_renderbuffer
**renderbuffer
)
223 if (target
== GL_RENDERBUFFER
) {
224 struct gl_renderbuffer
*rb
= _mesa_lookup_renderbuffer(ctx
, name
);
229 struct gl_texture_object
*texObj
= _mesa_lookup_texture(ctx
, name
);
231 if (target
== GL_TEXTURE_CUBE_MAP
) {
232 *texImage
= texObj
->Image
[z
][level
];
235 *texImage
= _mesa_select_tex_image(texObj
, target
, level
);
238 *renderbuffer
= NULL
;
243 * Check that the x,y,z,width,height,region is within the texture image
245 * \return true if bounds OK, false if regions is out of bounds
248 check_region_bounds(struct gl_context
*ctx
,
250 const struct gl_texture_image
*tex_image
,
251 const struct gl_renderbuffer
*renderbuffer
,
252 int x
, int y
, int z
, int width
, int height
, int depth
,
253 const char *dbg_prefix
)
255 int surfWidth
, surfHeight
, surfDepth
;
257 if (width
< 0 || height
< 0 || depth
< 0) {
258 _mesa_error(ctx
, GL_INVALID_VALUE
,
259 "glCopyImageSubData(%sWidth, %sHeight, or %sDepth is negative)",
260 dbg_prefix
, dbg_prefix
, dbg_prefix
);
264 if (x
< 0 || y
< 0 || z
< 0) {
265 _mesa_error(ctx
, GL_INVALID_VALUE
,
266 "glCopyImageSubData(%sX, %sY, or %sZ is negative)",
267 dbg_prefix
, dbg_prefix
, dbg_prefix
);
271 /* Check X direction */
272 if (target
== GL_RENDERBUFFER
) {
273 surfWidth
= renderbuffer
->Width
;
276 surfWidth
= tex_image
->Width
;
279 if (x
+ width
> surfWidth
) {
280 _mesa_error(ctx
, GL_INVALID_VALUE
,
281 "glCopyImageSubData(%sX or %sWidth exceeds image bounds)",
282 dbg_prefix
, dbg_prefix
);
286 /* Check Y direction */
288 case GL_RENDERBUFFER
:
289 surfHeight
= renderbuffer
->Height
;
292 case GL_TEXTURE_1D_ARRAY
:
296 surfHeight
= tex_image
->Height
;
299 if (y
+ height
> surfHeight
) {
300 _mesa_error(ctx
, GL_INVALID_VALUE
,
301 "glCopyImageSubData(%sY or %sHeight exceeds image bounds)",
302 dbg_prefix
, dbg_prefix
);
306 /* Check Z direction */
308 case GL_RENDERBUFFER
:
311 case GL_TEXTURE_2D_MULTISAMPLE
:
312 case GL_TEXTURE_RECTANGLE
:
315 case GL_TEXTURE_CUBE_MAP
:
318 case GL_TEXTURE_1D_ARRAY
:
319 surfDepth
= tex_image
->Height
;
322 surfDepth
= tex_image
->Depth
;
325 if (z
< 0 || z
+ depth
> surfDepth
) {
326 _mesa_error(ctx
, GL_INVALID_VALUE
,
327 "glCopyImageSubData(%sZ or %sDepth exceeds image bounds)",
328 dbg_prefix
, dbg_prefix
);
336 compressed_format_compatible(const struct gl_context
*ctx
,
337 GLenum compressedFormat
, GLenum otherFormat
)
339 enum mesa_block_class compressedClass
, otherClass
;
341 /* Two view-incompatible compressed formats are never compatible. */
342 if (_mesa_is_compressed_format(ctx
, otherFormat
)) {
347 * From ARB_copy_image spec:
348 * Table 4.X.1 (Compatible internal formats for copying between
349 * compressed and uncompressed internal formats)
350 * ---------------------------------------------------------------------
351 * | Texel / | Uncompressed | |
352 * | Block | internal format | Compressed internal format |
354 * ---------------------------------------------------------------------
355 * | 128-bit | RGBA32UI, | COMPRESSED_RGBA_S3TC_DXT3_EXT, |
356 * | | RGBA32I, | COMPRESSED_SRGB_ALPHA_S3TC_DXT3_EXT,|
357 * | | RGBA32F | COMPRESSED_RGBA_S3TC_DXT5_EXT, |
358 * | | | COMPRESSED_SRGB_ALPHA_S3TC_DXT5_EXT,|
359 * | | | COMPRESSED_RG_RGTC2, |
360 * | | | COMPRESSED_SIGNED_RG_RGTC2, |
361 * | | | COMPRESSED_RGBA_BPTC_UNORM, |
362 * | | | COMPRESSED_SRGB_ALPHA_BPTC_UNORM, |
363 * | | | COMPRESSED_RGB_BPTC_SIGNED_FLOAT, |
364 * | | | COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT |
365 * ---------------------------------------------------------------------
366 * | 64-bit | RGBA16F, RG32F, | COMPRESSED_RGB_S3TC_DXT1_EXT, |
367 * | | RGBA16UI, RG32UI, | COMPRESSED_SRGB_S3TC_DXT1_EXT, |
368 * | | RGBA16I, RG32I, | COMPRESSED_RGBA_S3TC_DXT1_EXT, |
369 * | | RGBA16, | COMPRESSED_SRGB_ALPHA_S3TC_DXT1_EXT,|
370 * | | RGBA16_SNORM | COMPRESSED_RED_RGTC1, |
371 * | | | COMPRESSED_SIGNED_RED_RGTC1 |
372 * ---------------------------------------------------------------------
375 switch (compressedFormat
) {
376 case GL_COMPRESSED_RGBA_S3TC_DXT3_EXT
:
377 case GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT3_EXT
:
378 case GL_COMPRESSED_RGBA_S3TC_DXT5_EXT
:
379 case GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT5_EXT
:
380 case GL_COMPRESSED_RG_RGTC2
:
381 case GL_COMPRESSED_SIGNED_RG_RGTC2
:
382 case GL_COMPRESSED_RGBA_BPTC_UNORM
:
383 case GL_COMPRESSED_SRGB_ALPHA_BPTC_UNORM
:
384 case GL_COMPRESSED_RGB_BPTC_SIGNED_FLOAT
:
385 case GL_COMPRESSED_RGB_BPTC_UNSIGNED_FLOAT
:
386 compressedClass
= BLOCK_CLASS_128_BITS
;
388 case GL_COMPRESSED_RGB_S3TC_DXT1_EXT
:
389 case GL_COMPRESSED_SRGB_S3TC_DXT1_EXT
:
390 case GL_COMPRESSED_RGBA_S3TC_DXT1_EXT
:
391 case GL_COMPRESSED_SRGB_ALPHA_S3TC_DXT1_EXT
:
392 case GL_COMPRESSED_RED_RGTC1
:
393 case GL_COMPRESSED_SIGNED_RED_RGTC1
:
394 compressedClass
= BLOCK_CLASS_64_BITS
;
396 case GL_COMPRESSED_RGBA8_ETC2_EAC
:
397 case GL_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC
:
398 case GL_COMPRESSED_RG11_EAC
:
399 case GL_COMPRESSED_SIGNED_RG11_EAC
:
400 if (_mesa_is_gles(ctx
))
401 compressedClass
= BLOCK_CLASS_128_BITS
;
405 case GL_COMPRESSED_RGB8_ETC2
:
406 case GL_COMPRESSED_SRGB8_ETC2
:
407 case GL_COMPRESSED_R11_EAC
:
408 case GL_COMPRESSED_SIGNED_R11_EAC
:
409 case GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2
:
410 case GL_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2
:
411 if (_mesa_is_gles(ctx
))
412 compressedClass
= BLOCK_CLASS_64_BITS
;
417 if (_mesa_is_gles(ctx
) && _mesa_is_astc_format(compressedFormat
))
418 compressedClass
= BLOCK_CLASS_128_BITS
;
424 switch (otherFormat
) {
428 otherClass
= BLOCK_CLASS_128_BITS
;
437 case GL_RGBA16_SNORM
:
438 otherClass
= BLOCK_CLASS_64_BITS
;
444 return compressedClass
== otherClass
;
448 copy_format_compatible(const struct gl_context
*ctx
,
449 GLenum srcFormat
, GLenum dstFormat
)
452 * From ARB_copy_image spec:
453 * For the purposes of CopyImageSubData, two internal formats
454 * are considered compatible if any of the following conditions are
456 * * the formats are the same,
457 * * the formats are considered compatible according to the
458 * compatibility rules used for texture views as defined in
459 * section 3.9.X. In particular, if both internal formats are listed
460 * in the same entry of Table 3.X.2, they are considered compatible, or
461 * * one format is compressed and the other is uncompressed and
462 * Table 4.X.1 lists the two formats in the same row.
465 if (_mesa_texture_view_compatible_format(ctx
, srcFormat
, dstFormat
)) {
466 /* Also checks if formats are equal. */
468 } else if (_mesa_is_compressed_format(ctx
, srcFormat
)) {
469 return compressed_format_compatible(ctx
, srcFormat
, dstFormat
);
470 } else if (_mesa_is_compressed_format(ctx
, dstFormat
)) {
471 return compressed_format_compatible(ctx
, dstFormat
, srcFormat
);
478 _mesa_CopyImageSubData(GLuint srcName
, GLenum srcTarget
, GLint srcLevel
,
479 GLint srcX
, GLint srcY
, GLint srcZ
,
480 GLuint dstName
, GLenum dstTarget
, GLint dstLevel
,
481 GLint dstX
, GLint dstY
, GLint dstZ
,
482 GLsizei srcWidth
, GLsizei srcHeight
, GLsizei srcDepth
)
484 GET_CURRENT_CONTEXT(ctx
);
485 struct gl_texture_image
*srcTexImage
, *dstTexImage
;
486 struct gl_renderbuffer
*srcRenderbuffer
, *dstRenderbuffer
;
487 mesa_format srcFormat
, dstFormat
;
488 GLenum srcIntFormat
, dstIntFormat
;
489 GLuint src_w
, src_h
, dst_w
, dst_h
;
490 GLuint src_bw
, src_bh
, dst_bw
, dst_bh
;
491 GLuint src_num_samples
, dst_num_samples
;
492 int dstWidth
, dstHeight
, dstDepth
;
495 if (MESA_VERBOSE
& VERBOSE_API
)
496 _mesa_debug(ctx
, "glCopyImageSubData(%u, %s, %d, %d, %d, %d, "
497 "%u, %s, %d, %d, %d, %d, "
499 srcName
, _mesa_enum_to_string(srcTarget
), srcLevel
,
501 dstName
, _mesa_enum_to_string(dstTarget
), dstLevel
,
503 srcWidth
, srcHeight
, srcDepth
);
505 if (!ctx
->Extensions
.ARB_copy_image
) {
506 _mesa_error(ctx
, GL_INVALID_OPERATION
,
507 "glCopyImageSubData(extension not available)");
511 if (!prepare_target_err(ctx
, srcName
, srcTarget
, srcLevel
, srcZ
, srcDepth
,
512 &srcTexImage
, &srcRenderbuffer
, &srcFormat
,
513 &srcIntFormat
, &src_w
, &src_h
, &src_num_samples
,
517 if (!prepare_target_err(ctx
, dstName
, dstTarget
, dstLevel
, dstZ
, srcDepth
,
518 &dstTexImage
, &dstRenderbuffer
, &dstFormat
,
519 &dstIntFormat
, &dst_w
, &dst_h
, &dst_num_samples
,
523 _mesa_get_format_block_size(srcFormat
, &src_bw
, &src_bh
);
525 /* Section 18.3.2 (Copying Between Images) of the OpenGL 4.5 Core Profile
528 * An INVALID_VALUE error is generated if the dimensions of either
529 * subregion exceeds the boundaries of the corresponding image object,
530 * or if the image format is compressed and the dimensions of the
531 * subregion fail to meet the alignment constraints of the format.
533 * and Section 8.7 (Compressed Texture Images) says:
535 * An INVALID_OPERATION error is generated if any of the following
538 * * width is not a multiple of four, and width + xoffset is not
539 * equal to the value of TEXTURE_WIDTH.
540 * * height is not a multiple of four, and height + yoffset is not
541 * equal to the value of TEXTURE_HEIGHT.
543 * so we take that to mean that you can copy the "last" block of a
544 * compressed texture image even if it's smaller than the minimum block
547 if ((srcX
% src_bw
!= 0) || (srcY
% src_bh
!= 0) ||
548 (srcWidth
% src_bw
!= 0 && (srcX
+ srcWidth
) != src_w
) ||
549 (srcHeight
% src_bh
!= 0 && (srcY
+ srcHeight
) != src_h
)) {
550 _mesa_error(ctx
, GL_INVALID_VALUE
,
551 "glCopyImageSubData(unaligned src rectangle)");
555 _mesa_get_format_block_size(dstFormat
, &dst_bw
, &dst_bh
);
556 if ((dstX
% dst_bw
!= 0) || (dstY
% dst_bh
!= 0)) {
557 _mesa_error(ctx
, GL_INVALID_VALUE
,
558 "glCopyImageSubData(unaligned dst rectangle)");
562 /* From the GL_ARB_copy_image spec:
564 * "The dimensions are always specified in texels, even for compressed
565 * texture formats. But it should be noted that if only one of the
566 * source and destination textures is compressed then the number of
567 * texels touched in the compressed image will be a factor of the
568 * block size larger than in the uncompressed image."
570 * So, if copying from compressed to uncompressed, the dest region is
571 * shrunk by the src block size factor. If copying from uncompressed
572 * to compressed, the dest region is grown by the dest block size factor.
573 * Note that we're passed the _source_ width, height, depth and those
574 * dimensions are never changed.
576 dstWidth
= srcWidth
* dst_bw
/ src_bw
;
577 dstHeight
= srcHeight
* dst_bh
/ src_bh
;
580 if (!check_region_bounds(ctx
, srcTarget
, srcTexImage
, srcRenderbuffer
,
581 srcX
, srcY
, srcZ
, srcWidth
, srcHeight
, srcDepth
,
585 if (!check_region_bounds(ctx
, dstTarget
, dstTexImage
, dstRenderbuffer
,
586 dstX
, dstY
, dstZ
, dstWidth
, dstHeight
, dstDepth
,
590 /* Section 18.3.2 (Copying Between Images) of the OpenGL 4.5 Core Profile
593 * An INVALID_OPERATION error is generated if either object is a texture
594 * and the texture is not complete, if the source and destination internal
595 * formats are not compatible, or if the number of samples do not match.
597 if (!copy_format_compatible(ctx
, srcIntFormat
, dstIntFormat
)) {
598 _mesa_error(ctx
, GL_INVALID_OPERATION
,
599 "glCopyImageSubData(internalFormat mismatch)");
603 if (src_num_samples
!= dst_num_samples
) {
604 _mesa_error(ctx
, GL_INVALID_OPERATION
,
605 "glCopyImageSubData(number of samples mismatch)");
609 /* loop over 2D slices/faces/layers */
610 for (i
= 0; i
< srcDepth
; ++i
) {
611 int newSrcZ
= srcZ
+ i
;
612 int newDstZ
= dstZ
+ i
;
615 srcTexImage
->TexObject
->Target
== GL_TEXTURE_CUBE_MAP
) {
616 /* need to update srcTexImage pointer for the cube face */
617 assert(srcZ
+ i
< MAX_FACES
);
618 srcTexImage
= srcTexImage
->TexObject
->Image
[srcZ
+ i
][srcLevel
];
624 dstTexImage
->TexObject
->Target
== GL_TEXTURE_CUBE_MAP
) {
625 /* need to update dstTexImage pointer for the cube face */
626 assert(dstZ
+ i
< MAX_FACES
);
627 dstTexImage
= dstTexImage
->TexObject
->Image
[dstZ
+ i
][dstLevel
];
632 ctx
->Driver
.CopyImageSubData(ctx
,
633 srcTexImage
, srcRenderbuffer
,
635 dstTexImage
, dstRenderbuffer
,
637 srcWidth
, srcHeight
);