2 * Mesa 3-D graphics library
4 * Copyright (C) 2011 VMware, Inc. 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.
27 * GL_ARB_texture_storage functions
38 #include "texstorage.h"
39 #include "textureview.h"
41 #include "glformats.h"
46 * Check if the given texture target is a legal texture object target
47 * for a glTexStorage() command.
48 * This is a bit different than legal_teximage_target() when it comes
52 legal_texobj_target(const struct gl_context
*ctx
, GLuint dims
, GLenum target
)
54 if (dims
< 1 || dims
> 3) {
55 _mesa_problem(ctx
, "invalid dims=%u in legal_texobj_target()", dims
);
64 case GL_TEXTURE_CUBE_MAP
:
65 return ctx
->Extensions
.ARB_texture_cube_map
;
72 case GL_TEXTURE_2D_ARRAY
:
73 return ctx
->Extensions
.EXT_texture_array
;
74 case GL_TEXTURE_CUBE_MAP_ARRAY
:
75 return _mesa_has_texture_cube_map_array(ctx
);
80 if (!_mesa_is_desktop_gl(ctx
))
87 case GL_PROXY_TEXTURE_1D
:
94 case GL_PROXY_TEXTURE_2D
:
96 case GL_PROXY_TEXTURE_CUBE_MAP
:
97 return ctx
->Extensions
.ARB_texture_cube_map
;
98 case GL_TEXTURE_RECTANGLE
:
99 case GL_PROXY_TEXTURE_RECTANGLE
:
100 return ctx
->Extensions
.NV_texture_rectangle
;
101 case GL_TEXTURE_1D_ARRAY
:
102 case GL_PROXY_TEXTURE_1D_ARRAY
:
103 return ctx
->Extensions
.EXT_texture_array
;
109 case GL_PROXY_TEXTURE_3D
:
111 case GL_PROXY_TEXTURE_2D_ARRAY
:
112 return ctx
->Extensions
.EXT_texture_array
;
113 case GL_PROXY_TEXTURE_CUBE_MAP_ARRAY
:
114 return ctx
->Extensions
.ARB_texture_cube_map_array
;
119 unreachable("impossible dimensions");
124 /** Helper to get a particular texture image in a texture object */
125 static struct gl_texture_image
*
126 get_tex_image(struct gl_context
*ctx
,
127 struct gl_texture_object
*texObj
,
128 GLuint face
, GLuint level
)
130 const GLenum faceTarget
=
131 (texObj
->Target
== GL_TEXTURE_CUBE_MAP
||
132 texObj
->Target
== GL_PROXY_TEXTURE_CUBE_MAP
)
133 ? GL_TEXTURE_CUBE_MAP_POSITIVE_X
+ face
: texObj
->Target
;
134 return _mesa_get_tex_image(ctx
, texObj
, faceTarget
, level
);
140 initialize_texture_fields(struct gl_context
*ctx
,
141 struct gl_texture_object
*texObj
,
143 GLsizei width
, GLsizei height
, GLsizei depth
,
144 GLenum internalFormat
, mesa_format texFormat
)
146 const GLenum target
= texObj
->Target
;
147 const GLuint numFaces
= _mesa_num_tex_faces(target
);
148 GLint level
, levelWidth
= width
, levelHeight
= height
, levelDepth
= depth
;
151 /* Set up all the texture object's gl_texture_images */
152 for (level
= 0; level
< levels
; level
++) {
153 for (face
= 0; face
< numFaces
; face
++) {
154 struct gl_texture_image
*texImage
=
155 get_tex_image(ctx
, texObj
, face
, level
);
158 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glTexStorage");
162 _mesa_init_teximage_fields(ctx
, texImage
,
163 levelWidth
, levelHeight
, levelDepth
,
164 0, internalFormat
, texFormat
);
167 _mesa_next_mipmap_level_size(target
, 0,
168 levelWidth
, levelHeight
, levelDepth
,
169 &levelWidth
, &levelHeight
, &levelDepth
);
176 * Clear all fields of texture object to zeros. Used for proxy texture tests
177 * and to clean up when a texture memory allocation fails.
180 clear_texture_fields(struct gl_context
*ctx
,
181 struct gl_texture_object
*texObj
)
183 const GLenum target
= texObj
->Target
;
184 const GLuint numFaces
= _mesa_num_tex_faces(target
);
188 for (level
= 0; level
< ARRAY_SIZE(texObj
->Image
[0]); level
++) {
189 for (face
= 0; face
< numFaces
; face
++) {
190 struct gl_texture_image
*texImage
=
191 get_tex_image(ctx
, texObj
, face
, level
);
194 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glTexStorage");
198 _mesa_clear_texture_image(ctx
, texImage
);
205 * Update/re-validate framebuffer object.
208 update_fbo_texture(struct gl_context
*ctx
, struct gl_texture_object
*texObj
)
210 const unsigned numFaces
= _mesa_num_tex_faces(texObj
->Target
);
211 for (int level
= 0; level
< ARRAY_SIZE(texObj
->Image
[0]); level
++) {
212 for (unsigned face
= 0; face
< numFaces
; face
++)
213 _mesa_update_fbo_texture(ctx
, texObj
, face
, level
);
219 _mesa_is_legal_tex_storage_format(const struct gl_context
*ctx
,
220 GLenum internalformat
)
222 /* check internal format - note that only sized formats are allowed */
223 switch (internalformat
) {
226 case GL_LUMINANCE_ALPHA
:
233 case GL_DEPTH_COMPONENT
:
234 case GL_DEPTH_STENCIL
:
235 case GL_COMPRESSED_ALPHA
:
236 case GL_COMPRESSED_LUMINANCE_ALPHA
:
237 case GL_COMPRESSED_LUMINANCE
:
238 case GL_COMPRESSED_INTENSITY
:
239 case GL_COMPRESSED_RGB
:
240 case GL_COMPRESSED_RGBA
:
241 case GL_COMPRESSED_SRGB
:
242 case GL_COMPRESSED_SRGB_ALPHA
:
243 case GL_COMPRESSED_SLUMINANCE
:
244 case GL_COMPRESSED_SLUMINANCE_ALPHA
:
246 case GL_GREEN_INTEGER
:
247 case GL_BLUE_INTEGER
:
248 case GL_ALPHA_INTEGER
:
250 case GL_RGBA_INTEGER
:
252 case GL_BGRA_INTEGER
:
253 case GL_LUMINANCE_INTEGER_EXT
:
254 case GL_LUMINANCE_ALPHA_INTEGER_EXT
:
255 /* these unsized formats are illegal */
258 return _mesa_base_tex_format(ctx
, internalformat
) > 0;
264 * Default ctx->Driver.AllocTextureStorage() handler.
266 * The driver can override this with a more specific implementation if it
267 * desires, but this can be used to get the texture images allocated using the
268 * usual texture image handling code. The immutability of
269 * GL_ARB_texture_storage texture layouts is handled by texObj->Immutable
270 * checks at glTexImage* time.
273 _mesa_AllocTextureStorage_sw(struct gl_context
*ctx
,
274 struct gl_texture_object
*texObj
,
275 GLsizei levels
, GLsizei width
,
276 GLsizei height
, GLsizei depth
)
278 const int numFaces
= _mesa_num_tex_faces(texObj
->Target
);
286 for (face
= 0; face
< numFaces
; face
++) {
287 for (level
= 0; level
< levels
; level
++) {
288 struct gl_texture_image
*const texImage
= texObj
->Image
[face
][level
];
289 if (!ctx
->Driver
.AllocTextureImageBuffer(ctx
, texImage
))
299 * Do error checking for calls to glTexStorage1/2/3D().
300 * If an error is found, record it with _mesa_error(), unless the target
301 * is a proxy texture.
302 * \return GL_TRUE if any error, GL_FALSE otherwise.
305 tex_storage_error_check(struct gl_context
*ctx
,
306 struct gl_texture_object
*texObj
,
307 GLuint dims
, GLenum target
,
308 GLsizei levels
, GLenum internalformat
,
309 GLsizei width
, GLsizei height
, GLsizei depth
,
312 const char* suffix
= dsa
? "ture" : "";
314 /* Legal format checking has been moved to texstorage and texturestorage in
315 * order to allow meta functions to use legacy formats. */
318 if (!_mesa_valid_tex_storage_dim(width
, height
, depth
)) {
319 _mesa_error(ctx
, GL_INVALID_VALUE
,
320 "glTex%sStorage%uD(width, height or depth < 1)",
325 if (_mesa_is_compressed_format(ctx
, internalformat
)) {
327 if (!_mesa_target_can_be_compressed(ctx
, target
, internalformat
, &err
)) {
328 _mesa_error(ctx
, err
,
329 "glTex%sStorage%dD(internalformat = %s)", suffix
, dims
,
330 _mesa_enum_to_string(internalformat
));
337 _mesa_error(ctx
, GL_INVALID_VALUE
, "glTex%sStorage%uD(levels < 1)",
342 /* check levels against maximum (note different error than above) */
343 if (levels
> (GLint
) _mesa_max_texture_levels(ctx
, target
)) {
344 _mesa_error(ctx
, GL_INVALID_OPERATION
,
345 "glTex%sStorage%uD(levels too large)",
350 /* check levels against width/height/depth */
351 if (levels
> _mesa_get_tex_max_num_levels(target
, width
, height
, depth
)) {
352 _mesa_error(ctx
, GL_INVALID_OPERATION
,
353 "glTex%sStorage%uD(too many levels"
354 " for max texture dimension)",
359 /* non-default texture object check */
360 if (!_mesa_is_proxy_texture(target
) && (!texObj
|| (texObj
->Name
== 0))) {
361 _mesa_error(ctx
, GL_INVALID_OPERATION
,
362 "glTex%sStorage%uD(texture object 0)",
367 /* Check if texObj->Immutable is set */
368 if (!_mesa_is_proxy_texture(target
) && texObj
->Immutable
) {
369 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glTex%sStorage%uD(immutable)",
374 /* additional checks for depth textures */
375 if (!_mesa_legal_texture_base_format_for_target(ctx
, target
, internalformat
)) {
376 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glTex%sStorage%uD(bad target for texture)",
386 * Helper that does the storage allocation for _mesa_TexStorage1/2/3D()
387 * and _mesa_TextureStorage1/2/3D().
390 _mesa_texture_storage(struct gl_context
*ctx
, GLuint dims
,
391 struct gl_texture_object
*texObj
,
392 GLenum target
, GLsizei levels
,
393 GLenum internalformat
, GLsizei width
,
394 GLsizei height
, GLsizei depth
, bool dsa
)
396 GLboolean sizeOK
, dimensionsOK
;
397 mesa_format texFormat
;
398 const char* suffix
= dsa
? "ture" : "";
402 if (tex_storage_error_check(ctx
, texObj
, dims
, target
, levels
,
403 internalformat
, width
, height
, depth
, dsa
)) {
404 return; /* error was recorded */
407 texFormat
= _mesa_choose_texture_format(ctx
, texObj
, target
, 0,
408 internalformat
, GL_NONE
, GL_NONE
);
409 assert(texFormat
!= MESA_FORMAT_NONE
);
411 /* check that width, height, depth are legal for the mipmap level */
412 dimensionsOK
= _mesa_legal_texture_dimensions(ctx
, target
, 0,
413 width
, height
, depth
, 0);
415 sizeOK
= ctx
->Driver
.TestProxyTexImage(ctx
, target
, levels
, 0, texFormat
,
416 1, width
, height
, depth
);
418 if (_mesa_is_proxy_texture(target
)) {
419 if (dimensionsOK
&& sizeOK
) {
420 initialize_texture_fields(ctx
, texObj
, levels
, width
, height
, depth
,
421 internalformat
, texFormat
);
424 /* clear all image fields for [levels] */
425 clear_texture_fields(ctx
, texObj
);
430 _mesa_error(ctx
, GL_INVALID_VALUE
,
431 "glTex%sStorage%uD(invalid width, height or depth)",
437 _mesa_error(ctx
, GL_OUT_OF_MEMORY
,
438 "glTex%sStorage%uD(texture too large)",
447 if (!initialize_texture_fields(ctx
, texObj
, levels
, width
, height
, depth
,
448 internalformat
, texFormat
)) {
452 /* Do actual texture memory allocation */
453 if (!ctx
->Driver
.AllocTextureStorage(ctx
, texObj
, levels
,
454 width
, height
, depth
)) {
455 /* Reset the texture images' info to zeros.
456 * Strictly speaking, we probably don't have to do this since
457 * generating GL_OUT_OF_MEMORY can leave things in an undefined
458 * state but this puts things in a consistent state.
460 clear_texture_fields(ctx
, texObj
);
461 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glTex%sStorage%uD",
466 _mesa_set_texture_view_state(ctx
, texObj
, target
, levels
);
468 update_fbo_texture(ctx
, texObj
);
474 * Helper used by _mesa_TexStorage1/2/3D().
477 texstorage(GLuint dims
, GLenum target
, GLsizei levels
, GLenum internalformat
,
478 GLsizei width
, GLsizei height
, GLsizei depth
)
480 struct gl_texture_object
*texObj
;
481 GET_CURRENT_CONTEXT(ctx
);
483 /* Check target. This is done here so that _mesa_texture_storage
484 * can receive unsized formats.
486 if (!legal_texobj_target(ctx
, dims
, target
)) {
487 _mesa_error(ctx
, GL_INVALID_ENUM
,
488 "glTexStorage%uD(illegal target=%s)",
489 dims
, _mesa_enum_to_string(target
));
493 if (MESA_VERBOSE
& (VERBOSE_API
|VERBOSE_TEXTURE
))
494 _mesa_debug(ctx
, "glTexStorage%uD %s %d %s %d %d %d\n",
496 _mesa_enum_to_string(target
), levels
,
497 _mesa_enum_to_string(internalformat
),
498 width
, height
, depth
);
500 /* Check the format to make sure it is sized. */
501 if (!_mesa_is_legal_tex_storage_format(ctx
, internalformat
)) {
502 _mesa_error(ctx
, GL_INVALID_ENUM
,
503 "glTexStorage%uD(internalformat = %s)", dims
,
504 _mesa_enum_to_string(internalformat
));
508 texObj
= _mesa_get_current_tex_object(ctx
, target
);
512 _mesa_texture_storage(ctx
, dims
, texObj
, target
, levels
,
513 internalformat
, width
, height
, depth
, false);
518 * Helper used by _mesa_TextureStorage1/2/3D().
521 texturestorage(GLuint dims
, GLuint texture
, GLsizei levels
,
522 GLenum internalformat
, GLsizei width
, GLsizei height
,
525 struct gl_texture_object
*texObj
;
526 GET_CURRENT_CONTEXT(ctx
);
528 if (MESA_VERBOSE
& (VERBOSE_API
|VERBOSE_TEXTURE
))
529 _mesa_debug(ctx
, "glTextureStorage%uD %d %d %s %d %d %d\n",
530 dims
, texture
, levels
,
531 _mesa_enum_to_string(internalformat
),
532 width
, height
, depth
);
534 /* Check the format to make sure it is sized. */
535 if (!_mesa_is_legal_tex_storage_format(ctx
, internalformat
)) {
536 _mesa_error(ctx
, GL_INVALID_ENUM
,
537 "glTextureStorage%uD(internalformat = %s)", dims
,
538 _mesa_enum_to_string(internalformat
));
542 /* Get the texture object by Name. */
543 texObj
= _mesa_lookup_texture(ctx
, texture
);
545 _mesa_error(ctx
, GL_INVALID_OPERATION
,
546 "glTextureStorage%uD(texture = %d)", dims
, texture
);
550 /* Check target. This is done here so that _mesa_texture_storage
551 * can receive unsized formats.
553 if (!legal_texobj_target(ctx
, dims
, texObj
->Target
)) {
554 _mesa_error(ctx
, GL_INVALID_ENUM
,
555 "glTextureStorage%uD(illegal target=%s)",
556 dims
, _mesa_enum_to_string(texObj
->Target
));
560 _mesa_texture_storage(ctx
, dims
, texObj
, texObj
->Target
,
561 levels
, internalformat
, width
, height
, depth
, true);
566 _mesa_TexStorage1D(GLenum target
, GLsizei levels
, GLenum internalformat
,
569 texstorage(1, target
, levels
, internalformat
, width
, 1, 1);
574 _mesa_TexStorage2D(GLenum target
, GLsizei levels
, GLenum internalformat
,
575 GLsizei width
, GLsizei height
)
577 texstorage(2, target
, levels
, internalformat
, width
, height
, 1);
582 _mesa_TexStorage3D(GLenum target
, GLsizei levels
, GLenum internalformat
,
583 GLsizei width
, GLsizei height
, GLsizei depth
)
585 texstorage(3, target
, levels
, internalformat
, width
, height
, depth
);
590 _mesa_TextureStorage1D(GLuint texture
, GLsizei levels
, GLenum internalformat
,
593 texturestorage(1, texture
, levels
, internalformat
, width
, 1, 1);
598 _mesa_TextureStorage2D(GLuint texture
, GLsizei levels
,
599 GLenum internalformat
,
600 GLsizei width
, GLsizei height
)
602 texturestorage(2, texture
, levels
, internalformat
, width
, height
, 1);
607 _mesa_TextureStorage3D(GLuint texture
, GLsizei levels
, GLenum internalformat
,
608 GLsizei width
, GLsizei height
, GLsizei depth
)
610 texturestorage(3, texture
, levels
, internalformat
, width
, height
, depth
);
615 * Note: we don't support GL_EXT_direct_state_access and the spec says
616 * we don't need the following functions. However, glew checks for the
617 * presence of all six functions and will say that GL_ARB_texture_storage
618 * is not supported if these functions are missing.
623 _mesa_TextureStorage1DEXT(GLuint texture
, GLenum target
, GLsizei levels
,
624 GLenum internalformat
,
627 GET_CURRENT_CONTEXT(ctx
);
632 (void) internalformat
;
635 _mesa_error(ctx
, GL_INVALID_OPERATION
,
636 "glTextureStorage1DEXT not supported");
641 _mesa_TextureStorage2DEXT(GLuint texture
, GLenum target
, GLsizei levels
,
642 GLenum internalformat
,
643 GLsizei width
, GLsizei height
)
645 GET_CURRENT_CONTEXT(ctx
);
650 (void) internalformat
;
654 _mesa_error(ctx
, GL_INVALID_OPERATION
,
655 "glTextureStorage2DEXT not supported");
660 _mesa_TextureStorage3DEXT(GLuint texture
, GLenum target
, GLsizei levels
,
661 GLenum internalformat
,
662 GLsizei width
, GLsizei height
, GLsizei depth
)
664 GET_CURRENT_CONTEXT(ctx
);
669 (void) internalformat
;
674 _mesa_error(ctx
, GL_INVALID_OPERATION
,
675 "glTextureStorage3DEXT not supported");