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