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_clear_texture_image(ctx, texImage);
189 * Update/re-validate framebuffer object.
192 update_fbo_texture(struct gl_context *ctx, struct gl_texture_object *texObj)
194 const unsigned numFaces = _mesa_num_tex_faces(texObj->Target);
195 for (int level = 0; level < ARRAY_SIZE(texObj->Image[0]); level++) {
196 for (unsigned face = 0; face < numFaces; face++)
197 _mesa_update_fbo_texture(ctx, texObj, face, level);
203 _mesa_is_legal_tex_storage_format(const struct gl_context *ctx,
204 GLenum internalformat)
206 /* check internal format - note that only sized formats are allowed */
207 switch (internalformat) {
210 case GL_LUMINANCE_ALPHA:
217 case GL_DEPTH_COMPONENT:
218 case GL_DEPTH_STENCIL:
219 case GL_COMPRESSED_ALPHA:
220 case GL_COMPRESSED_LUMINANCE_ALPHA:
221 case GL_COMPRESSED_LUMINANCE:
222 case GL_COMPRESSED_INTENSITY:
223 case GL_COMPRESSED_RGB:
224 case GL_COMPRESSED_RGBA:
225 case GL_COMPRESSED_SRGB:
226 case GL_COMPRESSED_SRGB_ALPHA:
227 case GL_COMPRESSED_SLUMINANCE:
228 case GL_COMPRESSED_SLUMINANCE_ALPHA:
230 case GL_GREEN_INTEGER:
231 case GL_BLUE_INTEGER:
232 case GL_ALPHA_INTEGER:
234 case GL_RGBA_INTEGER:
236 case GL_BGRA_INTEGER:
237 case GL_LUMINANCE_INTEGER_EXT:
238 case GL_LUMINANCE_ALPHA_INTEGER_EXT:
239 /* these unsized formats are illegal */
242 return _mesa_base_tex_format(ctx, internalformat) > 0;
248 * Default ctx->Driver.AllocTextureStorage() handler.
250 * The driver can override this with a more specific implementation if it
251 * desires, but this can be used to get the texture images allocated using the
252 * usual texture image handling code. The immutability of
253 * GL_ARB_texture_storage texture layouts is handled by texObj->Immutable
254 * checks at glTexImage* time.
257 _mesa_AllocTextureStorage_sw(struct gl_context *ctx,
258 struct gl_texture_object *texObj,
259 GLsizei levels, GLsizei width,
260 GLsizei height, GLsizei depth)
262 const int numFaces = _mesa_num_tex_faces(texObj->Target);
270 for (face = 0; face < numFaces; face++) {
271 for (level = 0; level < levels; level++) {
272 struct gl_texture_image *const texImage = texObj->Image[face][level];
273 if (!ctx->Driver.AllocTextureImageBuffer(ctx, texImage))
283 * Do error checking for calls to glTexStorage1/2/3D().
284 * If an error is found, record it with _mesa_error(), unless the target
285 * is a proxy texture.
286 * \return GL_TRUE if any error, GL_FALSE otherwise.
289 tex_storage_error_check(struct gl_context *ctx,
290 struct gl_texture_object *texObj,
291 GLuint dims, GLenum target,
292 GLsizei levels, GLenum internalformat,
293 GLsizei width, GLsizei height, GLsizei depth,
296 const char* suffix = dsa ? "ture" : "";
298 /* Legal format checking has been moved to texstorage and texturestorage in
299 * order to allow meta functions to use legacy formats. */
302 if (!_mesa_valid_tex_storage_dim(width, height, depth)) {
303 _mesa_error(ctx, GL_INVALID_VALUE,
304 "glTex%sStorage%uD(width, height or depth < 1)",
309 if (_mesa_is_compressed_format(ctx, internalformat)) {
311 if (!_mesa_target_can_be_compressed(ctx, target, internalformat, &err)) {
312 _mesa_error(ctx, err,
313 "glTex%sStorage%dD(internalformat = %s)", suffix, dims,
314 _mesa_enum_to_string(internalformat));
321 _mesa_error(ctx, GL_INVALID_VALUE, "glTex%sStorage%uD(levels < 1)",
326 /* check levels against maximum (note different error than above) */
327 if (levels > (GLint) _mesa_max_texture_levels(ctx, target)) {
328 _mesa_error(ctx, GL_INVALID_OPERATION,
329 "glTex%sStorage%uD(levels too large)",
334 /* check levels against width/height/depth */
335 if (levels > _mesa_get_tex_max_num_levels(target, width, height, depth)) {
336 _mesa_error(ctx, GL_INVALID_OPERATION,
337 "glTex%sStorage%uD(too many levels"
338 " for max texture dimension)",
343 /* non-default texture object check */
344 if (!_mesa_is_proxy_texture(target) && (!texObj || (texObj->Name == 0))) {
345 _mesa_error(ctx, GL_INVALID_OPERATION,
346 "glTex%sStorage%uD(texture object 0)",
351 /* Check if texObj->Immutable is set */
352 if (!_mesa_is_proxy_texture(target) && texObj->Immutable) {
353 _mesa_error(ctx, GL_INVALID_OPERATION, "glTex%sStorage%uD(immutable)",
358 /* additional checks for depth textures */
359 if (!_mesa_legal_texture_base_format_for_target(ctx, target, internalformat)) {
360 _mesa_error(ctx, GL_INVALID_OPERATION, "glTex%sStorage%uD(bad target for texture)",
370 * Helper that does the storage allocation for _mesa_TexStorage1/2/3D()
371 * and _mesa_TextureStorage1/2/3D().
374 _mesa_texture_storage(struct gl_context *ctx, GLuint dims,
375 struct gl_texture_object *texObj,
376 GLenum target, GLsizei levels,
377 GLenum internalformat, GLsizei width,
378 GLsizei height, GLsizei depth, bool dsa)
380 GLboolean sizeOK, dimensionsOK;
381 mesa_format texFormat;
382 const char* suffix = dsa ? "ture" : "";
386 if (tex_storage_error_check(ctx, texObj, dims, target, levels,
387 internalformat, width, height, depth, dsa)) {
388 return; /* error was recorded */
391 texFormat = _mesa_choose_texture_format(ctx, texObj, target, 0,
392 internalformat, GL_NONE, GL_NONE);
393 assert(texFormat != MESA_FORMAT_NONE);
395 /* check that width, height, depth are legal for the mipmap level */
396 dimensionsOK = _mesa_legal_texture_dimensions(ctx, target, 0,
397 width, height, depth, 0);
399 sizeOK = ctx->Driver.TestProxyTexImage(ctx, target, 0, texFormat,
400 width, height, depth, 0);
402 if (_mesa_is_proxy_texture(target)) {
403 if (dimensionsOK && sizeOK) {
404 initialize_texture_fields(ctx, texObj, levels, width, height, depth,
405 internalformat, texFormat);
408 /* clear all image fields for [levels] */
409 clear_texture_fields(ctx, texObj);
414 _mesa_error(ctx, GL_INVALID_VALUE,
415 "glTex%sStorage%uD(invalid width, height or depth)",
421 _mesa_error(ctx, GL_OUT_OF_MEMORY,
422 "glTex%sStorage%uD(texture too large)",
431 if (!initialize_texture_fields(ctx, texObj, levels, width, height, depth,
432 internalformat, texFormat)) {
436 /* Do actual texture memory allocation */
437 if (!ctx->Driver.AllocTextureStorage(ctx, texObj, levels,
438 width, height, depth)) {
439 /* Reset the texture images' info to zeros.
440 * Strictly speaking, we probably don't have to do this since
441 * generating GL_OUT_OF_MEMORY can leave things in an undefined
442 * state but this puts things in a consistent state.
444 clear_texture_fields(ctx, texObj);
445 _mesa_error(ctx, GL_OUT_OF_MEMORY, "glTex%sStorage%uD",
450 _mesa_set_texture_view_state(ctx, texObj, target, levels);
452 update_fbo_texture(ctx, texObj);
458 * Helper used by _mesa_TexStorage1/2/3D().
461 texstorage(GLuint dims, GLenum target, GLsizei levels, GLenum internalformat,
462 GLsizei width, GLsizei height, GLsizei depth)
464 struct gl_texture_object *texObj;
465 GET_CURRENT_CONTEXT(ctx);
467 /* Check target. This is done here so that _mesa_texture_storage
468 * can receive unsized formats.
470 if (!legal_texobj_target(ctx, dims, target)) {
471 _mesa_error(ctx, GL_INVALID_ENUM,
472 "glTexStorage%uD(illegal target=%s)",
473 dims, _mesa_enum_to_string(target));
477 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
478 _mesa_debug(ctx, "glTexStorage%uD %s %d %s %d %d %d\n",
480 _mesa_enum_to_string(target), levels,
481 _mesa_enum_to_string(internalformat),
482 width, height, depth);
484 /* Check the format to make sure it is sized. */
485 if (!_mesa_is_legal_tex_storage_format(ctx, internalformat)) {
486 _mesa_error(ctx, GL_INVALID_ENUM,
487 "glTexStorage%uD(internalformat = %s)", dims,
488 _mesa_enum_to_string(internalformat));
492 texObj = _mesa_get_current_tex_object(ctx, target);
496 _mesa_texture_storage(ctx, dims, texObj, target, levels,
497 internalformat, width, height, depth, false);
502 * Helper used by _mesa_TextureStorage1/2/3D().
505 texturestorage(GLuint dims, GLuint texture, GLsizei levels,
506 GLenum internalformat, GLsizei width, GLsizei height,
509 struct gl_texture_object *texObj;
510 GET_CURRENT_CONTEXT(ctx);
512 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
513 _mesa_debug(ctx, "glTextureStorage%uD %d %d %s %d %d %d\n",
514 dims, texture, levels,
515 _mesa_enum_to_string(internalformat),
516 width, height, depth);
518 /* Check the format to make sure it is sized. */
519 if (!_mesa_is_legal_tex_storage_format(ctx, internalformat)) {
520 _mesa_error(ctx, GL_INVALID_ENUM,
521 "glTextureStorage%uD(internalformat = %s)", dims,
522 _mesa_enum_to_string(internalformat));
526 /* Get the texture object by Name. */
527 texObj = _mesa_lookup_texture(ctx, texture);
529 _mesa_error(ctx, GL_INVALID_OPERATION,
530 "glTextureStorage%uD(texture = %d)", dims, texture);
534 /* Check target. This is done here so that _mesa_texture_storage
535 * can receive unsized formats.
537 if (!legal_texobj_target(ctx, dims, texObj->Target)) {
538 _mesa_error(ctx, GL_INVALID_ENUM,
539 "glTextureStorage%uD(illegal target=%s)",
540 dims, _mesa_enum_to_string(texObj->Target));
544 _mesa_texture_storage(ctx, dims, texObj, texObj->Target,
545 levels, internalformat, width, height, depth, true);
550 _mesa_TexStorage1D(GLenum target, GLsizei levels, GLenum internalformat,
553 texstorage(1, target, levels, internalformat, width, 1, 1);
558 _mesa_TexStorage2D(GLenum target, GLsizei levels, GLenum internalformat,
559 GLsizei width, GLsizei height)
561 texstorage(2, target, levels, internalformat, width, height, 1);
566 _mesa_TexStorage3D(GLenum target, GLsizei levels, GLenum internalformat,
567 GLsizei width, GLsizei height, GLsizei depth)
569 texstorage(3, target, levels, internalformat, width, height, depth);
574 _mesa_TextureStorage1D(GLuint texture, GLsizei levels, GLenum internalformat,
577 texturestorage(1, texture, levels, internalformat, width, 1, 1);
582 _mesa_TextureStorage2D(GLuint texture, GLsizei levels,
583 GLenum internalformat,
584 GLsizei width, GLsizei height)
586 texturestorage(2, texture, levels, internalformat, width, height, 1);
591 _mesa_TextureStorage3D(GLuint texture, GLsizei levels, GLenum internalformat,
592 GLsizei width, GLsizei height, GLsizei depth)
594 texturestorage(3, texture, levels, internalformat, width, height, depth);
599 * Note: we don't support GL_EXT_direct_state_access and the spec says
600 * we don't need the following functions. However, glew checks for the
601 * presence of all six functions and will say that GL_ARB_texture_storage
602 * is not supported if these functions are missing.
607 _mesa_TextureStorage1DEXT(GLuint texture, GLenum target, GLsizei levels,
608 GLenum internalformat,
611 GET_CURRENT_CONTEXT(ctx);
616 (void) internalformat;
619 _mesa_error(ctx, GL_INVALID_OPERATION,
620 "glTextureStorage1DEXT not supported");
625 _mesa_TextureStorage2DEXT(GLuint texture, GLenum target, GLsizei levels,
626 GLenum internalformat,
627 GLsizei width, GLsizei height)
629 GET_CURRENT_CONTEXT(ctx);
634 (void) internalformat;
638 _mesa_error(ctx, GL_INVALID_OPERATION,
639 "glTextureStorage2DEXT not supported");
644 _mesa_TextureStorage3DEXT(GLuint texture, GLenum target, GLsizei levels,
645 GLenum internalformat,
646 GLsizei width, GLsizei height, GLsizei depth)
648 GET_CURRENT_CONTEXT(ctx);
653 (void) internalformat;
658 _mesa_error(ctx, GL_INVALID_OPERATION,
659 "glTextureStorage3DEXT not supported");