3 * Texture object management.
7 * Mesa 3-D graphics library
9 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included
19 * in all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27 * OTHER DEALINGS IN THE SOFTWARE.
32 #include "bufferobj.h"
40 #include "shaderimage.h"
45 #include "program/prog_instruction.h"
49 /**********************************************************************/
50 /** \name Internal functions */
54 * This function checks for all valid combinations of Min and Mag filters for
55 * Float types, when extensions like OES_texture_float and
56 * OES_texture_float_linear are supported. OES_texture_float mentions support
57 * for NEAREST, NEAREST_MIPMAP_NEAREST magnification and minification filters.
58 * Mag filters like LINEAR and min filters like NEAREST_MIPMAP_LINEAR,
59 * LINEAR_MIPMAP_NEAREST and LINEAR_MIPMAP_LINEAR are only valid in case
60 * OES_texture_float_linear is supported.
62 * Returns true in case the filter is valid for given Float type else false.
65 valid_filter_for_float(const struct gl_context *ctx,
66 const struct gl_texture_object *obj)
68 switch (obj->Sampler.MagFilter) {
70 if (obj->_IsHalfFloat && !ctx->Extensions.OES_texture_half_float_linear) {
72 } else if (obj->_IsFloat && !ctx->Extensions.OES_texture_float_linear) {
76 case GL_NEAREST_MIPMAP_NEAREST:
79 unreachable("Invalid mag filter");
82 switch (obj->Sampler.MinFilter) {
84 case GL_NEAREST_MIPMAP_LINEAR:
85 case GL_LINEAR_MIPMAP_NEAREST:
86 case GL_LINEAR_MIPMAP_LINEAR:
87 if (obj->_IsHalfFloat && !ctx->Extensions.OES_texture_half_float_linear) {
89 } else if (obj->_IsFloat && !ctx->Extensions.OES_texture_float_linear) {
93 case GL_NEAREST_MIPMAP_NEAREST:
96 unreachable("Invalid min filter");
103 * Return the gl_texture_object for a given ID.
105 struct gl_texture_object *
106 _mesa_lookup_texture(struct gl_context *ctx, GLuint id)
108 return (struct gl_texture_object *)
109 _mesa_HashLookup(ctx->Shared->TexObjects, id);
113 * Wrapper around _mesa_lookup_texture that throws GL_INVALID_OPERATION if id
114 * is not in the hash table. After calling _mesa_error, it returns NULL.
116 struct gl_texture_object *
117 _mesa_lookup_texture_err(struct gl_context *ctx, GLuint id, const char* func)
119 struct gl_texture_object *texObj;
121 texObj = _mesa_lookup_texture(ctx, id); /* Returns NULL if not found. */
124 _mesa_error(ctx, GL_INVALID_OPERATION, "%s(texture)", func);
130 _mesa_begin_texture_lookups(struct gl_context *ctx)
132 _mesa_HashLockMutex(ctx->Shared->TexObjects);
137 _mesa_end_texture_lookups(struct gl_context *ctx)
139 _mesa_HashUnlockMutex(ctx->Shared->TexObjects);
143 struct gl_texture_object *
144 _mesa_lookup_texture_locked(struct gl_context *ctx, GLuint id)
146 return (struct gl_texture_object *)
147 _mesa_HashLookupLocked(ctx->Shared->TexObjects, id);
151 * Return a pointer to the current texture object for the given target
152 * on the current texture unit.
153 * Note: all <target> error checking should have been done by this point.
155 struct gl_texture_object *
156 _mesa_get_current_tex_object(struct gl_context *ctx, GLenum target)
158 struct gl_texture_unit *texUnit = _mesa_get_current_tex_unit(ctx);
159 const GLboolean arrayTex = ctx->Extensions.EXT_texture_array;
163 return texUnit->CurrentTex[TEXTURE_1D_INDEX];
164 case GL_PROXY_TEXTURE_1D:
165 return ctx->Texture.ProxyTex[TEXTURE_1D_INDEX];
167 return texUnit->CurrentTex[TEXTURE_2D_INDEX];
168 case GL_PROXY_TEXTURE_2D:
169 return ctx->Texture.ProxyTex[TEXTURE_2D_INDEX];
171 return texUnit->CurrentTex[TEXTURE_3D_INDEX];
172 case GL_PROXY_TEXTURE_3D:
173 return ctx->Texture.ProxyTex[TEXTURE_3D_INDEX];
174 case GL_TEXTURE_CUBE_MAP_POSITIVE_X_ARB:
175 case GL_TEXTURE_CUBE_MAP_NEGATIVE_X_ARB:
176 case GL_TEXTURE_CUBE_MAP_POSITIVE_Y_ARB:
177 case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y_ARB:
178 case GL_TEXTURE_CUBE_MAP_POSITIVE_Z_ARB:
179 case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z_ARB:
180 case GL_TEXTURE_CUBE_MAP_ARB:
181 return ctx->Extensions.ARB_texture_cube_map
182 ? texUnit->CurrentTex[TEXTURE_CUBE_INDEX] : NULL;
183 case GL_PROXY_TEXTURE_CUBE_MAP_ARB:
184 return ctx->Extensions.ARB_texture_cube_map
185 ? ctx->Texture.ProxyTex[TEXTURE_CUBE_INDEX] : NULL;
186 case GL_TEXTURE_CUBE_MAP_ARRAY:
187 return ctx->Extensions.ARB_texture_cube_map_array
188 ? texUnit->CurrentTex[TEXTURE_CUBE_ARRAY_INDEX] : NULL;
189 case GL_PROXY_TEXTURE_CUBE_MAP_ARRAY:
190 return ctx->Extensions.ARB_texture_cube_map_array
191 ? ctx->Texture.ProxyTex[TEXTURE_CUBE_ARRAY_INDEX] : NULL;
192 case GL_TEXTURE_RECTANGLE_NV:
193 return ctx->Extensions.NV_texture_rectangle
194 ? texUnit->CurrentTex[TEXTURE_RECT_INDEX] : NULL;
195 case GL_PROXY_TEXTURE_RECTANGLE_NV:
196 return ctx->Extensions.NV_texture_rectangle
197 ? ctx->Texture.ProxyTex[TEXTURE_RECT_INDEX] : NULL;
198 case GL_TEXTURE_1D_ARRAY_EXT:
199 return arrayTex ? texUnit->CurrentTex[TEXTURE_1D_ARRAY_INDEX] : NULL;
200 case GL_PROXY_TEXTURE_1D_ARRAY_EXT:
201 return arrayTex ? ctx->Texture.ProxyTex[TEXTURE_1D_ARRAY_INDEX] : NULL;
202 case GL_TEXTURE_2D_ARRAY_EXT:
203 return arrayTex ? texUnit->CurrentTex[TEXTURE_2D_ARRAY_INDEX] : NULL;
204 case GL_PROXY_TEXTURE_2D_ARRAY_EXT:
205 return arrayTex ? ctx->Texture.ProxyTex[TEXTURE_2D_ARRAY_INDEX] : NULL;
206 case GL_TEXTURE_BUFFER:
207 return ctx->API == API_OPENGL_CORE &&
208 ctx->Extensions.ARB_texture_buffer_object ?
209 texUnit->CurrentTex[TEXTURE_BUFFER_INDEX] : NULL;
210 case GL_TEXTURE_EXTERNAL_OES:
211 return _mesa_is_gles(ctx) && ctx->Extensions.OES_EGL_image_external
212 ? texUnit->CurrentTex[TEXTURE_EXTERNAL_INDEX] : NULL;
213 case GL_TEXTURE_2D_MULTISAMPLE:
214 return ctx->Extensions.ARB_texture_multisample
215 ? texUnit->CurrentTex[TEXTURE_2D_MULTISAMPLE_INDEX] : NULL;
216 case GL_PROXY_TEXTURE_2D_MULTISAMPLE:
217 return ctx->Extensions.ARB_texture_multisample
218 ? ctx->Texture.ProxyTex[TEXTURE_2D_MULTISAMPLE_INDEX] : NULL;
219 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
220 return ctx->Extensions.ARB_texture_multisample
221 ? texUnit->CurrentTex[TEXTURE_2D_MULTISAMPLE_ARRAY_INDEX] : NULL;
222 case GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY:
223 return ctx->Extensions.ARB_texture_multisample
224 ? ctx->Texture.ProxyTex[TEXTURE_2D_MULTISAMPLE_ARRAY_INDEX] : NULL;
226 _mesa_problem(NULL, "bad target in _mesa_get_current_tex_object()");
233 * Allocate and initialize a new texture object. But don't put it into the
234 * texture object hash table.
236 * Called via ctx->Driver.NewTextureObject, unless overridden by a device
239 * \param shared the shared GL state structure to contain the texture object
240 * \param name integer name for the texture object
241 * \param target either GL_TEXTURE_1D, GL_TEXTURE_2D, GL_TEXTURE_3D,
242 * GL_TEXTURE_CUBE_MAP_ARB or GL_TEXTURE_RECTANGLE_NV. zero is ok for the sake
245 * \return pointer to new texture object.
247 struct gl_texture_object *
248 _mesa_new_texture_object( struct gl_context *ctx, GLuint name, GLenum target )
250 struct gl_texture_object *obj;
252 obj = MALLOC_STRUCT(gl_texture_object);
253 _mesa_initialize_texture_object(ctx, obj, name, target);
259 * Initialize a new texture object to default values.
260 * \param obj the texture object
261 * \param name the texture name
262 * \param target the texture target
265 _mesa_initialize_texture_object( struct gl_context *ctx,
266 struct gl_texture_object *obj,
267 GLuint name, GLenum target )
269 assert(target == 0 ||
270 target == GL_TEXTURE_1D ||
271 target == GL_TEXTURE_2D ||
272 target == GL_TEXTURE_3D ||
273 target == GL_TEXTURE_CUBE_MAP_ARB ||
274 target == GL_TEXTURE_RECTANGLE_NV ||
275 target == GL_TEXTURE_1D_ARRAY_EXT ||
276 target == GL_TEXTURE_2D_ARRAY_EXT ||
277 target == GL_TEXTURE_EXTERNAL_OES ||
278 target == GL_TEXTURE_CUBE_MAP_ARRAY ||
279 target == GL_TEXTURE_BUFFER ||
280 target == GL_TEXTURE_2D_MULTISAMPLE ||
281 target == GL_TEXTURE_2D_MULTISAMPLE_ARRAY);
283 memset(obj, 0, sizeof(*obj));
284 /* init the non-zero fields */
285 mtx_init(&obj->Mutex, mtx_plain);
288 obj->Target = target;
290 obj->TargetIndex = _mesa_tex_target_to_index(ctx, target);
293 obj->TargetIndex = NUM_TEXTURE_TARGETS; /* invalid/error value */
295 obj->Priority = 1.0F;
297 obj->MaxLevel = 1000;
299 /* must be one; no support for (YUV) planes in separate buffers */
300 obj->RequiredTextureImageUnits = 1;
303 if (target == GL_TEXTURE_RECTANGLE_NV ||
304 target == GL_TEXTURE_EXTERNAL_OES) {
305 obj->Sampler.WrapS = GL_CLAMP_TO_EDGE;
306 obj->Sampler.WrapT = GL_CLAMP_TO_EDGE;
307 obj->Sampler.WrapR = GL_CLAMP_TO_EDGE;
308 obj->Sampler.MinFilter = GL_LINEAR;
311 obj->Sampler.WrapS = GL_REPEAT;
312 obj->Sampler.WrapT = GL_REPEAT;
313 obj->Sampler.WrapR = GL_REPEAT;
314 obj->Sampler.MinFilter = GL_NEAREST_MIPMAP_LINEAR;
316 obj->Sampler.MagFilter = GL_LINEAR;
317 obj->Sampler.MinLod = -1000.0;
318 obj->Sampler.MaxLod = 1000.0;
319 obj->Sampler.LodBias = 0.0;
320 obj->Sampler.MaxAnisotropy = 1.0;
321 obj->Sampler.CompareMode = GL_NONE; /* ARB_shadow */
322 obj->Sampler.CompareFunc = GL_LEQUAL; /* ARB_shadow */
323 obj->DepthMode = ctx->API == API_OPENGL_CORE ? GL_RED : GL_LUMINANCE;
324 obj->StencilSampling = false;
325 obj->Sampler.CubeMapSeamless = GL_FALSE;
326 obj->Swizzle[0] = GL_RED;
327 obj->Swizzle[1] = GL_GREEN;
328 obj->Swizzle[2] = GL_BLUE;
329 obj->Swizzle[3] = GL_ALPHA;
330 obj->_Swizzle = SWIZZLE_NOOP;
331 obj->Sampler.sRGBDecode = GL_DECODE_EXT;
332 obj->BufferObjectFormat = GL_R8;
333 obj->_BufferObjectFormat = MESA_FORMAT_R_UNORM8;
334 obj->ImageFormatCompatibilityType = GL_IMAGE_FORMAT_COMPATIBILITY_BY_SIZE;
339 * Some texture initialization can't be finished until we know which
340 * target it's getting bound to (GL_TEXTURE_1D/2D/etc).
343 finish_texture_init(struct gl_context *ctx, GLenum target,
344 struct gl_texture_object *obj)
346 GLenum filter = GL_LINEAR;
347 assert(obj->Target == 0);
349 obj->Target = target;
350 obj->TargetIndex = _mesa_tex_target_to_index(ctx, target);
351 assert(obj->TargetIndex < NUM_TEXTURE_TARGETS);
354 case GL_TEXTURE_2D_MULTISAMPLE:
355 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
359 case GL_TEXTURE_RECTANGLE_NV:
360 case GL_TEXTURE_EXTERNAL_OES:
361 /* have to init wrap and filter state here - kind of klunky */
362 obj->Sampler.WrapS = GL_CLAMP_TO_EDGE;
363 obj->Sampler.WrapT = GL_CLAMP_TO_EDGE;
364 obj->Sampler.WrapR = GL_CLAMP_TO_EDGE;
365 obj->Sampler.MinFilter = filter;
366 obj->Sampler.MagFilter = filter;
367 if (ctx->Driver.TexParameter) {
368 static const GLfloat fparam_wrap[1] = {(GLfloat) GL_CLAMP_TO_EDGE};
369 const GLfloat fparam_filter[1] = {(GLfloat) filter};
370 ctx->Driver.TexParameter(ctx, obj, GL_TEXTURE_WRAP_S, fparam_wrap);
371 ctx->Driver.TexParameter(ctx, obj, GL_TEXTURE_WRAP_T, fparam_wrap);
372 ctx->Driver.TexParameter(ctx, obj, GL_TEXTURE_WRAP_R, fparam_wrap);
373 ctx->Driver.TexParameter(ctx, obj,
374 GL_TEXTURE_MIN_FILTER, fparam_filter);
375 ctx->Driver.TexParameter(ctx, obj,
376 GL_TEXTURE_MAG_FILTER, fparam_filter);
381 /* nothing needs done */
388 * Deallocate a texture object struct. It should have already been
389 * removed from the texture object pool.
390 * Called via ctx->Driver.DeleteTexture() if not overriden by a driver.
392 * \param shared the shared GL state to which the object belongs.
393 * \param texObj the texture object to delete.
396 _mesa_delete_texture_object(struct gl_context *ctx,
397 struct gl_texture_object *texObj)
401 /* Set Target to an invalid value. With some assertions elsewhere
402 * we can try to detect possible use of deleted textures.
404 texObj->Target = 0x99;
406 /* free the texture images */
407 for (face = 0; face < 6; face++) {
408 for (i = 0; i < MAX_TEXTURE_LEVELS; i++) {
409 if (texObj->Image[face][i]) {
410 ctx->Driver.DeleteTextureImage(ctx, texObj->Image[face][i]);
415 _mesa_reference_buffer_object(ctx, &texObj->BufferObject, NULL);
417 /* destroy the mutex -- it may have allocated memory (eg on bsd) */
418 mtx_destroy(&texObj->Mutex);
422 /* free this object */
428 * Copy texture object state from one texture object to another.
429 * Use for glPush/PopAttrib.
431 * \param dest destination texture object.
432 * \param src source texture object.
435 _mesa_copy_texture_object( struct gl_texture_object *dest,
436 const struct gl_texture_object *src )
438 dest->Target = src->Target;
439 dest->TargetIndex = src->TargetIndex;
440 dest->Name = src->Name;
441 dest->Priority = src->Priority;
442 dest->Sampler.BorderColor.f[0] = src->Sampler.BorderColor.f[0];
443 dest->Sampler.BorderColor.f[1] = src->Sampler.BorderColor.f[1];
444 dest->Sampler.BorderColor.f[2] = src->Sampler.BorderColor.f[2];
445 dest->Sampler.BorderColor.f[3] = src->Sampler.BorderColor.f[3];
446 dest->Sampler.WrapS = src->Sampler.WrapS;
447 dest->Sampler.WrapT = src->Sampler.WrapT;
448 dest->Sampler.WrapR = src->Sampler.WrapR;
449 dest->Sampler.MinFilter = src->Sampler.MinFilter;
450 dest->Sampler.MagFilter = src->Sampler.MagFilter;
451 dest->Sampler.MinLod = src->Sampler.MinLod;
452 dest->Sampler.MaxLod = src->Sampler.MaxLod;
453 dest->Sampler.LodBias = src->Sampler.LodBias;
454 dest->BaseLevel = src->BaseLevel;
455 dest->MaxLevel = src->MaxLevel;
456 dest->Sampler.MaxAnisotropy = src->Sampler.MaxAnisotropy;
457 dest->Sampler.CompareMode = src->Sampler.CompareMode;
458 dest->Sampler.CompareFunc = src->Sampler.CompareFunc;
459 dest->Sampler.CubeMapSeamless = src->Sampler.CubeMapSeamless;
460 dest->DepthMode = src->DepthMode;
461 dest->StencilSampling = src->StencilSampling;
462 dest->Sampler.sRGBDecode = src->Sampler.sRGBDecode;
463 dest->_MaxLevel = src->_MaxLevel;
464 dest->_MaxLambda = src->_MaxLambda;
465 dest->GenerateMipmap = src->GenerateMipmap;
466 dest->_BaseComplete = src->_BaseComplete;
467 dest->_MipmapComplete = src->_MipmapComplete;
468 COPY_4V(dest->Swizzle, src->Swizzle);
469 dest->_Swizzle = src->_Swizzle;
470 dest->_IsHalfFloat = src->_IsHalfFloat;
471 dest->_IsFloat = src->_IsFloat;
473 dest->RequiredTextureImageUnits = src->RequiredTextureImageUnits;
478 * Free all texture images of the given texture object.
480 * \param ctx GL context.
481 * \param t texture object.
483 * \sa _mesa_clear_texture_image().
486 _mesa_clear_texture_object(struct gl_context *ctx,
487 struct gl_texture_object *texObj)
491 if (texObj->Target == 0)
494 for (i = 0; i < MAX_FACES; i++) {
495 for (j = 0; j < MAX_TEXTURE_LEVELS; j++) {
496 struct gl_texture_image *texImage = texObj->Image[i][j];
498 _mesa_clear_texture_image(ctx, texImage);
505 * Check if the given texture object is valid by examining its Target field.
506 * For debugging only.
509 valid_texture_object(const struct gl_texture_object *tex)
511 switch (tex->Target) {
516 case GL_TEXTURE_CUBE_MAP_ARB:
517 case GL_TEXTURE_RECTANGLE_NV:
518 case GL_TEXTURE_1D_ARRAY_EXT:
519 case GL_TEXTURE_2D_ARRAY_EXT:
520 case GL_TEXTURE_BUFFER:
521 case GL_TEXTURE_EXTERNAL_OES:
522 case GL_TEXTURE_CUBE_MAP_ARRAY:
523 case GL_TEXTURE_2D_MULTISAMPLE:
524 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
527 _mesa_problem(NULL, "invalid reference to a deleted texture object");
530 _mesa_problem(NULL, "invalid texture object Target 0x%x, Id = %u",
531 tex->Target, tex->Name);
538 * Reference (or unreference) a texture object.
539 * If '*ptr', decrement *ptr's refcount (and delete if it becomes zero).
540 * If 'tex' is non-null, increment its refcount.
541 * This is normally only called from the _mesa_reference_texobj() macro
542 * when there's a real pointer change.
545 _mesa_reference_texobj_(struct gl_texture_object **ptr,
546 struct gl_texture_object *tex)
551 /* Unreference the old texture */
552 GLboolean deleteFlag = GL_FALSE;
553 struct gl_texture_object *oldTex = *ptr;
555 assert(valid_texture_object(oldTex));
556 (void) valid_texture_object; /* silence warning in release builds */
558 mtx_lock(&oldTex->Mutex);
559 assert(oldTex->RefCount > 0);
562 deleteFlag = (oldTex->RefCount == 0);
563 mtx_unlock(&oldTex->Mutex);
566 /* Passing in the context drastically changes the driver code for
567 * framebuffer deletion.
569 GET_CURRENT_CONTEXT(ctx);
571 ctx->Driver.DeleteTexture(ctx, oldTex);
573 _mesa_problem(NULL, "Unable to delete texture, no context");
581 /* reference new texture */
582 assert(valid_texture_object(tex));
583 mtx_lock(&tex->Mutex);
584 if (tex->RefCount == 0) {
585 /* this texture's being deleted (look just above) */
586 /* Not sure this can every really happen. Warn if it does. */
587 _mesa_problem(NULL, "referencing deleted texture object");
594 mtx_unlock(&tex->Mutex);
599 enum base_mipmap { BASE, MIPMAP };
603 * Mark a texture object as incomplete. There are actually three kinds of
605 * 1. "base incomplete": the base level of the texture is invalid so no
606 * texturing is possible.
607 * 2. "mipmap incomplete": a non-base level of the texture is invalid so
608 * mipmap filtering isn't possible, but non-mipmap filtering is.
609 * 3. "texture incompleteness": some combination of texture state and
610 * sampler state renders the texture incomplete.
612 * \param t texture object
613 * \param bm either BASE or MIPMAP to indicate what's incomplete
614 * \param fmt... string describing why it's incomplete (for debugging).
617 incomplete(struct gl_texture_object *t, enum base_mipmap bm,
618 const char *fmt, ...)
620 if (MESA_DEBUG_FLAGS & DEBUG_INCOMPLETE_TEXTURE) {
625 vsnprintf(s, sizeof(s), fmt, args);
628 _mesa_debug(NULL, "Texture Obj %d incomplete because: %s\n", t->Name, s);
632 t->_BaseComplete = GL_FALSE;
633 t->_MipmapComplete = GL_FALSE;
638 * Examine a texture object to determine if it is complete.
640 * The gl_texture_object::Complete flag will be set to GL_TRUE or GL_FALSE
643 * \param ctx GL context.
644 * \param t texture object.
646 * According to the texture target, verifies that each of the mipmaps is
647 * present and has the expected size.
650 _mesa_test_texobj_completeness( const struct gl_context *ctx,
651 struct gl_texture_object *t )
653 const GLint baseLevel = t->BaseLevel;
654 const struct gl_texture_image *baseImage;
657 /* We'll set these to FALSE if tests fail below */
658 t->_BaseComplete = GL_TRUE;
659 t->_MipmapComplete = GL_TRUE;
661 if (t->Target == GL_TEXTURE_BUFFER) {
662 /* Buffer textures are always considered complete. The obvious case where
663 * they would be incomplete (no BO attached) is actually specced to be
664 * undefined rendering results.
669 /* Detect cases where the application set the base level to an invalid
672 if ((baseLevel < 0) || (baseLevel >= MAX_TEXTURE_LEVELS)) {
673 incomplete(t, BASE, "base level = %d is invalid", baseLevel);
677 if (t->MaxLevel < baseLevel) {
678 incomplete(t, MIPMAP, "MAX_LEVEL (%d) < BASE_LEVEL (%d)",
679 t->MaxLevel, baseLevel);
683 baseImage = t->Image[0][baseLevel];
685 /* Always need the base level image */
687 incomplete(t, BASE, "Image[baseLevel=%d] == NULL", baseLevel);
691 /* Check width/height/depth for zero */
692 if (baseImage->Width == 0 ||
693 baseImage->Height == 0 ||
694 baseImage->Depth == 0) {
695 incomplete(t, BASE, "texture width or height or depth = 0");
699 /* Check if the texture values are integer */
701 GLenum datatype = _mesa_get_format_datatype(baseImage->TexFormat);
702 t->_IsIntegerFormat = datatype == GL_INT || datatype == GL_UNSIGNED_INT;
705 /* Check if the texture type is Float or HalfFloatOES and ensure Min and Mag
706 * filters are supported in this case.
708 if (_mesa_is_gles(ctx) && !valid_filter_for_float(ctx, t)) {
709 incomplete(t, BASE, "Filter is not supported with Float types.");
713 /* Compute _MaxLevel (the maximum mipmap level we'll sample from given the
714 * mipmap image sizes and GL_TEXTURE_MAX_LEVEL state).
718 case GL_TEXTURE_1D_ARRAY_EXT:
719 maxLevels = ctx->Const.MaxTextureLevels;
722 case GL_TEXTURE_2D_ARRAY_EXT:
723 maxLevels = ctx->Const.MaxTextureLevels;
726 maxLevels = ctx->Const.Max3DTextureLevels;
728 case GL_TEXTURE_CUBE_MAP_ARB:
729 case GL_TEXTURE_CUBE_MAP_ARRAY:
730 maxLevels = ctx->Const.MaxCubeTextureLevels;
732 case GL_TEXTURE_RECTANGLE_NV:
733 case GL_TEXTURE_BUFFER:
734 case GL_TEXTURE_EXTERNAL_OES:
735 case GL_TEXTURE_2D_MULTISAMPLE:
736 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
737 maxLevels = 1; /* no mipmapping */
740 _mesa_problem(ctx, "Bad t->Target in _mesa_test_texobj_completeness");
744 assert(maxLevels > 0);
746 t->_MaxLevel = MIN3(t->MaxLevel,
747 /* 'p' in the GL spec */
748 (int) (baseLevel + baseImage->MaxNumLevels - 1),
749 /* 'q' in the GL spec */
753 /* Adjust max level for views: the data store may have more levels than
756 t->_MaxLevel = MIN2(t->_MaxLevel, t->NumLevels - 1);
759 /* Compute _MaxLambda = q - p in the spec used during mipmapping */
760 t->_MaxLambda = (GLfloat) (t->_MaxLevel - baseLevel);
763 /* This texture object was created with glTexStorage1/2/3D() so we
764 * know that all the mipmap levels are the right size and all cube
765 * map faces are the same size.
766 * We don't need to do any of the additional checks below.
771 if (t->Target == GL_TEXTURE_CUBE_MAP_ARB) {
772 /* Make sure that all six cube map level 0 images are the same size.
773 * Note: we know that the image's width==height (we enforce that
774 * at glTexImage time) so we only need to test the width here.
777 assert(baseImage->Width2 == baseImage->Height);
778 for (face = 1; face < 6; face++) {
779 assert(t->Image[face][baseLevel] == NULL ||
780 t->Image[face][baseLevel]->Width2 ==
781 t->Image[face][baseLevel]->Height2);
782 if (t->Image[face][baseLevel] == NULL ||
783 t->Image[face][baseLevel]->Width2 != baseImage->Width2) {
784 incomplete(t, BASE, "Cube face missing or mismatched size");
791 * Do mipmap consistency checking.
792 * Note: we don't care about the current texture sampler state here.
793 * To determine texture completeness we'll either look at _BaseComplete
794 * or _MipmapComplete depending on the current minification filter mode.
798 const GLint minLevel = baseLevel;
799 const GLint maxLevel = t->_MaxLevel;
800 const GLuint numFaces = _mesa_num_tex_faces(t->Target);
801 GLuint width, height, depth, face;
803 if (minLevel > maxLevel) {
804 incomplete(t, MIPMAP, "minLevel > maxLevel");
808 /* Get the base image's dimensions */
809 width = baseImage->Width2;
810 height = baseImage->Height2;
811 depth = baseImage->Depth2;
813 /* Note: this loop will be a no-op for RECT, BUFFER, EXTERNAL,
814 * MULTISAMPLE and MULTISAMPLE_ARRAY textures
816 for (i = baseLevel + 1; i < maxLevels; i++) {
817 /* Compute the expected size of image at level[i] */
821 if (height > 1 && t->Target != GL_TEXTURE_1D_ARRAY) {
824 if (depth > 1 && t->Target != GL_TEXTURE_2D_ARRAY
825 && t->Target != GL_TEXTURE_CUBE_MAP_ARRAY) {
829 /* loop over cube faces (or single face otherwise) */
830 for (face = 0; face < numFaces; face++) {
831 if (i >= minLevel && i <= maxLevel) {
832 const struct gl_texture_image *img = t->Image[face][i];
835 incomplete(t, MIPMAP, "TexImage[%d] is missing", i);
838 if (img->InternalFormat != baseImage->InternalFormat) {
839 incomplete(t, MIPMAP, "Format[i] != Format[baseLevel]");
842 if (img->Border != baseImage->Border) {
843 incomplete(t, MIPMAP, "Border[i] != Border[baseLevel]");
846 if (img->Width2 != width) {
847 incomplete(t, MIPMAP, "TexImage[%d] bad width %u", i,
851 if (img->Height2 != height) {
852 incomplete(t, MIPMAP, "TexImage[%d] bad height %u", i,
856 if (img->Depth2 != depth) {
857 incomplete(t, MIPMAP, "TexImage[%d] bad depth %u", i,
862 /* Extra checks for cube textures */
864 /* check that cube faces are the same size */
865 if (img->Width2 != t->Image[0][i]->Width2 ||
866 img->Height2 != t->Image[0][i]->Height2) {
867 incomplete(t, MIPMAP, "CubeMap Image[n][i] bad size");
874 if (width == 1 && height == 1 && depth == 1) {
875 return; /* found smallest needed mipmap, all done! */
883 _mesa_cube_level_complete(const struct gl_texture_object *texObj,
886 const struct gl_texture_image *img0, *img;
889 if (texObj->Target != GL_TEXTURE_CUBE_MAP)
892 if ((level < 0) || (level >= MAX_TEXTURE_LEVELS))
895 /* check first face */
896 img0 = texObj->Image[0][level];
899 img0->Width != img0->Height)
902 /* check remaining faces vs. first face */
903 for (face = 1; face < 6; face++) {
904 img = texObj->Image[face][level];
906 img->Width != img0->Width ||
907 img->Height != img0->Height ||
908 img->TexFormat != img0->TexFormat)
916 * Check if the given cube map texture is "cube complete" as defined in
917 * the OpenGL specification.
920 _mesa_cube_complete(const struct gl_texture_object *texObj)
922 return _mesa_cube_level_complete(texObj, texObj->BaseLevel);
926 * Mark a texture object dirty. It forces the object to be incomplete
927 * and forces the context to re-validate its state.
929 * \param ctx GL context.
930 * \param texObj texture object.
933 _mesa_dirty_texobj(struct gl_context *ctx, struct gl_texture_object *texObj)
935 texObj->_BaseComplete = GL_FALSE;
936 texObj->_MipmapComplete = GL_FALSE;
937 ctx->NewState |= _NEW_TEXTURE;
942 * Return pointer to a default/fallback texture of the given type/target.
943 * The texture is an RGBA texture with all texels = (0,0,0,1).
944 * That's the value a GLSL sampler should get when sampling from an
945 * incomplete texture.
947 struct gl_texture_object *
948 _mesa_get_fallback_texture(struct gl_context *ctx, gl_texture_index tex)
950 if (!ctx->Shared->FallbackTex[tex]) {
951 /* create fallback texture now */
952 const GLsizei width = 1, height = 1;
955 struct gl_texture_object *texObj;
956 struct gl_texture_image *texImage;
957 mesa_format texFormat;
958 GLuint dims, face, numFaces = 1;
961 for (face = 0; face < 6; face++) {
964 texel[4*face + 2] = 0x0;
965 texel[4*face + 3] = 0xff;
969 case TEXTURE_2D_ARRAY_INDEX:
971 target = GL_TEXTURE_2D_ARRAY;
973 case TEXTURE_1D_ARRAY_INDEX:
975 target = GL_TEXTURE_1D_ARRAY;
977 case TEXTURE_CUBE_INDEX:
979 target = GL_TEXTURE_CUBE_MAP;
982 case TEXTURE_3D_INDEX:
984 target = GL_TEXTURE_3D;
986 case TEXTURE_RECT_INDEX:
988 target = GL_TEXTURE_RECTANGLE;
990 case TEXTURE_2D_INDEX:
992 target = GL_TEXTURE_2D;
994 case TEXTURE_1D_INDEX:
996 target = GL_TEXTURE_1D;
998 case TEXTURE_BUFFER_INDEX:
1000 target = GL_TEXTURE_BUFFER;
1002 case TEXTURE_CUBE_ARRAY_INDEX:
1004 target = GL_TEXTURE_CUBE_MAP_ARRAY;
1007 case TEXTURE_EXTERNAL_INDEX:
1009 target = GL_TEXTURE_EXTERNAL_OES;
1011 case TEXTURE_2D_MULTISAMPLE_INDEX:
1013 target = GL_TEXTURE_2D_MULTISAMPLE;
1015 case TEXTURE_2D_MULTISAMPLE_ARRAY_INDEX:
1017 target = GL_TEXTURE_2D_MULTISAMPLE_ARRAY;
1024 /* create texture object */
1025 texObj = ctx->Driver.NewTextureObject(ctx, 0, target);
1029 assert(texObj->RefCount == 1);
1030 texObj->Sampler.MinFilter = GL_NEAREST;
1031 texObj->Sampler.MagFilter = GL_NEAREST;
1033 texFormat = ctx->Driver.ChooseTextureFormat(ctx, target,
1037 /* need a loop here just for cube maps */
1038 for (face = 0; face < numFaces; face++) {
1041 if (target == GL_TEXTURE_CUBE_MAP)
1042 faceTarget = GL_TEXTURE_CUBE_MAP_POSITIVE_X + face;
1044 faceTarget = target;
1046 /* initialize level[0] texture image */
1047 texImage = _mesa_get_tex_image(ctx, texObj, faceTarget, 0);
1049 _mesa_init_teximage_fields(ctx, texImage,
1051 (dims > 1) ? height : 1,
1052 (dims > 2) ? depth : 1,
1054 GL_RGBA, texFormat);
1056 ctx->Driver.TexImage(ctx, dims, texImage,
1057 GL_RGBA, GL_UNSIGNED_BYTE, texel,
1058 &ctx->DefaultPacking);
1061 _mesa_test_texobj_completeness(ctx, texObj);
1062 assert(texObj->_BaseComplete);
1063 assert(texObj->_MipmapComplete);
1065 ctx->Shared->FallbackTex[tex] = texObj;
1067 return ctx->Shared->FallbackTex[tex];
1072 * Compute the size of the given texture object, in bytes.
1075 texture_size(const struct gl_texture_object *texObj)
1077 const GLuint numFaces = _mesa_num_tex_faces(texObj->Target);
1078 GLuint face, level, size = 0;
1080 for (face = 0; face < numFaces; face++) {
1081 for (level = 0; level < MAX_TEXTURE_LEVELS; level++) {
1082 const struct gl_texture_image *img = texObj->Image[face][level];
1084 GLuint sz = _mesa_format_image_size(img->TexFormat, img->Width,
1085 img->Height, img->Depth);
1096 * Callback called from _mesa_HashWalk()
1099 count_tex_size(GLuint key, void *data, void *userData)
1101 const struct gl_texture_object *texObj =
1102 (const struct gl_texture_object *) data;
1103 GLuint *total = (GLuint *) userData;
1107 *total = *total + texture_size(texObj);
1112 * Compute total size (in bytes) of all textures for the given context.
1113 * For debugging purposes.
1116 _mesa_total_texture_memory(struct gl_context *ctx)
1118 GLuint tgt, total = 0;
1120 _mesa_HashWalk(ctx->Shared->TexObjects, count_tex_size, &total);
1122 /* plus, the default texture objects */
1123 for (tgt = 0; tgt < NUM_TEXTURE_TARGETS; tgt++) {
1124 total += texture_size(ctx->Shared->DefaultTex[tgt]);
1132 * Return the base format for the given texture object by looking
1133 * at the base texture image.
1134 * \return base format (such as GL_RGBA) or GL_NONE if it can't be determined
1137 _mesa_texture_base_format(const struct gl_texture_object *texObj)
1139 const struct gl_texture_image *texImage = _mesa_base_tex_image(texObj);
1141 return texImage ? texImage->_BaseFormat : GL_NONE;
1145 static struct gl_texture_object *
1146 invalidate_tex_image_error_check(struct gl_context *ctx, GLuint texture,
1147 GLint level, const char *name)
1149 /* The GL_ARB_invalidate_subdata spec says:
1151 * "If <texture> is zero or is not the name of a texture, the error
1152 * INVALID_VALUE is generated."
1154 * This performs the error check in a different order than listed in the
1155 * spec. We have to get the texture object before we can validate the
1156 * other parameters against values in the texture object.
1158 struct gl_texture_object *const t = _mesa_lookup_texture(ctx, texture);
1159 if (texture == 0 || t == NULL) {
1160 _mesa_error(ctx, GL_INVALID_VALUE, "%s(texture)", name);
1164 /* The GL_ARB_invalidate_subdata spec says:
1166 * "If <level> is less than zero or greater than the base 2 logarithm
1167 * of the maximum texture width, height, or depth, the error
1168 * INVALID_VALUE is generated."
1170 if (level < 0 || level > t->MaxLevel) {
1171 _mesa_error(ctx, GL_INVALID_VALUE, "%s(level)", name);
1175 /* The GL_ARB_invalidate_subdata spec says:
1177 * "If the target of <texture> is TEXTURE_RECTANGLE, TEXTURE_BUFFER,
1178 * TEXTURE_2D_MULTISAMPLE, or TEXTURE_2D_MULTISAMPLE_ARRAY, and <level>
1179 * is not zero, the error INVALID_VALUE is generated."
1182 switch (t->Target) {
1183 case GL_TEXTURE_RECTANGLE:
1184 case GL_TEXTURE_BUFFER:
1185 case GL_TEXTURE_2D_MULTISAMPLE:
1186 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
1187 _mesa_error(ctx, GL_INVALID_VALUE, "%s(level)", name);
1200 * Helper function for glCreateTextures and glGenTextures. Need this because
1201 * glCreateTextures should throw errors if target = 0. This is not exposed to
1202 * the rest of Mesa to encourage Mesa internals to use nameless textures,
1203 * which do not require expensive hash lookups.
1204 * \param target either 0 or a a valid / error-checked texture target enum
1207 create_textures(struct gl_context *ctx, GLenum target,
1208 GLsizei n, GLuint *textures, const char *caller)
1213 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
1214 _mesa_debug(ctx, "%s %d\n", caller, n);
1217 _mesa_error(ctx, GL_INVALID_VALUE, "%s(n < 0)", caller);
1225 * This must be atomic (generation and allocation of texture IDs)
1227 mtx_lock(&ctx->Shared->Mutex);
1229 first = _mesa_HashFindFreeKeyBlock(ctx->Shared->TexObjects, n);
1231 /* Allocate new, empty texture objects */
1232 for (i = 0; i < n; i++) {
1233 struct gl_texture_object *texObj;
1234 GLuint name = first + i;
1235 texObj = ctx->Driver.NewTextureObject(ctx, name, target);
1237 mtx_unlock(&ctx->Shared->Mutex);
1238 _mesa_error(ctx, GL_OUT_OF_MEMORY, "gl%sTextures", caller);
1242 /* insert into hash table */
1243 _mesa_HashInsert(ctx->Shared->TexObjects, texObj->Name, texObj);
1248 mtx_unlock(&ctx->Shared->Mutex);
1254 /***********************************************************************/
1255 /** \name API functions */
1260 * Generate texture names.
1262 * \param n number of texture names to be generated.
1263 * \param textures an array in which will hold the generated texture names.
1265 * \sa glGenTextures(), glCreateTextures().
1267 * Calls _mesa_HashFindFreeKeyBlock() to find a block of free texture
1268 * IDs which are stored in \p textures. Corresponding empty texture
1269 * objects are also generated.
1272 _mesa_GenTextures(GLsizei n, GLuint *textures)
1274 GET_CURRENT_CONTEXT(ctx);
1275 create_textures(ctx, 0, n, textures, "glGenTextures");
1279 * Create texture objects.
1281 * \param target the texture target for each name to be generated.
1282 * \param n number of texture names to be generated.
1283 * \param textures an array in which will hold the generated texture names.
1285 * \sa glCreateTextures(), glGenTextures().
1287 * Calls _mesa_HashFindFreeKeyBlock() to find a block of free texture
1288 * IDs which are stored in \p textures. Corresponding empty texture
1289 * objects are also generated.
1292 _mesa_CreateTextures(GLenum target, GLsizei n, GLuint *textures)
1295 GET_CURRENT_CONTEXT(ctx);
1298 * The 4.5 core profile spec (30.10.2014) doesn't specify what
1299 * glCreateTextures should do with invalid targets, which was probably an
1300 * oversight. This conforms to the spec for glBindTexture.
1302 targetIndex = _mesa_tex_target_to_index(ctx, target);
1303 if (targetIndex < 0) {
1304 _mesa_error(ctx, GL_INVALID_ENUM, "glCreateTextures(target)");
1308 create_textures(ctx, target, n, textures, "glCreateTextures");
1312 * Check if the given texture object is bound to the current draw or
1313 * read framebuffer. If so, Unbind it.
1316 unbind_texobj_from_fbo(struct gl_context *ctx,
1317 struct gl_texture_object *texObj)
1319 bool progress = false;
1321 /* Section 4.4.2 (Attaching Images to Framebuffer Objects), subsection
1322 * "Attaching Texture Images to a Framebuffer," of the OpenGL 3.1 spec
1325 * "If a texture object is deleted while its image is attached to one
1326 * or more attachment points in the currently bound framebuffer, then
1327 * it is as if FramebufferTexture* had been called, with a texture of
1328 * zero, for each attachment point to which this image was attached in
1329 * the currently bound framebuffer. In other words, this texture image
1330 * is first detached from all attachment points in the currently bound
1331 * framebuffer. Note that the texture image is specifically not
1332 * detached from any other framebuffer objects. Detaching the texture
1333 * image from any other framebuffer objects is the responsibility of
1336 if (_mesa_is_user_fbo(ctx->DrawBuffer)) {
1337 progress = _mesa_detach_renderbuffer(ctx, ctx->DrawBuffer, texObj);
1339 if (_mesa_is_user_fbo(ctx->ReadBuffer)
1340 && ctx->ReadBuffer != ctx->DrawBuffer) {
1341 progress = _mesa_detach_renderbuffer(ctx, ctx->ReadBuffer, texObj)
1346 /* Vertices are already flushed by _mesa_DeleteTextures */
1347 ctx->NewState |= _NEW_BUFFERS;
1352 * Check if the given texture object is bound to any texture image units and
1353 * unbind it if so (revert to default textures).
1356 unbind_texobj_from_texunits(struct gl_context *ctx,
1357 struct gl_texture_object *texObj)
1359 const gl_texture_index index = texObj->TargetIndex;
1362 if (texObj->Target == 0) {
1363 /* texture was never bound */
1367 assert(index < NUM_TEXTURE_TARGETS);
1369 for (u = 0; u < ctx->Texture.NumCurrentTexUsed; u++) {
1370 struct gl_texture_unit *unit = &ctx->Texture.Unit[u];
1372 if (texObj == unit->CurrentTex[index]) {
1373 /* Bind the default texture for this unit/target */
1374 _mesa_reference_texobj(&unit->CurrentTex[index],
1375 ctx->Shared->DefaultTex[index]);
1376 unit->_BoundTextures &= ~(1 << index);
1383 * Check if the given texture object is bound to any shader image unit
1384 * and unbind it if that's the case.
1387 unbind_texobj_from_image_units(struct gl_context *ctx,
1388 struct gl_texture_object *texObj)
1392 for (i = 0; i < ctx->Const.MaxImageUnits; i++) {
1393 struct gl_image_unit *unit = &ctx->ImageUnits[i];
1395 if (texObj == unit->TexObj) {
1396 _mesa_reference_texobj(&unit->TexObj, NULL);
1397 *unit = _mesa_default_image_unit(ctx);
1404 * Unbinds all textures bound to the given texture image unit.
1407 unbind_textures_from_unit(struct gl_context *ctx, GLuint unit)
1409 struct gl_texture_unit *texUnit = &ctx->Texture.Unit[unit];
1411 while (texUnit->_BoundTextures) {
1412 const GLuint index = ffs(texUnit->_BoundTextures) - 1;
1413 struct gl_texture_object *texObj = ctx->Shared->DefaultTex[index];
1415 _mesa_reference_texobj(&texUnit->CurrentTex[index], texObj);
1417 /* Pass BindTexture call to device driver */
1418 if (ctx->Driver.BindTexture)
1419 ctx->Driver.BindTexture(ctx, unit, 0, texObj);
1421 texUnit->_BoundTextures &= ~(1 << index);
1422 ctx->NewState |= _NEW_TEXTURE;
1428 * Delete named textures.
1430 * \param n number of textures to be deleted.
1431 * \param textures array of texture IDs to be deleted.
1433 * \sa glDeleteTextures().
1435 * If we're about to delete a texture that's currently bound to any
1436 * texture unit, unbind the texture first. Decrement the reference
1437 * count on the texture object and delete it if it's zero.
1438 * Recall that texture objects can be shared among several rendering
1442 _mesa_DeleteTextures( GLsizei n, const GLuint *textures)
1444 GET_CURRENT_CONTEXT(ctx);
1447 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
1448 _mesa_debug(ctx, "glDeleteTextures %d\n", n);
1451 _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteTextures(n < 0)");
1455 FLUSH_VERTICES(ctx, 0); /* too complex */
1458 _mesa_error(ctx, GL_INVALID_VALUE, "glDeleteTextures(n)");
1465 for (i = 0; i < n; i++) {
1466 if (textures[i] > 0) {
1467 struct gl_texture_object *delObj
1468 = _mesa_lookup_texture(ctx, textures[i]);
1471 _mesa_lock_texture(ctx, delObj);
1473 /* Check if texture is bound to any framebuffer objects.
1475 * See section 4.4.2.3 of GL_EXT_framebuffer_object.
1477 unbind_texobj_from_fbo(ctx, delObj);
1479 /* Check if this texture is currently bound to any texture units.
1482 unbind_texobj_from_texunits(ctx, delObj);
1484 /* Check if this texture is currently bound to any shader
1485 * image unit. If so, unbind it.
1486 * See section 3.9.X of GL_ARB_shader_image_load_store.
1488 unbind_texobj_from_image_units(ctx, delObj);
1490 _mesa_unlock_texture(ctx, delObj);
1492 ctx->NewState |= _NEW_TEXTURE;
1494 /* The texture _name_ is now free for re-use.
1495 * Remove it from the hash table now.
1497 mtx_lock(&ctx->Shared->Mutex);
1498 _mesa_HashRemove(ctx->Shared->TexObjects, delObj->Name);
1499 mtx_unlock(&ctx->Shared->Mutex);
1501 /* Unreference the texobj. If refcount hits zero, the texture
1504 _mesa_reference_texobj(&delObj, NULL);
1511 * This deletes a texObj without altering the hash table.
1514 _mesa_delete_nameless_texture(struct gl_context *ctx,
1515 struct gl_texture_object *texObj)
1520 FLUSH_VERTICES(ctx, 0);
1522 _mesa_lock_texture(ctx, texObj);
1524 /* Check if texture is bound to any framebuffer objects.
1526 * See section 4.4.2.3 of GL_EXT_framebuffer_object.
1528 unbind_texobj_from_fbo(ctx, texObj);
1530 /* Check if this texture is currently bound to any texture units.
1533 unbind_texobj_from_texunits(ctx, texObj);
1535 /* Check if this texture is currently bound to any shader
1536 * image unit. If so, unbind it.
1537 * See section 3.9.X of GL_ARB_shader_image_load_store.
1539 unbind_texobj_from_image_units(ctx, texObj);
1541 _mesa_unlock_texture(ctx, texObj);
1543 ctx->NewState |= _NEW_TEXTURE;
1545 /* Unreference the texobj. If refcount hits zero, the texture
1548 _mesa_reference_texobj(&texObj, NULL);
1553 * Convert a GL texture target enum such as GL_TEXTURE_2D or GL_TEXTURE_3D
1554 * into the corresponding Mesa texture target index.
1555 * Note that proxy targets are not valid here.
1556 * \return TEXTURE_x_INDEX or -1 if target is invalid
1559 _mesa_tex_target_to_index(const struct gl_context *ctx, GLenum target)
1563 return _mesa_is_desktop_gl(ctx) ? TEXTURE_1D_INDEX : -1;
1565 return TEXTURE_2D_INDEX;
1567 return ctx->API != API_OPENGLES ? TEXTURE_3D_INDEX : -1;
1568 case GL_TEXTURE_CUBE_MAP:
1569 return ctx->Extensions.ARB_texture_cube_map
1570 ? TEXTURE_CUBE_INDEX : -1;
1571 case GL_TEXTURE_RECTANGLE:
1572 return _mesa_is_desktop_gl(ctx) && ctx->Extensions.NV_texture_rectangle
1573 ? TEXTURE_RECT_INDEX : -1;
1574 case GL_TEXTURE_1D_ARRAY:
1575 return _mesa_is_desktop_gl(ctx) && ctx->Extensions.EXT_texture_array
1576 ? TEXTURE_1D_ARRAY_INDEX : -1;
1577 case GL_TEXTURE_2D_ARRAY:
1578 return (_mesa_is_desktop_gl(ctx) && ctx->Extensions.EXT_texture_array)
1579 || _mesa_is_gles3(ctx)
1580 ? TEXTURE_2D_ARRAY_INDEX : -1;
1581 case GL_TEXTURE_BUFFER:
1582 return ctx->API == API_OPENGL_CORE &&
1583 ctx->Extensions.ARB_texture_buffer_object ?
1584 TEXTURE_BUFFER_INDEX : -1;
1585 case GL_TEXTURE_EXTERNAL_OES:
1586 return _mesa_is_gles(ctx) && ctx->Extensions.OES_EGL_image_external
1587 ? TEXTURE_EXTERNAL_INDEX : -1;
1588 case GL_TEXTURE_CUBE_MAP_ARRAY:
1589 return _mesa_is_desktop_gl(ctx) && ctx->Extensions.ARB_texture_cube_map_array
1590 ? TEXTURE_CUBE_ARRAY_INDEX : -1;
1591 case GL_TEXTURE_2D_MULTISAMPLE:
1592 return ((_mesa_is_desktop_gl(ctx) && ctx->Extensions.ARB_texture_multisample) ||
1593 _mesa_is_gles31(ctx)) ? TEXTURE_2D_MULTISAMPLE_INDEX: -1;
1594 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
1595 return ((_mesa_is_desktop_gl(ctx) && ctx->Extensions.ARB_texture_multisample) ||
1596 _mesa_is_gles31(ctx))
1597 ? TEXTURE_2D_MULTISAMPLE_ARRAY_INDEX: -1;
1605 * Do actual texture binding. All error checking should have been done prior
1606 * to calling this function. Note that the texture target (1D, 2D, etc) is
1607 * always specified by the texObj->TargetIndex.
1609 * \param unit index of texture unit to update
1610 * \param texObj the new texture object (cannot be NULL)
1613 bind_texture(struct gl_context *ctx,
1615 struct gl_texture_object *texObj)
1617 struct gl_texture_unit *texUnit;
1620 assert(unit < ARRAY_SIZE(ctx->Texture.Unit));
1621 texUnit = &ctx->Texture.Unit[unit];
1624 assert(valid_texture_object(texObj));
1626 targetIndex = texObj->TargetIndex;
1627 assert(targetIndex >= 0);
1628 assert(targetIndex < NUM_TEXTURE_TARGETS);
1630 /* Check if this texture is only used by this context and is already bound.
1631 * If so, just return.
1635 mtx_lock(&ctx->Shared->Mutex);
1636 early_out = ((ctx->Shared->RefCount == 1)
1637 && (texObj == texUnit->CurrentTex[targetIndex]));
1638 mtx_unlock(&ctx->Shared->Mutex);
1644 /* flush before changing binding */
1645 FLUSH_VERTICES(ctx, _NEW_TEXTURE);
1647 /* If the refcount on the previously bound texture is decremented to
1648 * zero, it'll be deleted here.
1650 _mesa_reference_texobj(&texUnit->CurrentTex[targetIndex], texObj);
1652 ctx->Texture.NumCurrentTexUsed = MAX2(ctx->Texture.NumCurrentTexUsed,
1655 if (texObj->Name != 0)
1656 texUnit->_BoundTextures |= (1 << targetIndex);
1658 texUnit->_BoundTextures &= ~(1 << targetIndex);
1660 /* Pass BindTexture call to device driver */
1661 if (ctx->Driver.BindTexture) {
1662 ctx->Driver.BindTexture(ctx, unit, texObj->Target, texObj);
1668 * Implement glBindTexture(). Do error checking, look-up or create a new
1669 * texture object, then bind it in the current texture unit.
1671 * \param target texture target.
1672 * \param texName texture name.
1675 _mesa_BindTexture( GLenum target, GLuint texName )
1677 GET_CURRENT_CONTEXT(ctx);
1678 struct gl_texture_object *newTexObj = NULL;
1681 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
1682 _mesa_debug(ctx, "glBindTexture %s %d\n",
1683 _mesa_enum_to_string(target), (GLint) texName);
1685 targetIndex = _mesa_tex_target_to_index(ctx, target);
1686 if (targetIndex < 0) {
1687 _mesa_error(ctx, GL_INVALID_ENUM, "glBindTexture(target)");
1690 assert(targetIndex < NUM_TEXTURE_TARGETS);
1693 * Get pointer to new texture object (newTexObj)
1696 /* Use a default texture object */
1697 newTexObj = ctx->Shared->DefaultTex[targetIndex];
1700 /* non-default texture object */
1701 newTexObj = _mesa_lookup_texture(ctx, texName);
1703 /* error checking */
1704 if (newTexObj->Target != 0 && newTexObj->Target != target) {
1705 /* The named texture object's target doesn't match the
1708 _mesa_error( ctx, GL_INVALID_OPERATION,
1709 "glBindTexture(target mismatch)" );
1712 if (newTexObj->Target == 0) {
1713 finish_texture_init(ctx, target, newTexObj);
1717 if (ctx->API == API_OPENGL_CORE) {
1718 _mesa_error(ctx, GL_INVALID_OPERATION,
1719 "glBindTexture(non-gen name)");
1723 /* if this is a new texture id, allocate a texture object now */
1724 newTexObj = ctx->Driver.NewTextureObject(ctx, texName, target);
1726 _mesa_error(ctx, GL_OUT_OF_MEMORY, "glBindTexture");
1730 /* and insert it into hash table */
1731 mtx_lock(&ctx->Shared->Mutex);
1732 _mesa_HashInsert(ctx->Shared->TexObjects, texName, newTexObj);
1733 mtx_unlock(&ctx->Shared->Mutex);
1737 assert(newTexObj->Target == target);
1738 assert(newTexObj->TargetIndex == targetIndex);
1740 bind_texture(ctx, ctx->Texture.CurrentUnit, newTexObj);
1745 * OpenGL 4.5 / GL_ARB_direct_state_access glBindTextureUnit().
1747 * \param unit texture unit.
1748 * \param texture texture name.
1750 * \sa glBindTexture().
1752 * If the named texture is 0, this will reset each target for the specified
1753 * texture unit to its default texture.
1754 * If the named texture is not 0 or a recognized texture name, this throws
1755 * GL_INVALID_OPERATION.
1758 _mesa_BindTextureUnit(GLuint unit, GLuint texture)
1760 GET_CURRENT_CONTEXT(ctx);
1761 struct gl_texture_object *texObj;
1763 if (unit >= _mesa_max_tex_unit(ctx)) {
1764 _mesa_error(ctx, GL_INVALID_VALUE, "glBindTextureUnit(unit=%u)", unit);
1768 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
1769 _mesa_debug(ctx, "glBindTextureUnit %s %d\n",
1770 _mesa_enum_to_string(GL_TEXTURE0+unit), (GLint) texture);
1772 /* Section 8.1 (Texture Objects) of the OpenGL 4.5 core profile spec
1774 * "When texture is zero, each of the targets enumerated at the
1775 * beginning of this section is reset to its default texture for the
1776 * corresponding texture image unit."
1779 unbind_textures_from_unit(ctx, unit);
1783 /* Get the non-default texture object */
1784 texObj = _mesa_lookup_texture(ctx, texture);
1786 /* Error checking */
1788 _mesa_error(ctx, GL_INVALID_OPERATION,
1789 "glBindTextureUnit(non-gen name)");
1792 if (texObj->Target == 0) {
1793 /* Texture object was gen'd but never bound so the target is not set */
1794 _mesa_error(ctx, GL_INVALID_OPERATION, "glBindTextureUnit(target)");
1797 assert(valid_texture_object(texObj));
1799 bind_texture(ctx, unit, texObj);
1804 * OpenGL 4.4 / GL_ARB_multi_bind glBindTextures().
1807 _mesa_BindTextures(GLuint first, GLsizei count, const GLuint *textures)
1809 GET_CURRENT_CONTEXT(ctx);
1812 /* The ARB_multi_bind spec says:
1814 * "An INVALID_OPERATION error is generated if <first> + <count>
1815 * is greater than the number of texture image units supported
1816 * by the implementation."
1818 if (first + count > ctx->Const.MaxCombinedTextureImageUnits) {
1819 _mesa_error(ctx, GL_INVALID_OPERATION,
1820 "glBindTextures(first=%u + count=%d > the value of "
1821 "GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS=%u)",
1822 first, count, ctx->Const.MaxCombinedTextureImageUnits);
1827 /* Note that the error semantics for multi-bind commands differ from
1828 * those of other GL commands.
1830 * The issues section in the ARB_multi_bind spec says:
1832 * "(11) Typically, OpenGL specifies that if an error is generated by
1833 * a command, that command has no effect. This is somewhat
1834 * unfortunate for multi-bind commands, because it would require
1835 * a first pass to scan the entire list of bound objects for
1836 * errors and then a second pass to actually perform the
1837 * bindings. Should we have different error semantics?
1839 * RESOLVED: Yes. In this specification, when the parameters for
1840 * one of the <count> binding points are invalid, that binding
1841 * point is not updated and an error will be generated. However,
1842 * other binding points in the same command will be updated if
1843 * their parameters are valid and no other error occurs."
1846 _mesa_begin_texture_lookups(ctx);
1848 for (i = 0; i < count; i++) {
1849 if (textures[i] != 0) {
1850 struct gl_texture_unit *texUnit = &ctx->Texture.Unit[first + i];
1851 struct gl_texture_object *current = texUnit->_Current;
1852 struct gl_texture_object *texObj;
1854 if (current && current->Name == textures[i])
1857 texObj = _mesa_lookup_texture_locked(ctx, textures[i]);
1859 if (texObj && texObj->Target != 0) {
1860 bind_texture(ctx, first + i, texObj);
1862 /* The ARB_multi_bind spec says:
1864 * "An INVALID_OPERATION error is generated if any value
1865 * in <textures> is not zero or the name of an existing
1866 * texture object (per binding)."
1868 _mesa_error(ctx, GL_INVALID_OPERATION,
1869 "glBindTextures(textures[%d]=%u is not zero "
1870 "or the name of an existing texture object)",
1874 unbind_textures_from_unit(ctx, first + i);
1878 _mesa_end_texture_lookups(ctx);
1880 /* Unbind all textures in the range <first> through <first>+<count>-1 */
1881 for (i = 0; i < count; i++)
1882 unbind_textures_from_unit(ctx, first + i);
1888 * Set texture priorities.
1890 * \param n number of textures.
1891 * \param texName texture names.
1892 * \param priorities corresponding texture priorities.
1894 * \sa glPrioritizeTextures().
1896 * Looks up each texture in the hash, clamps the corresponding priority between
1897 * 0.0 and 1.0, and calls dd_function_table::PrioritizeTexture.
1900 _mesa_PrioritizeTextures( GLsizei n, const GLuint *texName,
1901 const GLclampf *priorities )
1903 GET_CURRENT_CONTEXT(ctx);
1906 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
1907 _mesa_debug(ctx, "glPrioritizeTextures %d\n", n);
1909 FLUSH_VERTICES(ctx, 0);
1912 _mesa_error( ctx, GL_INVALID_VALUE, "glPrioritizeTextures" );
1919 for (i = 0; i < n; i++) {
1920 if (texName[i] > 0) {
1921 struct gl_texture_object *t = _mesa_lookup_texture(ctx, texName[i]);
1923 t->Priority = CLAMP( priorities[i], 0.0F, 1.0F );
1928 ctx->NewState |= _NEW_TEXTURE;
1934 * See if textures are loaded in texture memory.
1936 * \param n number of textures to query.
1937 * \param texName array with the texture names.
1938 * \param residences array which will hold the residence status.
1940 * \return GL_TRUE if all textures are resident and
1941 * residences is left unchanged,
1943 * Note: we assume all textures are always resident
1945 GLboolean GLAPIENTRY
1946 _mesa_AreTexturesResident(GLsizei n, const GLuint *texName,
1947 GLboolean *residences)
1949 GET_CURRENT_CONTEXT(ctx);
1950 GLboolean allResident = GL_TRUE;
1952 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
1954 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
1955 _mesa_debug(ctx, "glAreTexturesResident %d\n", n);
1958 _mesa_error(ctx, GL_INVALID_VALUE, "glAreTexturesResident(n)");
1962 if (!texName || !residences)
1965 /* We only do error checking on the texture names */
1966 for (i = 0; i < n; i++) {
1967 struct gl_texture_object *t;
1968 if (texName[i] == 0) {
1969 _mesa_error(ctx, GL_INVALID_VALUE, "glAreTexturesResident");
1972 t = _mesa_lookup_texture(ctx, texName[i]);
1974 _mesa_error(ctx, GL_INVALID_VALUE, "glAreTexturesResident");
1984 * See if a name corresponds to a texture.
1986 * \param texture texture name.
1988 * \return GL_TRUE if texture name corresponds to a texture, or GL_FALSE
1991 * \sa glIsTexture().
1993 * Calls _mesa_HashLookup().
1995 GLboolean GLAPIENTRY
1996 _mesa_IsTexture( GLuint texture )
1998 struct gl_texture_object *t;
1999 GET_CURRENT_CONTEXT(ctx);
2000 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, GL_FALSE);
2002 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
2003 _mesa_debug(ctx, "glIsTexture %d\n", texture);
2008 t = _mesa_lookup_texture(ctx, texture);
2010 /* IsTexture is true only after object has been bound once. */
2011 return t && t->Target;
2016 * Simplest implementation of texture locking: grab the shared tex
2017 * mutex. Examine the shared context state timestamp and if there has
2018 * been a change, set the appropriate bits in ctx->NewState.
2020 * This is used to deal with synchronizing things when a texture object
2021 * is used/modified by different contexts (or threads) which are sharing
2024 * See also _mesa_lock/unlock_texture() in teximage.h
2027 _mesa_lock_context_textures( struct gl_context *ctx )
2029 mtx_lock(&ctx->Shared->TexMutex);
2031 if (ctx->Shared->TextureStateStamp != ctx->TextureStateTimestamp) {
2032 ctx->NewState |= _NEW_TEXTURE;
2033 ctx->TextureStateTimestamp = ctx->Shared->TextureStateStamp;
2039 _mesa_unlock_context_textures( struct gl_context *ctx )
2041 assert(ctx->Shared->TextureStateStamp == ctx->TextureStateTimestamp);
2042 mtx_unlock(&ctx->Shared->TexMutex);
2047 _mesa_InvalidateTexSubImage(GLuint texture, GLint level, GLint xoffset,
2048 GLint yoffset, GLint zoffset, GLsizei width,
2049 GLsizei height, GLsizei depth)
2051 struct gl_texture_object *t;
2052 struct gl_texture_image *image;
2053 GET_CURRENT_CONTEXT(ctx);
2055 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
2056 _mesa_debug(ctx, "glInvalidateTexSubImage %d\n", texture);
2058 t = invalidate_tex_image_error_check(ctx, texture, level,
2059 "glInvalidateTexSubImage");
2061 /* The GL_ARB_invalidate_subdata spec says:
2063 * "...the specified subregion must be between -<b> and <dim>+<b> where
2064 * <dim> is the size of the dimension of the texture image, and <b> is
2065 * the size of the border of that texture image, otherwise
2066 * INVALID_VALUE is generated (border is not applied to dimensions that
2067 * don't exist in a given texture target)."
2069 image = t->Image[0][level];
2078 /* The GL_ARB_invalidate_subdata spec says:
2080 * "For texture targets that don't have certain dimensions, this
2081 * command treats those dimensions as having a size of 1. For
2082 * example, to invalidate a portion of a two-dimensional texture,
2083 * the application would use <zoffset> equal to zero and <depth>
2086 switch (t->Target) {
2087 case GL_TEXTURE_BUFFER:
2096 xBorder = image->Border;
2099 imageWidth = image->Width;
2103 case GL_TEXTURE_1D_ARRAY:
2104 xBorder = image->Border;
2107 imageWidth = image->Width;
2108 imageHeight = image->Height;
2112 case GL_TEXTURE_CUBE_MAP:
2113 case GL_TEXTURE_RECTANGLE:
2114 case GL_TEXTURE_2D_MULTISAMPLE:
2115 xBorder = image->Border;
2116 yBorder = image->Border;
2118 imageWidth = image->Width;
2119 imageHeight = image->Height;
2122 case GL_TEXTURE_2D_ARRAY:
2123 case GL_TEXTURE_CUBE_MAP_ARRAY:
2124 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
2125 xBorder = image->Border;
2126 yBorder = image->Border;
2128 imageWidth = image->Width;
2129 imageHeight = image->Height;
2130 imageDepth = image->Depth;
2133 xBorder = image->Border;
2134 yBorder = image->Border;
2135 zBorder = image->Border;
2136 imageWidth = image->Width;
2137 imageHeight = image->Height;
2138 imageDepth = image->Depth;
2141 assert(!"Should not get here.");
2151 if (xoffset < -xBorder) {
2152 _mesa_error(ctx, GL_INVALID_VALUE, "glInvalidateSubTexImage(xoffset)");
2156 if (xoffset + width > imageWidth + xBorder) {
2157 _mesa_error(ctx, GL_INVALID_VALUE,
2158 "glInvalidateSubTexImage(xoffset+width)");
2162 if (yoffset < -yBorder) {
2163 _mesa_error(ctx, GL_INVALID_VALUE, "glInvalidateSubTexImage(yoffset)");
2167 if (yoffset + height > imageHeight + yBorder) {
2168 _mesa_error(ctx, GL_INVALID_VALUE,
2169 "glInvalidateSubTexImage(yoffset+height)");
2173 if (zoffset < -zBorder) {
2174 _mesa_error(ctx, GL_INVALID_VALUE,
2175 "glInvalidateSubTexImage(zoffset)");
2179 if (zoffset + depth > imageDepth + zBorder) {
2180 _mesa_error(ctx, GL_INVALID_VALUE,
2181 "glInvalidateSubTexImage(zoffset+depth)");
2186 /* We don't actually do anything for this yet. Just return after
2187 * validating the parameters and generating the required errors.
2194 _mesa_InvalidateTexImage(GLuint texture, GLint level)
2196 GET_CURRENT_CONTEXT(ctx);
2198 if (MESA_VERBOSE & (VERBOSE_API|VERBOSE_TEXTURE))
2199 _mesa_debug(ctx, "glInvalidateTexImage(%d, %d)\n", texture, level);
2201 invalidate_tex_image_error_check(ctx, texture, level,
2202 "glInvalidateTexImage");
2204 /* We don't actually do anything for this yet. Just return after
2205 * validating the parameters and generating the required errors.