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(struct gl_context
*ctx
, GLuint dims
, GLenum target
)
54 if (_mesa_is_gles3(ctx
)
55 && target
!= GL_TEXTURE_2D
56 && target
!= GL_TEXTURE_CUBE_MAP
57 && target
!= GL_TEXTURE_3D
58 && target
!= GL_TEXTURE_2D_ARRAY
)
65 case GL_PROXY_TEXTURE_1D
:
73 case GL_PROXY_TEXTURE_2D
:
75 case GL_TEXTURE_CUBE_MAP
:
76 case GL_PROXY_TEXTURE_CUBE_MAP
:
77 return ctx
->Extensions
.ARB_texture_cube_map
;
78 case GL_TEXTURE_RECTANGLE
:
79 case GL_PROXY_TEXTURE_RECTANGLE
:
80 return ctx
->Extensions
.NV_texture_rectangle
;
81 case GL_TEXTURE_1D_ARRAY
:
82 case GL_PROXY_TEXTURE_1D_ARRAY
:
83 return ctx
->Extensions
.EXT_texture_array
;
90 case GL_PROXY_TEXTURE_3D
:
92 case GL_TEXTURE_2D_ARRAY
:
93 case GL_PROXY_TEXTURE_2D_ARRAY
:
94 return ctx
->Extensions
.EXT_texture_array
;
95 case GL_TEXTURE_CUBE_MAP_ARRAY
:
96 case GL_PROXY_TEXTURE_CUBE_MAP_ARRAY
:
97 return ctx
->Extensions
.ARB_texture_cube_map_array
;
102 _mesa_problem(ctx
, "invalid dims=%u in legal_texobj_target()", dims
);
108 /** Helper to get a particular texture image in a texture object */
109 static struct gl_texture_image
*
110 get_tex_image(struct gl_context
*ctx
,
111 struct gl_texture_object
*texObj
,
112 GLuint face
, GLuint level
)
114 const GLenum faceTarget
=
115 (texObj
->Target
== GL_TEXTURE_CUBE_MAP
||
116 texObj
->Target
== GL_PROXY_TEXTURE_CUBE_MAP
)
117 ? GL_TEXTURE_CUBE_MAP_POSITIVE_X
+ face
: texObj
->Target
;
118 return _mesa_get_tex_image(ctx
, texObj
, faceTarget
, level
);
124 initialize_texture_fields(struct gl_context
*ctx
,
125 struct gl_texture_object
*texObj
,
127 GLsizei width
, GLsizei height
, GLsizei depth
,
128 GLenum internalFormat
, mesa_format texFormat
)
130 const GLenum target
= texObj
->Target
;
131 const GLuint numFaces
= _mesa_num_tex_faces(target
);
132 GLint level
, levelWidth
= width
, levelHeight
= height
, levelDepth
= depth
;
135 /* Set up all the texture object's gl_texture_images */
136 for (level
= 0; level
< levels
; level
++) {
137 for (face
= 0; face
< numFaces
; face
++) {
138 struct gl_texture_image
*texImage
=
139 get_tex_image(ctx
, texObj
, face
, level
);
142 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glTexStorage");
146 _mesa_init_teximage_fields(ctx
, texImage
,
147 levelWidth
, levelHeight
, levelDepth
,
148 0, internalFormat
, texFormat
);
151 _mesa_next_mipmap_level_size(target
, 0,
152 levelWidth
, levelHeight
, levelDepth
,
153 &levelWidth
, &levelHeight
, &levelDepth
);
160 * Clear all fields of texture object to zeros. Used for proxy texture tests
161 * and to clean up when a texture memory allocation fails.
164 clear_texture_fields(struct gl_context
*ctx
,
165 struct gl_texture_object
*texObj
)
167 const GLenum target
= texObj
->Target
;
168 const GLuint numFaces
= _mesa_num_tex_faces(target
);
172 for (level
= 0; level
< ARRAY_SIZE(texObj
->Image
[0]); level
++) {
173 for (face
= 0; face
< numFaces
; face
++) {
174 struct gl_texture_image
*texImage
=
175 get_tex_image(ctx
, texObj
, face
, level
);
178 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glTexStorage");
182 _mesa_init_teximage_fields(ctx
, texImage
,
183 0, 0, 0, 0, /* w, h, d, border */
184 GL_NONE
, MESA_FORMAT_NONE
);
191 * Update/re-validate framebuffer object.
194 update_fbo_texture(struct gl_context
*ctx
, struct gl_texture_object
*texObj
)
196 const unsigned numFaces
= _mesa_num_tex_faces(texObj
->Target
);
197 for (int level
= 0; level
< ARRAY_SIZE(texObj
->Image
[0]); level
++) {
198 for (unsigned face
= 0; face
< numFaces
; face
++)
199 _mesa_update_fbo_texture(ctx
, texObj
, face
, level
);
205 _mesa_is_legal_tex_storage_format(const struct gl_context
*ctx
,
206 GLenum internalformat
)
208 /* check internal format - note that only sized formats are allowed */
209 switch (internalformat
) {
212 case GL_LUMINANCE_ALPHA
:
219 case GL_DEPTH_COMPONENT
:
220 case GL_DEPTH_STENCIL
:
221 case GL_COMPRESSED_ALPHA
:
222 case GL_COMPRESSED_LUMINANCE_ALPHA
:
223 case GL_COMPRESSED_LUMINANCE
:
224 case GL_COMPRESSED_INTENSITY
:
225 case GL_COMPRESSED_RGB
:
226 case GL_COMPRESSED_RGBA
:
227 case GL_COMPRESSED_SRGB
:
228 case GL_COMPRESSED_SRGB_ALPHA
:
229 case GL_COMPRESSED_SLUMINANCE
:
230 case GL_COMPRESSED_SLUMINANCE_ALPHA
:
232 case GL_GREEN_INTEGER
:
233 case GL_BLUE_INTEGER
:
234 case GL_ALPHA_INTEGER
:
236 case GL_RGBA_INTEGER
:
238 case GL_BGRA_INTEGER
:
239 case GL_LUMINANCE_INTEGER_EXT
:
240 case GL_LUMINANCE_ALPHA_INTEGER_EXT
:
241 /* these unsized formats are illegal */
244 return _mesa_base_tex_format(ctx
, internalformat
) > 0;
250 * Default ctx->Driver.AllocTextureStorage() handler.
252 * The driver can override this with a more specific implementation if it
253 * desires, but this can be used to get the texture images allocated using the
254 * usual texture image handling code. The immutability of
255 * GL_ARB_texture_storage texture layouts is handled by texObj->Immutable
256 * checks at glTexImage* time.
259 _mesa_AllocTextureStorage_sw(struct gl_context
*ctx
,
260 struct gl_texture_object
*texObj
,
261 GLsizei levels
, GLsizei width
,
262 GLsizei height
, GLsizei depth
)
264 const int numFaces
= _mesa_num_tex_faces(texObj
->Target
);
272 for (face
= 0; face
< numFaces
; face
++) {
273 for (level
= 0; level
< levels
; level
++) {
274 struct gl_texture_image
*const texImage
= texObj
->Image
[face
][level
];
275 if (!ctx
->Driver
.AllocTextureImageBuffer(ctx
, texImage
))
285 * Do error checking for calls to glTexStorage1/2/3D().
286 * If an error is found, record it with _mesa_error(), unless the target
287 * is a proxy texture.
288 * \return GL_TRUE if any error, GL_FALSE otherwise.
291 tex_storage_error_check(struct gl_context
*ctx
,
292 struct gl_texture_object
*texObj
,
293 GLuint dims
, GLenum target
,
294 GLsizei levels
, GLenum internalformat
,
295 GLsizei width
, GLsizei height
, GLsizei depth
,
298 const char* suffix
= dsa
? "ture" : "";
300 /* Legal format checking has been moved to texstorage and texturestorage in
301 * order to allow meta functions to use legacy formats. */
304 if (!_mesa_valid_tex_storage_dim(width
, height
, depth
)) {
305 _mesa_error(ctx
, GL_INVALID_VALUE
,
306 "glTex%sStorage%uD(width, height or depth < 1)",
311 if (_mesa_is_compressed_format(ctx
, internalformat
)) {
313 if (!_mesa_target_can_be_compressed(ctx
, target
, internalformat
, &err
)) {
314 _mesa_error(ctx
, err
,
315 "glTex%sStorage%dD(internalformat = %s)", suffix
, dims
,
316 _mesa_enum_to_string(internalformat
));
323 _mesa_error(ctx
, GL_INVALID_VALUE
, "glTex%sStorage%uD(levels < 1)",
328 /* check levels against maximum (note different error than above) */
329 if (levels
> (GLint
) _mesa_max_texture_levels(ctx
, target
)) {
330 _mesa_error(ctx
, GL_INVALID_OPERATION
,
331 "glTex%sStorage%uD(levels too large)",
336 /* check levels against width/height/depth */
337 if (levels
> _mesa_get_tex_max_num_levels(target
, width
, height
, depth
)) {
338 _mesa_error(ctx
, GL_INVALID_OPERATION
,
339 "glTex%sStorage%uD(too many levels"
340 " for max texture dimension)",
345 /* non-default texture object check */
346 if (!_mesa_is_proxy_texture(target
) && (!texObj
|| (texObj
->Name
== 0))) {
347 _mesa_error(ctx
, GL_INVALID_OPERATION
,
348 "glTex%sStorage%uD(texture object 0)",
353 /* Check if texObj->Immutable is set */
354 if (!_mesa_is_proxy_texture(target
) && texObj
->Immutable
) {
355 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glTex%sStorage%uD(immutable)",
360 /* additional checks for depth textures */
361 if (!_mesa_legal_texture_base_format_for_target(ctx
, target
, internalformat
)) {
362 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glTex%sStorage%uD(bad target for texture)",
372 * Helper that does the storage allocation for _mesa_TexStorage1/2/3D()
373 * and _mesa_TextureStorage1/2/3D().
376 _mesa_texture_storage(struct gl_context
*ctx
, GLuint dims
,
377 struct gl_texture_object
*texObj
,
378 GLenum target
, GLsizei levels
,
379 GLenum internalformat
, GLsizei width
,
380 GLsizei height
, GLsizei depth
, bool dsa
)
382 GLboolean sizeOK
, dimensionsOK
;
383 mesa_format texFormat
;
384 const char* suffix
= dsa
? "ture" : "";
388 if (tex_storage_error_check(ctx
, texObj
, dims
, target
, levels
,
389 internalformat
, width
, height
, depth
, dsa
)) {
390 return; /* error was recorded */
393 texFormat
= _mesa_choose_texture_format(ctx
, texObj
, target
, 0,
394 internalformat
, GL_NONE
, GL_NONE
);
395 assert(texFormat
!= MESA_FORMAT_NONE
);
397 /* check that width, height, depth are legal for the mipmap level */
398 dimensionsOK
= _mesa_legal_texture_dimensions(ctx
, target
, 0,
399 width
, height
, depth
, 0);
401 sizeOK
= ctx
->Driver
.TestProxyTexImage(ctx
, target
, 0, texFormat
,
402 width
, height
, depth
, 0);
404 if (_mesa_is_proxy_texture(target
)) {
405 if (dimensionsOK
&& sizeOK
) {
406 initialize_texture_fields(ctx
, texObj
, levels
, width
, height
, depth
,
407 internalformat
, texFormat
);
410 /* clear all image fields for [levels] */
411 clear_texture_fields(ctx
, texObj
);
416 _mesa_error(ctx
, GL_INVALID_VALUE
,
417 "glTex%sStorage%uD(invalid width, height or depth)",
423 _mesa_error(ctx
, GL_OUT_OF_MEMORY
,
424 "glTex%sStorage%uD(texture too large)",
433 if (!initialize_texture_fields(ctx
, texObj
, levels
, width
, height
, depth
,
434 internalformat
, texFormat
)) {
438 /* Do actual texture memory allocation */
439 if (!ctx
->Driver
.AllocTextureStorage(ctx
, texObj
, levels
,
440 width
, height
, depth
)) {
441 /* Reset the texture images' info to zeros.
442 * Strictly speaking, we probably don't have to do this since
443 * generating GL_OUT_OF_MEMORY can leave things in an undefined
444 * state but this puts things in a consistent state.
446 clear_texture_fields(ctx
, texObj
);
447 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glTex%sStorage%uD",
452 _mesa_set_texture_view_state(ctx
, texObj
, target
, levels
);
454 update_fbo_texture(ctx
, texObj
);
460 * Helper used by _mesa_TexStorage1/2/3D().
463 texstorage(GLuint dims
, GLenum target
, GLsizei levels
, GLenum internalformat
,
464 GLsizei width
, GLsizei height
, GLsizei depth
)
466 struct gl_texture_object
*texObj
;
467 GET_CURRENT_CONTEXT(ctx
);
469 /* Check target. This is done here so that _mesa_texture_storage
470 * can receive unsized formats.
472 if (!legal_texobj_target(ctx
, dims
, target
)) {
473 _mesa_error(ctx
, GL_INVALID_ENUM
,
474 "glTexStorage%uD(illegal target=%s)",
475 dims
, _mesa_enum_to_string(target
));
479 if (MESA_VERBOSE
& (VERBOSE_API
|VERBOSE_TEXTURE
))
480 _mesa_debug(ctx
, "glTexStorage%uD %s %d %s %d %d %d\n",
482 _mesa_enum_to_string(target
), levels
,
483 _mesa_enum_to_string(internalformat
),
484 width
, height
, depth
);
486 /* Check the format to make sure it is sized. */
487 if (!_mesa_is_legal_tex_storage_format(ctx
, internalformat
)) {
488 _mesa_error(ctx
, GL_INVALID_ENUM
,
489 "glTexStorage%uD(internalformat = %s)", dims
,
490 _mesa_enum_to_string(internalformat
));
494 texObj
= _mesa_get_current_tex_object(ctx
, target
);
498 _mesa_texture_storage(ctx
, dims
, texObj
, target
, levels
,
499 internalformat
, width
, height
, depth
, false);
504 * Helper used by _mesa_TextureStorage1/2/3D().
507 texturestorage(GLuint dims
, GLuint texture
, GLsizei levels
,
508 GLenum internalformat
, GLsizei width
, GLsizei height
,
511 struct gl_texture_object
*texObj
;
512 GET_CURRENT_CONTEXT(ctx
);
514 if (MESA_VERBOSE
& (VERBOSE_API
|VERBOSE_TEXTURE
))
515 _mesa_debug(ctx
, "glTextureStorage%uD %d %d %s %d %d %d\n",
516 dims
, texture
, levels
,
517 _mesa_enum_to_string(internalformat
),
518 width
, height
, depth
);
520 /* Check the format to make sure it is sized. */
521 if (!_mesa_is_legal_tex_storage_format(ctx
, internalformat
)) {
522 _mesa_error(ctx
, GL_INVALID_ENUM
,
523 "glTextureStorage%uD(internalformat = %s)", dims
,
524 _mesa_enum_to_string(internalformat
));
528 /* Get the texture object by Name. */
529 texObj
= _mesa_lookup_texture(ctx
, texture
);
531 _mesa_error(ctx
, GL_INVALID_OPERATION
,
532 "glTextureStorage%uD(texture = %d)", dims
, texture
);
536 /* Check target. This is done here so that _mesa_texture_storage
537 * can receive unsized formats.
539 if (!legal_texobj_target(ctx
, dims
, texObj
->Target
)) {
540 _mesa_error(ctx
, GL_INVALID_ENUM
,
541 "glTextureStorage%uD(illegal target=%s)",
542 dims
, _mesa_enum_to_string(texObj
->Target
));
546 _mesa_texture_storage(ctx
, dims
, texObj
, texObj
->Target
,
547 levels
, internalformat
, width
, height
, depth
, true);
552 _mesa_TexStorage1D(GLenum target
, GLsizei levels
, GLenum internalformat
,
555 texstorage(1, target
, levels
, internalformat
, width
, 1, 1);
560 _mesa_TexStorage2D(GLenum target
, GLsizei levels
, GLenum internalformat
,
561 GLsizei width
, GLsizei height
)
563 texstorage(2, target
, levels
, internalformat
, width
, height
, 1);
568 _mesa_TexStorage3D(GLenum target
, GLsizei levels
, GLenum internalformat
,
569 GLsizei width
, GLsizei height
, GLsizei depth
)
571 texstorage(3, target
, levels
, internalformat
, width
, height
, depth
);
576 _mesa_TextureStorage1D(GLuint texture
, GLsizei levels
, GLenum internalformat
,
579 texturestorage(1, texture
, levels
, internalformat
, width
, 1, 1);
584 _mesa_TextureStorage2D(GLuint texture
, GLsizei levels
,
585 GLenum internalformat
,
586 GLsizei width
, GLsizei height
)
588 texturestorage(2, texture
, levels
, internalformat
, width
, height
, 1);
593 _mesa_TextureStorage3D(GLuint texture
, GLsizei levels
, GLenum internalformat
,
594 GLsizei width
, GLsizei height
, GLsizei depth
)
596 texturestorage(3, texture
, levels
, internalformat
, width
, height
, depth
);
601 * Note: we don't support GL_EXT_direct_state_access and the spec says
602 * we don't need the following functions. However, glew checks for the
603 * presence of all six functions and will say that GL_ARB_texture_storage
604 * is not supported if these functions are missing.
609 _mesa_TextureStorage1DEXT(GLuint texture
, GLenum target
, GLsizei levels
,
610 GLenum internalformat
,
613 GET_CURRENT_CONTEXT(ctx
);
618 (void) internalformat
;
621 _mesa_error(ctx
, GL_INVALID_OPERATION
,
622 "glTextureStorage1DEXT not supported");
627 _mesa_TextureStorage2DEXT(GLuint texture
, GLenum target
, GLsizei levels
,
628 GLenum internalformat
,
629 GLsizei width
, GLsizei height
)
631 GET_CURRENT_CONTEXT(ctx
);
636 (void) internalformat
;
640 _mesa_error(ctx
, GL_INVALID_OPERATION
,
641 "glTextureStorage2DEXT not supported");
646 _mesa_TextureStorage3DEXT(GLuint texture
, GLenum target
, GLsizei levels
,
647 GLenum internalformat
,
648 GLsizei width
, GLsizei height
, GLsizei depth
)
650 GET_CURRENT_CONTEXT(ctx
);
655 (void) internalformat
;
660 _mesa_error(ctx
, GL_INVALID_OPERATION
,
661 "glTextureStorage3DEXT not supported");