3 * Texture object management.
7 * Mesa 3-D graphics library
10 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
26 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
27 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 #include "mfeatures.h"
32 #include "bufferobj.h"
45 #include "program/prog_instruction.h"
49 /**********************************************************************/
50 /** \name Internal functions */
55 * Return the gl_texture_object for a given ID.
57 struct gl_texture_object
*
58 _mesa_lookup_texture(struct gl_context
*ctx
, GLuint id
)
60 return (struct gl_texture_object
*)
61 _mesa_HashLookup(ctx
->Shared
->TexObjects
, id
);
67 * Allocate and initialize a new texture object. But don't put it into the
68 * texture object hash table.
70 * Called via ctx->Driver.NewTextureObject, unless overridden by a device
73 * \param shared the shared GL state structure to contain the texture object
74 * \param name integer name for the texture object
75 * \param target either GL_TEXTURE_1D, GL_TEXTURE_2D, GL_TEXTURE_3D,
76 * GL_TEXTURE_CUBE_MAP_ARB or GL_TEXTURE_RECTANGLE_NV. zero is ok for the sake
79 * \return pointer to new texture object.
81 struct gl_texture_object
*
82 _mesa_new_texture_object( struct gl_context
*ctx
, GLuint name
, GLenum target
)
84 struct gl_texture_object
*obj
;
86 obj
= MALLOC_STRUCT(gl_texture_object
);
87 _mesa_initialize_texture_object(obj
, name
, target
);
93 * Initialize a new texture object to default values.
94 * \param obj the texture object
95 * \param name the texture name
96 * \param target the texture target
99 _mesa_initialize_texture_object( struct gl_texture_object
*obj
,
100 GLuint name
, GLenum target
)
102 ASSERT(target
== 0 ||
103 target
== GL_TEXTURE_1D
||
104 target
== GL_TEXTURE_2D
||
105 target
== GL_TEXTURE_3D
||
106 target
== GL_TEXTURE_CUBE_MAP_ARB
||
107 target
== GL_TEXTURE_RECTANGLE_NV
||
108 target
== GL_TEXTURE_1D_ARRAY_EXT
||
109 target
== GL_TEXTURE_2D_ARRAY_EXT
||
110 target
== GL_TEXTURE_EXTERNAL_OES
||
111 target
== GL_TEXTURE_BUFFER
);
113 memset(obj
, 0, sizeof(*obj
));
114 /* init the non-zero fields */
115 _glthread_INIT_MUTEX(obj
->Mutex
);
118 obj
->Target
= target
;
119 obj
->Priority
= 1.0F
;
121 obj
->MaxLevel
= 1000;
123 /* must be one; no support for (YUV) planes in separate buffers */
124 obj
->RequiredTextureImageUnits
= 1;
127 if (target
== GL_TEXTURE_RECTANGLE_NV
||
128 target
== GL_TEXTURE_EXTERNAL_OES
) {
129 obj
->Sampler
.WrapS
= GL_CLAMP_TO_EDGE
;
130 obj
->Sampler
.WrapT
= GL_CLAMP_TO_EDGE
;
131 obj
->Sampler
.WrapR
= GL_CLAMP_TO_EDGE
;
132 obj
->Sampler
.MinFilter
= GL_LINEAR
;
135 obj
->Sampler
.WrapS
= GL_REPEAT
;
136 obj
->Sampler
.WrapT
= GL_REPEAT
;
137 obj
->Sampler
.WrapR
= GL_REPEAT
;
138 obj
->Sampler
.MinFilter
= GL_NEAREST_MIPMAP_LINEAR
;
140 obj
->Sampler
.MagFilter
= GL_LINEAR
;
141 obj
->Sampler
.MinLod
= -1000.0;
142 obj
->Sampler
.MaxLod
= 1000.0;
143 obj
->Sampler
.LodBias
= 0.0;
144 obj
->Sampler
.MaxAnisotropy
= 1.0;
145 obj
->Sampler
.CompareMode
= GL_NONE
; /* ARB_shadow */
146 obj
->Sampler
.CompareFunc
= GL_LEQUAL
; /* ARB_shadow */
147 obj
->Sampler
.CompareFailValue
= 0.0F
; /* ARB_shadow_ambient */
148 obj
->Sampler
.DepthMode
= GL_LUMINANCE
; /* ARB_depth_texture */
149 obj
->Sampler
.CubeMapSeamless
= GL_FALSE
;
150 obj
->Swizzle
[0] = GL_RED
;
151 obj
->Swizzle
[1] = GL_GREEN
;
152 obj
->Swizzle
[2] = GL_BLUE
;
153 obj
->Swizzle
[3] = GL_ALPHA
;
154 obj
->_Swizzle
= SWIZZLE_NOOP
;
155 obj
->Sampler
.sRGBDecode
= GL_DECODE_EXT
;
156 obj
->BufferObjectFormat
= GL_LUMINANCE8
;
161 * Some texture initialization can't be finished until we know which
162 * target it's getting bound to (GL_TEXTURE_1D/2D/etc).
165 finish_texture_init(struct gl_context
*ctx
, GLenum target
,
166 struct gl_texture_object
*obj
)
168 assert(obj
->Target
== 0);
170 if (target
== GL_TEXTURE_RECTANGLE_NV
||
171 target
== GL_TEXTURE_EXTERNAL_OES
) {
172 /* have to init wrap and filter state here - kind of klunky */
173 obj
->Sampler
.WrapS
= GL_CLAMP_TO_EDGE
;
174 obj
->Sampler
.WrapT
= GL_CLAMP_TO_EDGE
;
175 obj
->Sampler
.WrapR
= GL_CLAMP_TO_EDGE
;
176 obj
->Sampler
.MinFilter
= GL_LINEAR
;
177 if (ctx
->Driver
.TexParameter
) {
178 static const GLfloat fparam_wrap
[1] = {(GLfloat
) GL_CLAMP_TO_EDGE
};
179 static const GLfloat fparam_filter
[1] = {(GLfloat
) GL_LINEAR
};
180 ctx
->Driver
.TexParameter(ctx
, target
, obj
, GL_TEXTURE_WRAP_S
, fparam_wrap
);
181 ctx
->Driver
.TexParameter(ctx
, target
, obj
, GL_TEXTURE_WRAP_T
, fparam_wrap
);
182 ctx
->Driver
.TexParameter(ctx
, target
, obj
, GL_TEXTURE_WRAP_R
, fparam_wrap
);
183 ctx
->Driver
.TexParameter(ctx
, target
, obj
, GL_TEXTURE_MIN_FILTER
, fparam_filter
);
190 * Deallocate a texture object struct. It should have already been
191 * removed from the texture object pool.
192 * Called via ctx->Driver.DeleteTexture() if not overriden by a driver.
194 * \param shared the shared GL state to which the object belongs.
195 * \param texObj the texture object to delete.
198 _mesa_delete_texture_object(struct gl_context
*ctx
,
199 struct gl_texture_object
*texObj
)
203 /* Set Target to an invalid value. With some assertions elsewhere
204 * we can try to detect possible use of deleted textures.
206 texObj
->Target
= 0x99;
208 /* free the texture images */
209 for (face
= 0; face
< 6; face
++) {
210 for (i
= 0; i
< MAX_TEXTURE_LEVELS
; i
++) {
211 if (texObj
->Image
[face
][i
]) {
212 ctx
->Driver
.DeleteTextureImage(ctx
, texObj
->Image
[face
][i
]);
217 _mesa_reference_buffer_object(ctx
, &texObj
->BufferObject
, NULL
);
219 /* destroy the mutex -- it may have allocated memory (eg on bsd) */
220 _glthread_DESTROY_MUTEX(texObj
->Mutex
);
222 /* free this object */
229 * Copy texture object state from one texture object to another.
230 * Use for glPush/PopAttrib.
232 * \param dest destination texture object.
233 * \param src source texture object.
236 _mesa_copy_texture_object( struct gl_texture_object
*dest
,
237 const struct gl_texture_object
*src
)
239 dest
->Target
= src
->Target
;
240 dest
->Name
= src
->Name
;
241 dest
->Priority
= src
->Priority
;
242 dest
->Sampler
.BorderColor
.f
[0] = src
->Sampler
.BorderColor
.f
[0];
243 dest
->Sampler
.BorderColor
.f
[1] = src
->Sampler
.BorderColor
.f
[1];
244 dest
->Sampler
.BorderColor
.f
[2] = src
->Sampler
.BorderColor
.f
[2];
245 dest
->Sampler
.BorderColor
.f
[3] = src
->Sampler
.BorderColor
.f
[3];
246 dest
->Sampler
.WrapS
= src
->Sampler
.WrapS
;
247 dest
->Sampler
.WrapT
= src
->Sampler
.WrapT
;
248 dest
->Sampler
.WrapR
= src
->Sampler
.WrapR
;
249 dest
->Sampler
.MinFilter
= src
->Sampler
.MinFilter
;
250 dest
->Sampler
.MagFilter
= src
->Sampler
.MagFilter
;
251 dest
->Sampler
.MinLod
= src
->Sampler
.MinLod
;
252 dest
->Sampler
.MaxLod
= src
->Sampler
.MaxLod
;
253 dest
->Sampler
.LodBias
= src
->Sampler
.LodBias
;
254 dest
->BaseLevel
= src
->BaseLevel
;
255 dest
->MaxLevel
= src
->MaxLevel
;
256 dest
->Sampler
.MaxAnisotropy
= src
->Sampler
.MaxAnisotropy
;
257 dest
->Sampler
.CompareMode
= src
->Sampler
.CompareMode
;
258 dest
->Sampler
.CompareFunc
= src
->Sampler
.CompareFunc
;
259 dest
->Sampler
.CompareFailValue
= src
->Sampler
.CompareFailValue
;
260 dest
->Sampler
.CubeMapSeamless
= src
->Sampler
.CubeMapSeamless
;
261 dest
->Sampler
.DepthMode
= src
->Sampler
.DepthMode
;
262 dest
->Sampler
.sRGBDecode
= src
->Sampler
.sRGBDecode
;
263 dest
->_MaxLevel
= src
->_MaxLevel
;
264 dest
->_MaxLambda
= src
->_MaxLambda
;
265 dest
->GenerateMipmap
= src
->GenerateMipmap
;
266 dest
->_BaseComplete
= src
->_BaseComplete
;
267 dest
->_MipmapComplete
= src
->_MipmapComplete
;
268 COPY_4V(dest
->Swizzle
, src
->Swizzle
);
269 dest
->_Swizzle
= src
->_Swizzle
;
271 dest
->RequiredTextureImageUnits
= src
->RequiredTextureImageUnits
;
276 * Free all texture images of the given texture object.
278 * \param ctx GL context.
279 * \param t texture object.
281 * \sa _mesa_clear_texture_image().
284 _mesa_clear_texture_object(struct gl_context
*ctx
,
285 struct gl_texture_object
*texObj
)
289 if (texObj
->Target
== 0)
292 for (i
= 0; i
< MAX_FACES
; i
++) {
293 for (j
= 0; j
< MAX_TEXTURE_LEVELS
; j
++) {
294 struct gl_texture_image
*texImage
= texObj
->Image
[i
][j
];
296 _mesa_clear_texture_image(ctx
, texImage
);
303 * Check if the given texture object is valid by examining its Target field.
304 * For debugging only.
307 valid_texture_object(const struct gl_texture_object
*tex
)
309 switch (tex
->Target
) {
314 case GL_TEXTURE_CUBE_MAP_ARB
:
315 case GL_TEXTURE_RECTANGLE_NV
:
316 case GL_TEXTURE_1D_ARRAY_EXT
:
317 case GL_TEXTURE_2D_ARRAY_EXT
:
318 case GL_TEXTURE_BUFFER
:
319 case GL_TEXTURE_EXTERNAL_OES
:
322 _mesa_problem(NULL
, "invalid reference to a deleted texture object");
325 _mesa_problem(NULL
, "invalid texture object Target 0x%x, Id = %u",
326 tex
->Target
, tex
->Name
);
333 * Reference (or unreference) a texture object.
334 * If '*ptr', decrement *ptr's refcount (and delete if it becomes zero).
335 * If 'tex' is non-null, increment its refcount.
336 * This is normally only called from the _mesa_reference_texobj() macro
337 * when there's a real pointer change.
340 _mesa_reference_texobj_(struct gl_texture_object
**ptr
,
341 struct gl_texture_object
*tex
)
346 /* Unreference the old texture */
347 GLboolean deleteFlag
= GL_FALSE
;
348 struct gl_texture_object
*oldTex
= *ptr
;
350 ASSERT(valid_texture_object(oldTex
));
351 (void) valid_texture_object
; /* silence warning in release builds */
353 _glthread_LOCK_MUTEX(oldTex
->Mutex
);
354 ASSERT(oldTex
->RefCount
> 0);
357 deleteFlag
= (oldTex
->RefCount
== 0);
358 _glthread_UNLOCK_MUTEX(oldTex
->Mutex
);
361 GET_CURRENT_CONTEXT(ctx
);
363 ctx
->Driver
.DeleteTexture(ctx
, oldTex
);
365 _mesa_problem(NULL
, "Unable to delete texture, no context");
373 /* reference new texture */
374 ASSERT(valid_texture_object(tex
));
375 _glthread_LOCK_MUTEX(tex
->Mutex
);
376 if (tex
->RefCount
== 0) {
377 /* this texture's being deleted (look just above) */
378 /* Not sure this can every really happen. Warn if it does. */
379 _mesa_problem(NULL
, "referencing deleted texture object");
386 _glthread_UNLOCK_MUTEX(tex
->Mutex
);
391 enum base_mipmap
{ BASE
, MIPMAP
};
395 * Mark a texture object as incomplete. There are actually three kinds of
397 * 1. "base incomplete": the base level of the texture is invalid so no
398 * texturing is possible.
399 * 2. "mipmap incomplete": a non-base level of the texture is invalid so
400 * mipmap filtering isn't possible, but non-mipmap filtering is.
401 * 3. "texture incompleteness": some combination of texture state and
402 * sampler state renders the texture incomplete.
404 * \param t texture object
405 * \param bm either BASE or MIPMAP to indicate what's incomplete
406 * \param fmt... string describing why it's incomplete (for debugging).
409 incomplete(struct gl_texture_object
*t
, enum base_mipmap bm
,
410 const char *fmt
, ...)
417 vsnprintf(s
, sizeof(s
), fmt
, args
);
420 printf("Texture Obj %d incomplete because: %s\n", t
->Name
, s
);
423 t
->_BaseComplete
= GL_FALSE
;
424 t
->_MipmapComplete
= GL_FALSE
;
429 * Examine a texture object to determine if it is complete.
431 * The gl_texture_object::Complete flag will be set to GL_TRUE or GL_FALSE
434 * \param ctx GL context.
435 * \param t texture object.
437 * According to the texture target, verifies that each of the mipmaps is
438 * present and has the expected size.
441 _mesa_test_texobj_completeness( const struct gl_context
*ctx
,
442 struct gl_texture_object
*t
)
444 const GLint baseLevel
= t
->BaseLevel
;
445 const struct gl_texture_image
*baseImage
;
446 GLint maxLog2
= 0, maxLevels
= 0;
448 /* We'll set these to FALSE if tests fail below */
449 t
->_BaseComplete
= GL_TRUE
;
450 t
->_MipmapComplete
= GL_TRUE
;
452 /* Detect cases where the application set the base level to an invalid
455 if ((baseLevel
< 0) || (baseLevel
>= MAX_TEXTURE_LEVELS
)) {
456 incomplete(t
, BASE
, "base level = %d is invalid", baseLevel
);
460 if (t
->MaxLevel
< baseLevel
) {
461 incomplete(t
, BASE
, "MAX_LEVEL (%d) < BASE_LEVEL (%d)",
462 t
->MaxLevel
, baseLevel
);
466 baseImage
= t
->Image
[0][baseLevel
];
468 /* Always need the base level image */
470 incomplete(t
, BASE
, "Image[baseLevel=%d] == NULL", baseLevel
);
474 /* Check width/height/depth for zero */
475 if (baseImage
->Width
== 0 ||
476 baseImage
->Height
== 0 ||
477 baseImage
->Depth
== 0) {
478 incomplete(t
, BASE
, "texture width or height or depth = 0");
482 /* Check if the texture values are integer */
484 GLenum datatype
= _mesa_get_format_datatype(baseImage
->TexFormat
);
485 t
->_IsIntegerFormat
= datatype
== GL_INT
|| datatype
== GL_UNSIGNED_INT
;
488 /* Compute _MaxLevel (the maximum mipmap level we'll sample from given the
489 * mipmap image sizes and GL_TEXTURE_MAX_LEVEL state).
493 case GL_TEXTURE_1D_ARRAY_EXT
:
494 maxLog2
= baseImage
->WidthLog2
;
495 maxLevels
= ctx
->Const
.MaxTextureLevels
;
498 case GL_TEXTURE_2D_ARRAY_EXT
:
499 maxLog2
= MAX2(baseImage
->WidthLog2
,
500 baseImage
->HeightLog2
);
501 maxLevels
= ctx
->Const
.MaxTextureLevels
;
504 maxLog2
= MAX3(baseImage
->WidthLog2
,
505 baseImage
->HeightLog2
,
506 baseImage
->DepthLog2
);
507 maxLevels
= ctx
->Const
.Max3DTextureLevels
;
509 case GL_TEXTURE_CUBE_MAP_ARB
:
510 maxLog2
= MAX2(baseImage
->WidthLog2
,
511 baseImage
->HeightLog2
);
512 maxLevels
= ctx
->Const
.MaxCubeTextureLevels
;
514 case GL_TEXTURE_RECTANGLE_NV
:
515 case GL_TEXTURE_BUFFER
:
516 case GL_TEXTURE_EXTERNAL_OES
:
517 maxLog2
= 0; /* not applicable */
518 maxLevels
= 1; /* no mipmapping */
521 _mesa_problem(ctx
, "Bad t->Target in _mesa_test_texobj_completeness");
525 ASSERT(maxLevels
> 0);
527 t
->_MaxLevel
= baseLevel
+ maxLog2
; /* 'p' in the GL spec */
528 t
->_MaxLevel
= MIN2(t
->_MaxLevel
, t
->MaxLevel
);
529 t
->_MaxLevel
= MIN2(t
->_MaxLevel
, maxLevels
- 1); /* 'q' in the GL spec */
531 /* Compute _MaxLambda = q - b (see the 1.2 spec) used during mipmapping */
532 t
->_MaxLambda
= (GLfloat
) (t
->_MaxLevel
- baseLevel
);
535 /* This texture object was created with glTexStorage1/2/3D() so we
536 * know that all the mipmap levels are the right size and all cube
537 * map faces are the same size.
538 * We don't need to do any of the additional checks below.
543 if (t
->Target
== GL_TEXTURE_CUBE_MAP_ARB
) {
544 /* Make sure that all six cube map level 0 images are the same size.
545 * Note: we know that the image's width==height (we enforce that
546 * at glTexImage time) so we only need to test the width here.
549 assert(baseImage
->Width2
== baseImage
->Height
);
550 for (face
= 1; face
< 6; face
++) {
551 assert(t
->Image
[face
][baseLevel
]->Width2
==
552 t
->Image
[face
][baseLevel
]->Height2
);
553 if (t
->Image
[face
][baseLevel
] == NULL
||
554 t
->Image
[face
][baseLevel
]->Width2
!= baseImage
->Width2
) {
555 incomplete(t
, BASE
, "Cube face missing or mismatched size");
562 * Do mipmap consistency checking.
563 * Note: we don't care about the current texture sampler state here.
564 * To determine texture completeness we'll either look at _BaseComplete
565 * or _MipmapComplete depending on the current minification filter mode.
569 const GLint minLevel
= baseLevel
;
570 const GLint maxLevel
= t
->_MaxLevel
;
571 const GLuint numFaces
= t
->Target
== GL_TEXTURE_CUBE_MAP
? 6 : 1;
572 GLuint width
, height
, depth
, face
;
574 if (minLevel
> maxLevel
) {
575 incomplete(t
, BASE
, "minLevel > maxLevel");
579 /* Get the base image's dimensions */
580 width
= baseImage
->Width2
;
581 height
= baseImage
->Height2
;
582 depth
= baseImage
->Depth2
;
584 /* Note: this loop will be a no-op for RECT, BUFFER, EXTERNAL textures */
585 for (i
= baseLevel
+ 1; i
< maxLevels
; i
++) {
586 /* Compute the expected size of image at level[i] */
590 if (height
> 1 && t
->Target
!= GL_TEXTURE_1D_ARRAY
) {
593 if (depth
> 1 && t
->Target
!= GL_TEXTURE_2D_ARRAY
) {
597 /* loop over cube faces (or single face otherwise) */
598 for (face
= 0; face
< numFaces
; face
++) {
599 if (i
>= minLevel
&& i
<= maxLevel
) {
600 const struct gl_texture_image
*img
= t
->Image
[face
][i
];
603 incomplete(t
, MIPMAP
, "TexImage[%d] is missing", i
);
606 if (img
->TexFormat
!= baseImage
->TexFormat
) {
607 incomplete(t
, MIPMAP
, "Format[i] != Format[baseLevel]");
610 if (img
->Border
!= baseImage
->Border
) {
611 incomplete(t
, MIPMAP
, "Border[i] != Border[baseLevel]");
614 if (img
->Width2
!= width
) {
615 incomplete(t
, MIPMAP
, "TexImage[%d] bad width %u", i
, img
->Width2
);
618 if (img
->Height2
!= height
) {
619 incomplete(t
, MIPMAP
, "TexImage[%d] bad height %u", i
, img
->Height2
);
622 if (img
->Depth2
!= depth
) {
623 incomplete(t
, MIPMAP
, "TexImage[%d] bad depth %u", i
, img
->Depth2
);
627 /* Extra checks for cube textures */
629 /* check that cube faces are the same size */
630 if (img
->Width2
!= t
->Image
[0][i
]->Width2
||
631 img
->Height2
!= t
->Image
[0][i
]->Height2
) {
632 incomplete(t
, MIPMAP
, "CubeMap Image[n][i] bad size");
639 if (width
== 1 && height
== 1 && depth
== 1) {
640 return; /* found smallest needed mipmap, all done! */
648 * Check if the given cube map texture is "cube complete" as defined in
649 * the OpenGL specification.
652 _mesa_cube_complete(const struct gl_texture_object
*texObj
)
654 const GLint baseLevel
= texObj
->BaseLevel
;
655 const struct gl_texture_image
*img0
, *img
;
658 if (texObj
->Target
!= GL_TEXTURE_CUBE_MAP
)
661 if ((baseLevel
< 0) || (baseLevel
>= MAX_TEXTURE_LEVELS
))
664 /* check first face */
665 img0
= texObj
->Image
[0][baseLevel
];
668 img0
->Width
!= img0
->Height
)
671 /* check remaining faces vs. first face */
672 for (face
= 1; face
< 6; face
++) {
673 img
= texObj
->Image
[face
][baseLevel
];
675 img
->Width
!= img0
->Width
||
676 img
->Height
!= img0
->Height
||
677 img
->TexFormat
!= img0
->TexFormat
)
686 * Mark a texture object dirty. It forces the object to be incomplete
687 * and optionally forces the context to re-validate its state.
689 * \param ctx GL context.
690 * \param texObj texture object.
691 * \param invalidate_state also invalidate context state.
694 _mesa_dirty_texobj(struct gl_context
*ctx
, struct gl_texture_object
*texObj
,
695 GLboolean invalidate_state
)
697 texObj
->_BaseComplete
= GL_FALSE
;
698 texObj
->_MipmapComplete
= GL_FALSE
;
699 if (invalidate_state
)
700 ctx
->NewState
|= _NEW_TEXTURE
;
705 * Return pointer to a default/fallback texture of the given type/target.
706 * The texture is an RGBA texture with all texels = (0,0,0,1).
707 * That's the value a GLSL sampler should get when sampling from an
708 * incomplete texture.
710 struct gl_texture_object
*
711 _mesa_get_fallback_texture(struct gl_context
*ctx
, gl_texture_index tex
)
713 if (!ctx
->Shared
->FallbackTex
[tex
]) {
714 /* create fallback texture now */
715 const GLsizei width
= 1, height
= 1, depth
= 1;
717 struct gl_texture_object
*texObj
;
718 struct gl_texture_image
*texImage
;
720 GLuint dims
, face
, numFaces
= 1;
729 case TEXTURE_2D_ARRAY_INDEX
:
731 target
= GL_TEXTURE_2D_ARRAY
;
733 case TEXTURE_1D_ARRAY_INDEX
:
735 target
= GL_TEXTURE_1D_ARRAY
;
737 case TEXTURE_CUBE_INDEX
:
739 target
= GL_TEXTURE_CUBE_MAP
;
742 case TEXTURE_3D_INDEX
:
744 target
= GL_TEXTURE_3D
;
746 case TEXTURE_RECT_INDEX
:
748 target
= GL_TEXTURE_RECTANGLE
;
750 case TEXTURE_2D_INDEX
:
752 target
= GL_TEXTURE_2D
;
754 case TEXTURE_1D_INDEX
:
756 target
= GL_TEXTURE_1D
;
758 case TEXTURE_BUFFER_INDEX
:
759 case TEXTURE_EXTERNAL_INDEX
:
765 /* create texture object */
766 texObj
= ctx
->Driver
.NewTextureObject(ctx
, 0, target
);
770 assert(texObj
->RefCount
== 1);
771 texObj
->Sampler
.MinFilter
= GL_NEAREST
;
772 texObj
->Sampler
.MagFilter
= GL_NEAREST
;
774 texFormat
= ctx
->Driver
.ChooseTextureFormat(ctx
, GL_RGBA
, GL_RGBA
,
777 /* need a loop here just for cube maps */
778 for (face
= 0; face
< numFaces
; face
++) {
781 if (target
== GL_TEXTURE_CUBE_MAP
)
782 faceTarget
= GL_TEXTURE_CUBE_MAP_POSITIVE_X
+ face
;
786 /* initialize level[0] texture image */
787 texImage
= _mesa_get_tex_image(ctx
, texObj
, faceTarget
, 0);
789 _mesa_init_teximage_fields(ctx
, texImage
,
791 (dims
> 1) ? height
: 1,
792 (dims
> 2) ? depth
: 1,
798 ctx
->Driver
.TexImage1D(ctx
, texImage
, GL_RGBA
,
800 GL_RGBA
, GL_UNSIGNED_BYTE
, texel
,
801 &ctx
->DefaultPacking
);
804 ctx
->Driver
.TexImage2D(ctx
, texImage
, GL_RGBA
,
806 GL_RGBA
, GL_UNSIGNED_BYTE
, texel
,
807 &ctx
->DefaultPacking
);
810 ctx
->Driver
.TexImage3D(ctx
, texImage
, GL_RGBA
,
811 width
, height
, depth
, 0,
812 GL_RGBA
, GL_UNSIGNED_BYTE
, texel
,
813 &ctx
->DefaultPacking
);
816 _mesa_problem(ctx
, "bad dims in _mesa_get_fallback_texture()");
820 _mesa_test_texobj_completeness(ctx
, texObj
);
821 assert(texObj
->_BaseComplete
);
822 assert(texObj
->_MipmapComplete
);
824 ctx
->Shared
->FallbackTex
[tex
] = texObj
;
826 return ctx
->Shared
->FallbackTex
[tex
];
833 /***********************************************************************/
834 /** \name API functions */
839 * Generate texture names.
841 * \param n number of texture names to be generated.
842 * \param textures an array in which will hold the generated texture names.
844 * \sa glGenTextures().
846 * Calls _mesa_HashFindFreeKeyBlock() to find a block of free texture
847 * IDs which are stored in \p textures. Corresponding empty texture
848 * objects are also generated.
851 _mesa_GenTextures( GLsizei n
, GLuint
*textures
)
853 GET_CURRENT_CONTEXT(ctx
);
856 ASSERT_OUTSIDE_BEGIN_END(ctx
);
859 _mesa_error( ctx
, GL_INVALID_VALUE
, "glGenTextures" );
867 * This must be atomic (generation and allocation of texture IDs)
869 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
871 first
= _mesa_HashFindFreeKeyBlock(ctx
->Shared
->TexObjects
, n
);
873 /* Allocate new, empty texture objects */
874 for (i
= 0; i
< n
; i
++) {
875 struct gl_texture_object
*texObj
;
876 GLuint name
= first
+ i
;
878 texObj
= ctx
->Driver
.NewTextureObject(ctx
, name
, target
);
880 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
881 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glGenTextures");
885 /* insert into hash table */
886 _mesa_HashInsert(ctx
->Shared
->TexObjects
, texObj
->Name
, texObj
);
891 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
896 * Check if the given texture object is bound to the current draw or
897 * read framebuffer. If so, Unbind it.
900 unbind_texobj_from_fbo(struct gl_context
*ctx
,
901 struct gl_texture_object
*texObj
)
903 const GLuint n
= (ctx
->DrawBuffer
== ctx
->ReadBuffer
) ? 1 : 2;
906 for (i
= 0; i
< n
; i
++) {
907 struct gl_framebuffer
*fb
= (i
== 0) ? ctx
->DrawBuffer
: ctx
->ReadBuffer
;
908 if (_mesa_is_user_fbo(fb
)) {
910 for (j
= 0; j
< BUFFER_COUNT
; j
++) {
911 if (fb
->Attachment
[j
].Type
== GL_TEXTURE
&&
912 fb
->Attachment
[j
].Texture
== texObj
) {
913 /* Vertices are already flushed by _mesa_DeleteTextures */
914 ctx
->NewState
|= _NEW_BUFFERS
;
915 _mesa_remove_attachment(ctx
, fb
->Attachment
+ j
);
924 * Check if the given texture object is bound to any texture image units and
925 * unbind it if so (revert to default textures).
928 unbind_texobj_from_texunits(struct gl_context
*ctx
,
929 struct gl_texture_object
*texObj
)
933 for (u
= 0; u
< Elements(ctx
->Texture
.Unit
); u
++) {
934 struct gl_texture_unit
*unit
= &ctx
->Texture
.Unit
[u
];
935 for (tex
= 0; tex
< NUM_TEXTURE_TARGETS
; tex
++) {
936 if (texObj
== unit
->CurrentTex
[tex
]) {
937 _mesa_reference_texobj(&unit
->CurrentTex
[tex
],
938 ctx
->Shared
->DefaultTex
[tex
]);
939 ASSERT(unit
->CurrentTex
[tex
]);
948 * Delete named textures.
950 * \param n number of textures to be deleted.
951 * \param textures array of texture IDs to be deleted.
953 * \sa glDeleteTextures().
955 * If we're about to delete a texture that's currently bound to any
956 * texture unit, unbind the texture first. Decrement the reference
957 * count on the texture object and delete it if it's zero.
958 * Recall that texture objects can be shared among several rendering
962 _mesa_DeleteTextures( GLsizei n
, const GLuint
*textures
)
964 GET_CURRENT_CONTEXT(ctx
);
966 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
); /* too complex */
971 for (i
= 0; i
< n
; i
++) {
972 if (textures
[i
] > 0) {
973 struct gl_texture_object
*delObj
974 = _mesa_lookup_texture(ctx
, textures
[i
]);
977 _mesa_lock_texture(ctx
, delObj
);
979 /* Check if texture is bound to any framebuffer objects.
981 * See section 4.4.2.3 of GL_EXT_framebuffer_object.
983 unbind_texobj_from_fbo(ctx
, delObj
);
985 /* Check if this texture is currently bound to any texture units.
988 unbind_texobj_from_texunits(ctx
, delObj
);
990 _mesa_unlock_texture(ctx
, delObj
);
992 ctx
->NewState
|= _NEW_TEXTURE
;
994 /* The texture _name_ is now free for re-use.
995 * Remove it from the hash table now.
997 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
998 _mesa_HashRemove(ctx
->Shared
->TexObjects
, delObj
->Name
);
999 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
1001 /* Unreference the texobj. If refcount hits zero, the texture
1004 _mesa_reference_texobj(&delObj
, NULL
);
1012 * Convert a GL texture target enum such as GL_TEXTURE_2D or GL_TEXTURE_3D
1013 * into the corresponding Mesa texture target index.
1014 * Note that proxy targets are not valid here.
1015 * \return TEXTURE_x_INDEX or -1 if target is invalid
1018 target_enum_to_index(GLenum target
)
1022 return TEXTURE_1D_INDEX
;
1024 return TEXTURE_2D_INDEX
;
1026 return TEXTURE_3D_INDEX
;
1027 case GL_TEXTURE_CUBE_MAP_ARB
:
1028 return TEXTURE_CUBE_INDEX
;
1029 case GL_TEXTURE_RECTANGLE_NV
:
1030 return TEXTURE_RECT_INDEX
;
1031 case GL_TEXTURE_1D_ARRAY_EXT
:
1032 return TEXTURE_1D_ARRAY_INDEX
;
1033 case GL_TEXTURE_2D_ARRAY_EXT
:
1034 return TEXTURE_2D_ARRAY_INDEX
;
1035 case GL_TEXTURE_BUFFER_ARB
:
1036 return TEXTURE_BUFFER_INDEX
;
1037 case GL_TEXTURE_EXTERNAL_OES
:
1038 return TEXTURE_EXTERNAL_INDEX
;
1046 * Bind a named texture to a texturing target.
1048 * \param target texture target.
1049 * \param texName texture name.
1051 * \sa glBindTexture().
1053 * Determines the old texture object bound and returns immediately if rebinding
1054 * the same texture. Get the current texture which is either a default texture
1055 * if name is null, a named texture from the hash, or a new texture if the
1056 * given texture name is new. Increments its reference count, binds it, and
1057 * calls dd_function_table::BindTexture. Decrements the old texture reference
1058 * count and deletes it if it reaches zero.
1061 _mesa_BindTexture( GLenum target
, GLuint texName
)
1063 GET_CURRENT_CONTEXT(ctx
);
1064 struct gl_texture_unit
*texUnit
= _mesa_get_current_tex_unit(ctx
);
1065 struct gl_texture_object
*newTexObj
= NULL
;
1067 ASSERT_OUTSIDE_BEGIN_END(ctx
);
1069 if (MESA_VERBOSE
& (VERBOSE_API
|VERBOSE_TEXTURE
))
1070 _mesa_debug(ctx
, "glBindTexture %s %d\n",
1071 _mesa_lookup_enum_by_nr(target
), (GLint
) texName
);
1073 targetIndex
= target_enum_to_index(target
);
1074 if (targetIndex
< 0) {
1075 _mesa_error(ctx
, GL_INVALID_ENUM
, "glBindTexture(target)");
1078 assert(targetIndex
< NUM_TEXTURE_TARGETS
);
1081 * Get pointer to new texture object (newTexObj)
1084 /* Use a default texture object */
1085 newTexObj
= ctx
->Shared
->DefaultTex
[targetIndex
];
1088 /* non-default texture object */
1089 newTexObj
= _mesa_lookup_texture(ctx
, texName
);
1091 /* error checking */
1092 if (newTexObj
->Target
!= 0 && newTexObj
->Target
!= target
) {
1093 /* the named texture object's target doesn't match the given target */
1094 _mesa_error( ctx
, GL_INVALID_OPERATION
,
1095 "glBindTexture(target mismatch)" );
1098 if (newTexObj
->Target
== 0) {
1099 finish_texture_init(ctx
, target
, newTexObj
);
1103 /* if this is a new texture id, allocate a texture object now */
1104 newTexObj
= ctx
->Driver
.NewTextureObject(ctx
, texName
, target
);
1106 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBindTexture");
1110 /* and insert it into hash table */
1111 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
1112 _mesa_HashInsert(ctx
->Shared
->TexObjects
, texName
, newTexObj
);
1113 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
1115 newTexObj
->Target
= target
;
1118 assert(valid_texture_object(newTexObj
));
1120 /* Check if this texture is only used by this context and is already bound.
1121 * If so, just return.
1124 GLboolean early_out
;
1125 _glthread_LOCK_MUTEX(ctx
->Shared
->Mutex
);
1126 early_out
= ((ctx
->Shared
->RefCount
== 1)
1127 && (newTexObj
== texUnit
->CurrentTex
[targetIndex
]));
1128 _glthread_UNLOCK_MUTEX(ctx
->Shared
->Mutex
);
1134 /* flush before changing binding */
1135 FLUSH_VERTICES(ctx
, _NEW_TEXTURE
);
1137 /* Do the actual binding. The refcount on the previously bound
1138 * texture object will be decremented. It'll be deleted if the
1141 _mesa_reference_texobj(&texUnit
->CurrentTex
[targetIndex
], newTexObj
);
1142 ASSERT(texUnit
->CurrentTex
[targetIndex
]);
1144 /* Pass BindTexture call to device driver */
1145 if (ctx
->Driver
.BindTexture
)
1146 ctx
->Driver
.BindTexture(ctx
, target
, newTexObj
);
1151 * Set texture priorities.
1153 * \param n number of textures.
1154 * \param texName texture names.
1155 * \param priorities corresponding texture priorities.
1157 * \sa glPrioritizeTextures().
1159 * Looks up each texture in the hash, clamps the corresponding priority between
1160 * 0.0 and 1.0, and calls dd_function_table::PrioritizeTexture.
1163 _mesa_PrioritizeTextures( GLsizei n
, const GLuint
*texName
,
1164 const GLclampf
*priorities
)
1166 GET_CURRENT_CONTEXT(ctx
);
1168 ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx
);
1171 _mesa_error( ctx
, GL_INVALID_VALUE
, "glPrioritizeTextures" );
1178 for (i
= 0; i
< n
; i
++) {
1179 if (texName
[i
] > 0) {
1180 struct gl_texture_object
*t
= _mesa_lookup_texture(ctx
, texName
[i
]);
1182 t
->Priority
= CLAMP( priorities
[i
], 0.0F
, 1.0F
);
1187 ctx
->NewState
|= _NEW_TEXTURE
;
1193 * See if textures are loaded in texture memory.
1195 * \param n number of textures to query.
1196 * \param texName array with the texture names.
1197 * \param residences array which will hold the residence status.
1199 * \return GL_TRUE if all textures are resident and \p residences is left unchanged,
1201 * Note: we assume all textures are always resident
1203 GLboolean GLAPIENTRY
1204 _mesa_AreTexturesResident(GLsizei n
, const GLuint
*texName
,
1205 GLboolean
*residences
)
1207 GET_CURRENT_CONTEXT(ctx
);
1208 GLboolean allResident
= GL_TRUE
;
1210 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
1213 _mesa_error(ctx
, GL_INVALID_VALUE
, "glAreTexturesResident(n)");
1217 if (!texName
|| !residences
)
1220 /* We only do error checking on the texture names */
1221 for (i
= 0; i
< n
; i
++) {
1222 struct gl_texture_object
*t
;
1223 if (texName
[i
] == 0) {
1224 _mesa_error(ctx
, GL_INVALID_VALUE
, "glAreTexturesResident");
1227 t
= _mesa_lookup_texture(ctx
, texName
[i
]);
1229 _mesa_error(ctx
, GL_INVALID_VALUE
, "glAreTexturesResident");
1239 * See if a name corresponds to a texture.
1241 * \param texture texture name.
1243 * \return GL_TRUE if texture name corresponds to a texture, or GL_FALSE
1246 * \sa glIsTexture().
1248 * Calls _mesa_HashLookup().
1250 GLboolean GLAPIENTRY
1251 _mesa_IsTexture( GLuint texture
)
1253 struct gl_texture_object
*t
;
1254 GET_CURRENT_CONTEXT(ctx
);
1255 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
1260 t
= _mesa_lookup_texture(ctx
, texture
);
1262 /* IsTexture is true only after object has been bound once. */
1263 return t
&& t
->Target
;
1268 * Simplest implementation of texture locking: grab the shared tex
1269 * mutex. Examine the shared context state timestamp and if there has
1270 * been a change, set the appropriate bits in ctx->NewState.
1272 * This is used to deal with synchronizing things when a texture object
1273 * is used/modified by different contexts (or threads) which are sharing
1276 * See also _mesa_lock/unlock_texture() in teximage.h
1279 _mesa_lock_context_textures( struct gl_context
*ctx
)
1281 _glthread_LOCK_MUTEX(ctx
->Shared
->TexMutex
);
1283 if (ctx
->Shared
->TextureStateStamp
!= ctx
->TextureStateTimestamp
) {
1284 ctx
->NewState
|= _NEW_TEXTURE
;
1285 ctx
->TextureStateTimestamp
= ctx
->Shared
->TextureStateStamp
;
1291 _mesa_unlock_context_textures( struct gl_context
*ctx
)
1293 assert(ctx
->Shared
->TextureStateStamp
== ctx
->TextureStateTimestamp
);
1294 _glthread_UNLOCK_MUTEX(ctx
->Shared
->TexMutex
);