src/mesa/main/texstorage.c

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 2011  VMware, Inc.  All Rights Reserved.
   5  *
   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:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  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.
  23  */
  24
  25
  26 /**
  27  * \file texstorage.c
  28  * GL_ARB_texture_storage functions
  29  */
  30
  31
  32
  33 #include "glheader.h"
  34 #include "context.h"
  35 #include "enums.h"
  36 #include "imports.h"
  37 #include "macros.h"
  38 #include "teximage.h"
  39 #include "texobj.h"
  40 #include "mipmap.h"
  41 #include "texstorage.h"
  42 #include "textureview.h"
  43 #include "mtypes.h"
  44 #include "glformats.h"
  45
  46
  47
  48 /**
  49  * Check if the given texture target is a legal texture object target
  50  * for a glTexStorage() command.
  51  * This is a bit different than legal_teximage_target() when it comes
  52  * to cube maps.
  53  */
  54 static GLboolean
  55 legal_texobj_target(struct gl_context *ctx, GLuint dims, GLenum target)
  56 {
  57    if (_mesa_is_gles3(ctx)
  58        && target != GL_TEXTURE_2D
  59        && target != GL_TEXTURE_CUBE_MAP
  60        && target != GL_TEXTURE_3D
  61        && target != GL_TEXTURE_2D_ARRAY)
  62       return GL_FALSE;
  63
  64    switch (dims) {
  65    case 1:
  66       switch (target) {
  67       case GL_TEXTURE_1D:
  68       case GL_PROXY_TEXTURE_1D:
  69          return GL_TRUE;
  70       default:
  71          return GL_FALSE;
  72       }
  73    case 2:
  74       switch (target) {
  75       case GL_TEXTURE_2D:
  76       case GL_PROXY_TEXTURE_2D:
  77          return GL_TRUE;
  78       case GL_TEXTURE_CUBE_MAP:
  79       case GL_PROXY_TEXTURE_CUBE_MAP:
  80          return ctx->Extensions.ARB_texture_cube_map;
  81       case GL_TEXTURE_RECTANGLE:
  82       case GL_PROXY_TEXTURE_RECTANGLE:
  83          return ctx->Extensions.NV_texture_rectangle;
  84       case GL_TEXTURE_1D_ARRAY:
  85       case GL_PROXY_TEXTURE_1D_ARRAY:
  86          return ctx->Extensions.EXT_texture_array;
  87       default:
  88          return GL_FALSE;
  89       }
  90    case 3:
  91       switch (target) {
  92       case GL_TEXTURE_3D:
  93       case GL_PROXY_TEXTURE_3D:
  94          return GL_TRUE;
  95       case GL_TEXTURE_2D_ARRAY:
  96       case GL_PROXY_TEXTURE_2D_ARRAY:
  97          return ctx->Extensions.EXT_texture_array;
  98       case GL_TEXTURE_CUBE_MAP_ARRAY:
  99       case GL_PROXY_TEXTURE_CUBE_MAP_ARRAY:
 100          return ctx->Extensions.ARB_texture_cube_map_array;
 101       default:
 102          return GL_FALSE;
 103       }
 104    default:
 105       _mesa_problem(ctx, "invalid dims=%u in legal_texobj_target()", dims);
 106       return GL_FALSE;
 107    }
 108 }
 109
 110
 111 /** Helper to get a particular texture image in a texture object */
 112 static struct gl_texture_image *
 113 get_tex_image(struct gl_context *ctx,
 114               struct gl_texture_object *texObj,
 115               GLuint face, GLuint level)
 116 {
 117    const GLenum faceTarget =
 118       (texObj->Target == GL_TEXTURE_CUBE_MAP ||
 119        texObj->Target == GL_PROXY_TEXTURE_CUBE_MAP)
 120       ? GL_TEXTURE_CUBE_MAP_POSITIVE_X + face : texObj->Target;
 121    return _mesa_get_tex_image(ctx, texObj, faceTarget, level);
 122 }
 123
 124
 125
 126 static GLboolean
 127 initialize_texture_fields(struct gl_context *ctx,
 128                           struct gl_texture_object *texObj,
 129                           GLint levels,
 130                           GLsizei width, GLsizei height, GLsizei depth,
 131                           GLenum internalFormat, mesa_format texFormat)
 132 {
 133    const GLenum target = texObj->Target;
 134    const GLuint numFaces = _mesa_num_tex_faces(target);
 135    GLint level, levelWidth = width, levelHeight = height, levelDepth = depth;
 136    GLuint face;
 137
 138    /* Set up all the texture object's gl_texture_images */
 139    for (level = 0; level < levels; level++) {
 140       for (face = 0; face < numFaces; face++) {
 141          struct gl_texture_image *texImage =
 142             get_tex_image(ctx, texObj, face, level);
 143
 144          if (!texImage) {
 145             _mesa_error(ctx, GL_OUT_OF_MEMORY, "glTexStorage");
 146             return GL_FALSE;
 147          }
 148
 149          _mesa_init_teximage_fields(ctx, texImage,
 150                                     levelWidth, levelHeight, levelDepth,
 151                                     0, internalFormat, texFormat);
 152       }
 153
 154       _mesa_next_mipmap_level_size(target, 0, levelWidth, levelHeight, levelDepth,
 155                                    &levelWidth, &levelHeight, &levelDepth);
 156    }
 157    return GL_TRUE;
 158 }
 159
 160
 161 /**
 162  * Clear all fields of texture object to zeros.  Used for proxy texture tests
 163  * and to clean up when a texture memory allocation fails.
 164  */
 165 static void
 166 clear_texture_fields(struct gl_context *ctx,
 167                      struct gl_texture_object *texObj)
 168 {
 169    const GLenum target = texObj->Target;
 170    const GLuint numFaces = _mesa_num_tex_faces(target);
 171    GLint level;
 172    GLuint face;
 173
 174    for (level = 0; level < Elements(texObj->Image[0]); level++) {
 175       for (face = 0; face < numFaces; face++) {
 176          struct gl_texture_image *texImage =
 177             get_tex_image(ctx, texObj, face, level);
 178
 179          if (!texImage) {
 180             _mesa_error(ctx, GL_OUT_OF_MEMORY, "glTexStorage");
 181             return;
 182          }
 183
 184          _mesa_init_teximage_fields(ctx, texImage,
 185                                     0, 0, 0, 0, /* w, h, d, border */
 186                                     GL_NONE, MESA_FORMAT_NONE);
 187       }
 188    }
 189 }
 190
 191
 192 GLboolean
 193 _mesa_is_legal_tex_storage_format(struct gl_context *ctx, GLenum internalformat)
 194 {
 195    /* check internal format - note that only sized formats are allowed */
 196    switch (internalformat) {
 197    case GL_ALPHA:
 198    case GL_LUMINANCE:
 199    case GL_LUMINANCE_ALPHA:
 200    case GL_INTENSITY:
 201    case GL_RED:
 202    case GL_RG:
 203    case GL_RGB:
 204    case GL_RGBA:
 205    case GL_BGRA:
 206    case GL_DEPTH_COMPONENT:
 207    case GL_DEPTH_STENCIL:
 208    case GL_COMPRESSED_ALPHA:
 209    case GL_COMPRESSED_LUMINANCE_ALPHA:
 210    case GL_COMPRESSED_LUMINANCE:
 211    case GL_COMPRESSED_INTENSITY:
 212    case GL_COMPRESSED_RGB:
 213    case GL_COMPRESSED_RGBA:
 214    case GL_COMPRESSED_SRGB:
 215    case GL_COMPRESSED_SRGB_ALPHA:
 216    case GL_COMPRESSED_SLUMINANCE:
 217    case GL_COMPRESSED_SLUMINANCE_ALPHA:
 218    case GL_RED_INTEGER:
 219    case GL_GREEN_INTEGER:
 220    case GL_BLUE_INTEGER:
 221    case GL_ALPHA_INTEGER:
 222    case GL_RGB_INTEGER:
 223    case GL_RGBA_INTEGER:
 224    case GL_BGR_INTEGER:
 225    case GL_BGRA_INTEGER:
 226    case GL_LUMINANCE_INTEGER_EXT:
 227    case GL_LUMINANCE_ALPHA_INTEGER_EXT:
 228       /* these unsized formats are illegal */
 229       return GL_FALSE;
 230    default:
 231       return _mesa_base_tex_format(ctx, internalformat) > 0;
 232    }
 233 }
 234
 235 /**
 236  * Default ctx->Driver.AllocTextureStorage() handler.
 237  *
 238  * The driver can override this with a more specific implementation if it
 239  * desires, but this can be used to get the texture images allocated using the
 240  * usual texture image handling code.  The immutability of
 241  * GL_ARB_texture_storage texture layouts is handled by texObj->Immutable
 242  * checks at glTexImage* time.
 243  */
 244 GLboolean
 245 _mesa_AllocTextureStorage_sw(struct gl_context *ctx,
 246                              struct gl_texture_object *texObj,
 247                              GLsizei levels, GLsizei width,
 248                              GLsizei height, GLsizei depth)
 249 {
 250    const int numFaces = _mesa_num_tex_faces(texObj->Target);
 251    int face;
 252    int level;
 253
 254    (void) width;
 255    (void) height;
 256    (void) depth;
 257
 258    for (face = 0; face < numFaces; face++) {
 259       for (level = 0; level < levels; level++) {
 260          struct gl_texture_image *const texImage = texObj->Image[face][level];
 261          if (!ctx->Driver.AllocTextureImageBuffer(ctx, texImage))
 262             return GL_FALSE;
 263       }
 264    }
 265
 266    return GL_TRUE;
 267 }
 268
 269
 270 /**
 271  * Do error checking for calls to glTexStorage1/2/3D().
 272  * If an error is found, record it with _mesa_error(), unless the target
 273  * is a proxy texture.
 274  * \return GL_TRUE if any error, GL_FALSE otherwise.
 275  */
 276 static GLboolean
 277 tex_storage_error_check(struct gl_context *ctx, GLuint dims, GLenum target,
 278                         GLsizei levels, GLenum internalformat,
 279                         GLsizei width, GLsizei height, GLsizei depth)
 280 {
 281    struct gl_texture_object *texObj;
 282
 283    if (!_mesa_is_legal_tex_storage_format(ctx, internalformat)) {
 284       _mesa_error(ctx, GL_INVALID_ENUM,
 285                   "glTexStorage%uD(internalformat = %s)", dims,
 286                   _mesa_lookup_enum_by_nr(internalformat));
 287       return GL_TRUE;
 288    }
 289
 290    /* size check */
 291    if (width < 1 || height < 1 || depth < 1) {
 292       _mesa_error(ctx, GL_INVALID_VALUE,
 293                   "glTexStorage%uD(width, height or depth < 1)", dims);
 294       return GL_TRUE;
 295    }
 296
 297    /* target check */
 298    if (!legal_texobj_target(ctx, dims, target)) {
 299       _mesa_error(ctx, GL_INVALID_ENUM,
 300                   "glTexStorage%uD(illegal target=%s)",
 301                   dims, _mesa_lookup_enum_by_nr(target));
 302       return GL_TRUE;
 303    }
 304
 305    /* From section 3.8.6, page 146 of OpenGL ES 3.0 spec:
 306     *
 307     *    "The ETC2/EAC texture compression algorithm supports only
 308     *     two-dimensional images. If internalformat is an ETC2/EAC format,
 309     *     CompressedTexImage3D will generate an INVALID_OPERATION error if
 310     *     target is not TEXTURE_2D_ARRAY."
 311     *
 312     * This should also be applicable for glTexStorage3D().
 313     */
 314    if (_mesa_is_compressed_format(ctx, internalformat)
 315        && !_mesa_target_can_be_compressed(ctx, target, internalformat)) {
 316       _mesa_error(ctx, _mesa_is_desktop_gl(ctx)?
 317                   GL_INVALID_ENUM : GL_INVALID_OPERATION,
 318                   "glTexStorage3D(internalformat = %s)",
 319                   _mesa_lookup_enum_by_nr(internalformat));
 320    }
 321
 322    /* levels check */
 323    if (levels < 1) {
 324       _mesa_error(ctx, GL_INVALID_VALUE, "glTexStorage%uD(levels < 1)",
 325                   dims);
 326       return GL_TRUE;
 327    }
 328
 329    /* check levels against maximum (note different error than above) */
 330    if (levels > (GLint) _mesa_max_texture_levels(ctx, target)) {
 331       _mesa_error(ctx, GL_INVALID_OPERATION,
 332                   "glTexStorage%uD(levels too large)", dims);
 333       return GL_TRUE;
 334    }
 335
 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                   "glTexStorage%uD(too many levels for max texture dimension)",
 340                   dims);
 341       return GL_TRUE;
 342    }
 343
 344    /* non-default texture object check */
 345    texObj = _mesa_get_current_tex_object(ctx, target);
 346    if (!_mesa_is_proxy_texture(target) && (!texObj || (texObj->Name == 0))) {
 347       _mesa_error(ctx, GL_INVALID_OPERATION,
 348                   "glTexStorage%uD(texture object 0)", dims);
 349       return GL_TRUE;
 350    }
 351
 352    /* Check if texObj->Immutable is set */
 353    if (!_mesa_is_proxy_texture(target) && texObj->Immutable) {
 354       _mesa_error(ctx, GL_INVALID_OPERATION, "glTexStorage%uD(immutable)",
 355                   dims);
 356       return GL_TRUE;
 357    }
 358
 359    /* additional checks for depth textures */
 360    if (!_mesa_legal_texture_base_format_for_target(ctx, target, internalformat,
 361                                                    dims, "glTexStorage"))
 362       return GL_TRUE;
 363
 364    return GL_FALSE;
 365 }
 366
 367
 368 /**
 369  * Helper used by _mesa_TexStorage1/2/3D().
 370  */
 371 static void
 372 texstorage(GLuint dims, GLenum target, GLsizei levels, GLenum internalformat,
 373            GLsizei width, GLsizei height, GLsizei depth)
 374 {
 375    struct gl_texture_object *texObj;
 376    GLboolean sizeOK, dimensionsOK;
 377    mesa_format texFormat;
 378
 379    GET_CURRENT_CONTEXT(ctx);
 380
 381    if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
 382       _mesa_debug(ctx, "glTexStorage%uD %s %d %s %d %d %d\n",
 383                   dims,
 384                   _mesa_lookup_enum_by_nr(target), levels,
 385                   _mesa_lookup_enum_by_nr(internalformat),
 386                   width, height, depth);
 387
 388    if (tex_storage_error_check(ctx, dims, target, levels,
 389                                internalformat, width, height, depth)) {
 390       return; /* error was recorded */
 391    }
 392
 393    texObj = _mesa_get_current_tex_object(ctx, target);
 394    assert(texObj);
 395
 396    texFormat = _mesa_choose_texture_format(ctx, texObj, target, 0,
 397                                            internalformat, GL_NONE, GL_NONE);
 398    assert(texFormat != MESA_FORMAT_NONE);
 399
 400    /* check that width, height, depth are legal for the mipmap level */
 401    dimensionsOK = _mesa_legal_texture_dimensions(ctx, target, 0,
 402                                                   width, height, depth, 0);
 403
 404    sizeOK = ctx->Driver.TestProxyTexImage(ctx, target, 0, texFormat,
 405                                           width, height, depth, 0);
 406
 407    if (_mesa_is_proxy_texture(texObj->Target)) {
 408       if (dimensionsOK && sizeOK) {
 409          initialize_texture_fields(ctx, texObj, levels, width, height, depth,
 410                                    internalformat, texFormat);
 411       }
 412       else {
 413          /* clear all image fields for [levels] */
 414          clear_texture_fields(ctx, texObj);
 415       }
 416    }
 417    else {
 418       if (!dimensionsOK) {
 419          _mesa_error(ctx, GL_INVALID_VALUE,
 420                      "glTexStorage%uD(invalid width, height or depth)", dims);
 421          return;
 422       }
 423
 424       if (!sizeOK) {
 425          _mesa_error(ctx, GL_OUT_OF_MEMORY,
 426                      "glTexStorage%uD(texture too large)", dims);
 427       }
 428
 429       assert(levels > 0);
 430       assert(width > 0);
 431       assert(height > 0);
 432       assert(depth > 0);
 433
 434       if (!initialize_texture_fields(ctx, texObj, levels, width, height, depth,
 435                                      internalformat, texFormat)) {
 436          return;
 437       }
 438
 439       /* Do actual texture memory allocation */
 440       if (!ctx->Driver.AllocTextureStorage(ctx, texObj, levels,
 441                                            width, height, depth)) {
 442          /* Reset the texture images' info to zeros.
 443           * Strictly speaking, we probably don't have to do this since
 444           * generating GL_OUT_OF_MEMORY can leave things in an undefined
 445           * state but this puts things in a consistent state.
 446           */
 447          clear_texture_fields(ctx, texObj);
 448          _mesa_error(ctx, GL_OUT_OF_MEMORY, "glTexStorage%uD", dims);
 449          return;
 450       }
 451
 452       _mesa_set_texture_view_state(ctx, texObj, target, levels);
 453
 454    }
 455 }
 456
 457
 458 void GLAPIENTRY
 459 _mesa_TexStorage1D(GLenum target, GLsizei levels, GLenum internalformat,
 460                    GLsizei width)
 461 {
 462    texstorage(1, target, levels, internalformat, width, 1, 1);
 463 }
 464
 465
 466 void GLAPIENTRY
 467 _mesa_TexStorage2D(GLenum target, GLsizei levels, GLenum internalformat,
 468                    GLsizei width, GLsizei height)
 469 {
 470    texstorage(2, target, levels, internalformat, width, height, 1);
 471 }
 472
 473
 474 void GLAPIENTRY
 475 _mesa_TexStorage3D(GLenum target, GLsizei levels, GLenum internalformat,
 476                    GLsizei width, GLsizei height, GLsizei depth)
 477 {
 478    texstorage(3, target, levels, internalformat, width, height, depth);
 479 }
 480
 481
 482
 483 /*
 484  * Note: we don't support GL_EXT_direct_state_access and the spec says
 485  * we don't need the following functions.  However, glew checks for the
 486  * presence of all six functions and will say that GL_ARB_texture_storage
 487  * is not supported if these functions are missing.
 488  */
 489
 490
 491 void GLAPIENTRY
 492 _mesa_TextureStorage1DEXT(GLuint texture, GLenum target, GLsizei levels,
 493                           GLenum internalformat,
 494                           GLsizei width)
 495 {
 496    GET_CURRENT_CONTEXT(ctx);
 497
 498    (void) texture;
 499    (void) target;
 500    (void) levels;
 501    (void) internalformat;
 502    (void) width;
 503
 504    _mesa_error(ctx, GL_INVALID_OPERATION,
 505                "glTextureStorage1DEXT not supported");
 506 }
 507
 508
 509 void GLAPIENTRY
 510 _mesa_TextureStorage2DEXT(GLuint texture, GLenum target, GLsizei levels,
 511                           GLenum internalformat,
 512                           GLsizei width, GLsizei height)
 513 {
 514    GET_CURRENT_CONTEXT(ctx);
 515
 516    (void) texture;
 517    (void) target;
 518    (void) levels;
 519    (void) internalformat;
 520    (void) width;
 521    (void) height;
 522
 523    _mesa_error(ctx, GL_INVALID_OPERATION,
 524                "glTextureStorage2DEXT not supported");
 525 }
 526
 527
 528
 529 void GLAPIENTRY
 530 _mesa_TextureStorage3DEXT(GLuint texture, GLenum target, GLsizei levels,
 531                           GLenum internalformat,
 532                           GLsizei width, GLsizei height, GLsizei depth)
 533 {
 534    GET_CURRENT_CONTEXT(ctx);
 535
 536    (void) texture;
 537    (void) target;
 538    (void) levels;
 539    (void) internalformat;
 540    (void) width;
 541    (void) height;
 542    (void) depth;
 543
 544    _mesa_error(ctx, GL_INVALID_OPERATION,
 545                "glTextureStorage3DEXT not supported");
 546 }