src/mesa/main/texobj.h

   1 /**
   2  * \file texobj.h
   3  * Texture object management.
   4  */
   5
   6 /*
   7  * Mesa 3-D graphics library
   8  *
   9  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
  10  *
  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:
  17  *
  18  * The above copyright notice and this permission notice shall be included
  19  * in all copies or substantial portions of the Software.
  20  *
  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.
  28  */
  29
  30
  31 #ifndef TEXTOBJ_H
  32 #define TEXTOBJ_H
  33
  34
  35 #include "compiler.h"
  36 #include "glheader.h"
  37 #include "mtypes.h"
  38 #include "samplerobj.h"
  39
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45
  46 /**
  47  * \name Internal functions
  48  */
  49 /*@{*/
  50
  51 extern struct gl_texture_object *
  52 _mesa_lookup_texture(struct gl_context *ctx, GLuint id);
  53
  54 extern struct gl_texture_object *
  55 _mesa_lookup_texture_err(struct gl_context *ctx, GLuint id, const char* func);
  56
  57 extern void
  58 _mesa_begin_texture_lookups(struct gl_context *ctx);
  59
  60 extern void
  61 _mesa_end_texture_lookups(struct gl_context *ctx);
  62
  63 extern struct gl_texture_object *
  64 _mesa_lookup_texture_locked(struct gl_context *ctx, GLuint id);
  65
  66 extern struct gl_texture_object *
  67 _mesa_new_texture_object( struct gl_context *ctx, GLuint name, GLenum target );
  68
  69 extern void
  70 _mesa_initialize_texture_object( struct gl_context *ctx,
  71                                  struct gl_texture_object *obj,
  72                                  GLuint name, GLenum target );
  73
  74 extern int
  75 _mesa_tex_target_to_index(const struct gl_context *ctx, GLenum target);
  76
  77 extern void
  78 _mesa_delete_texture_object( struct gl_context *ctx,
  79                              struct gl_texture_object *obj );
  80
  81 extern void
  82 _mesa_copy_texture_object( struct gl_texture_object *dest,
  83                            const struct gl_texture_object *src );
  84
  85 extern void
  86 _mesa_clear_texture_object(struct gl_context *ctx,
  87                            struct gl_texture_object *obj);
  88
  89 extern void
  90 _mesa_reference_texobj_(struct gl_texture_object **ptr,
  91                         struct gl_texture_object *tex);
  92
  93 static inline void
  94 _mesa_reference_texobj(struct gl_texture_object **ptr,
  95                        struct gl_texture_object *tex)
  96 {
  97    if (*ptr != tex)
  98       _mesa_reference_texobj_(ptr, tex);
  99 }
 100
 101 /**
 102  * Lock a texture for updating.  See also _mesa_lock_context_textures().
 103  */
 104 static inline void
 105 _mesa_lock_texture(struct gl_context *ctx, struct gl_texture_object *texObj)
 106 {
 107    mtx_lock(&ctx->Shared->TexMutex);
 108    ctx->Shared->TextureStateStamp++;
 109    (void) texObj;
 110 }
 111
 112 static inline void
 113 _mesa_unlock_texture(struct gl_context *ctx, struct gl_texture_object *texObj)
 114 {
 115    (void) texObj;
 116    mtx_unlock(&ctx->Shared->TexMutex);
 117 }
 118
 119
 120 /**
 121  * Return number of faces for a texture target.  This will be 6 for
 122  * cube maps (and cube map arrays) and 1 otherwise.
 123  * NOTE: this function is not used for cube map arrays which operate
 124  * more like 2D arrays than cube maps.
 125  */
 126 static inline GLuint
 127 _mesa_num_tex_faces(GLenum target)
 128 {
 129    switch (target) {
 130    case GL_TEXTURE_CUBE_MAP:
 131    case GL_PROXY_TEXTURE_CUBE_MAP:
 132       return 6;
 133    default:
 134       return 1;
 135    }
 136 }
 137
 138
 139 /** Is the texture "complete" with respect to the given sampler state? */
 140 static inline GLboolean
 141 _mesa_is_texture_complete(const struct gl_texture_object *texObj,
 142                           const struct gl_sampler_object *sampler)
 143 {
 144    if (texObj->_IsIntegerFormat &&
 145        (sampler->MagFilter != GL_NEAREST ||
 146         (sampler->MinFilter != GL_NEAREST &&
 147          sampler->MinFilter != GL_NEAREST_MIPMAP_NEAREST))) {
 148       /* If the format is integer, only nearest filtering is allowed */
 149       return GL_FALSE;
 150    }
 151
 152    /* From the ARB_stencil_texturing specification:
 153     * "Add a new bullet point for the conditions that cause the texture
 154     *  to not be complete:
 155     *
 156     *  * The internal format of the texture is DEPTH_STENCIL, the
 157     *    DEPTH_STENCIL_TEXTURE_MODE for the texture is STENCIL_INDEX and either
 158     *    the magnification filter or the minification filter is not NEAREST."
 159     */
 160    if (texObj->StencilSampling &&
 161        texObj->Image[0][texObj->BaseLevel]->_BaseFormat == GL_DEPTH_STENCIL &&
 162        (sampler->MagFilter != GL_NEAREST || sampler->MinFilter != GL_NEAREST)) {
 163       return GL_FALSE;
 164    }
 165
 166    if (_mesa_is_mipmap_filter(sampler))
 167       return texObj->_MipmapComplete;
 168    else
 169       return texObj->_BaseComplete;
 170 }
 171
 172
 173 extern void
 174 _mesa_test_texobj_completeness( const struct gl_context *ctx,
 175                                 struct gl_texture_object *obj );
 176
 177 extern GLboolean
 178 _mesa_cube_complete(const struct gl_texture_object *texObj);
 179
 180 extern void
 181 _mesa_dirty_texobj(struct gl_context *ctx, struct gl_texture_object *texObj);
 182
 183 extern struct gl_texture_object *
 184 _mesa_get_fallback_texture(struct gl_context *ctx, gl_texture_index tex);
 185
 186 extern GLuint
 187 _mesa_total_texture_memory(struct gl_context *ctx);
 188
 189 extern GLenum
 190 _mesa_texture_base_format(const struct gl_texture_object *texObj);
 191
 192 extern void
 193 _mesa_unlock_context_textures( struct gl_context *ctx );
 194
 195 extern void
 196 _mesa_lock_context_textures( struct gl_context *ctx );
 197
 198 /*@}*/
 199
 200 /**
 201  * \name API functions
 202  */
 203 /*@{*/
 204
 205 extern void GLAPIENTRY
 206 _mesa_GenTextures( GLsizei n, GLuint *textures );
 207
 208
 209 extern void GLAPIENTRY
 210 _mesa_DeleteTextures( GLsizei n, const GLuint *textures );
 211
 212
 213 extern void GLAPIENTRY
 214 _mesa_BindTexture( GLenum target, GLuint texture );
 215
 216
 217 extern void GLAPIENTRY
 218 _mesa_BindTextures( GLuint first, GLsizei count, const GLuint *textures );
 219
 220
 221 extern void GLAPIENTRY
 222 _mesa_PrioritizeTextures( GLsizei n, const GLuint *textures,
 223                           const GLclampf *priorities );
 224
 225
 226 extern GLboolean GLAPIENTRY
 227 _mesa_AreTexturesResident( GLsizei n, const GLuint *textures,
 228                            GLboolean *residences );
 229
 230 extern GLboolean GLAPIENTRY
 231 _mesa_IsTexture( GLuint texture );
 232
 233 extern void GLAPIENTRY
 234 _mesa_InvalidateTexSubImage(GLuint texture, GLint level, GLint xoffset,
 235                             GLint yoffset, GLint zoffset, GLsizei width,
 236                             GLsizei height, GLsizei depth);
 237
 238 extern void GLAPIENTRY
 239 _mesa_InvalidateTexImage(GLuint texture, GLint level);
 240
 241 /*@}*/
 242
 243
 244 #ifdef __cplusplus
 245 }
 246 #endif
 247
 248
 249 #endif