src/mesa/main/teximage.h

   1 /**
   2  * \file teximage.h
   3  * Texture images manipulation functions.
   4  */
   5
   6 /*
   7  * Mesa 3-D graphics library
   8  *
   9  * Copyright (C) 1999-2005  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 TEXIMAGE_H
  32 #define TEXIMAGE_H
  33
  34
  35 #include "mtypes.h"
  36 #include "formats.h"
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /** Is the given value one of the 6 cube faces? */
  43 static inline GLboolean
  44 _mesa_is_cube_face(GLenum target)
  45 {
  46    return (target >= GL_TEXTURE_CUBE_MAP_POSITIVE_X &&
  47            target <= GL_TEXTURE_CUBE_MAP_NEGATIVE_Z);
  48 }
  49
  50
  51 /**
  52  * For cube map faces, return a face index in [0,5].
  53  * For other targets return 0;
  54  */
  55 static inline GLuint
  56 _mesa_tex_target_to_face(GLenum target)
  57 {
  58    if (_mesa_is_cube_face(target))
  59       return (GLuint) target - (GLuint) GL_TEXTURE_CUBE_MAP_POSITIVE_X;
  60    else
  61       return 0;
  62 }
  63
  64
  65 /** Are any of the dimensions of given texture equal to zero? */
  66 static inline GLboolean
  67 _mesa_is_zero_size_texture(const struct gl_texture_image *texImage)
  68 {
  69    return (texImage->Width == 0 ||
  70            texImage->Height == 0 ||
  71            texImage->Depth == 0);
  72 }
  73
  74 /** \name Internal functions */
  75 /*@{*/
  76
  77 extern GLboolean
  78 _mesa_is_proxy_texture(GLenum target);
  79
  80 extern bool
  81 _mesa_is_array_texture(GLenum target);
  82
  83 extern struct gl_texture_image *
  84 _mesa_new_texture_image( struct gl_context *ctx );
  85
  86
  87 extern void
  88 _mesa_delete_texture_image( struct gl_context *ctx,
  89                             struct gl_texture_image *teximage );
  90
  91
  92 extern void
  93 _mesa_init_teximage_fields(struct gl_context *ctx,
  94                            struct gl_texture_image *img,
  95                            GLsizei width, GLsizei height, GLsizei depth,
  96                            GLint border, GLenum internalFormat,
  97                            mesa_format format);
  98
  99
 100 extern mesa_format
 101 _mesa_choose_texture_format(struct gl_context *ctx,
 102                             struct gl_texture_object *texObj,
 103                             GLenum target, GLint level,
 104                             GLenum internalFormat, GLenum format, GLenum type);
 105
 106 extern void
 107 _mesa_update_fbo_texture(struct gl_context *ctx,
 108                          struct gl_texture_object *texObj,
 109                          GLuint face, GLuint level);
 110
 111 extern void
 112 _mesa_clear_texture_image(struct gl_context *ctx,
 113                           struct gl_texture_image *texImage);
 114
 115
 116 extern struct gl_texture_image *
 117 _mesa_select_tex_image(const struct gl_texture_object *texObj,
 118                        GLenum target, GLint level);
 119
 120
 121 extern struct gl_texture_image *
 122 _mesa_get_tex_image(struct gl_context *ctx, struct gl_texture_object *texObj,
 123                     GLenum target, GLint level);
 124
 125
 126 /**
 127  * Return the base-level texture image for the given texture object.
 128  */
 129 static inline const struct gl_texture_image *
 130 _mesa_base_tex_image(const struct gl_texture_object *texObj)
 131 {
 132    return texObj->Image[0][texObj->BaseLevel];
 133 }
 134
 135
 136 extern GLint
 137 _mesa_max_texture_levels(struct gl_context *ctx, GLenum target);
 138
 139
 140 extern GLboolean
 141 _mesa_test_proxy_teximage(struct gl_context *ctx, GLenum target, GLint level,
 142                           mesa_format format,
 143                           GLint width, GLint height, GLint depth, GLint border);
 144
 145 extern GLboolean
 146 _mesa_target_can_be_compressed(const struct gl_context *ctx, GLenum target,
 147                                GLenum intFormat, GLenum *error);
 148
 149 extern GLint
 150 _mesa_get_texture_dimensions(GLenum target);
 151
 152 extern GLboolean
 153 _mesa_tex_target_is_layered(GLenum target);
 154
 155 extern GLuint
 156 _mesa_get_texture_layers(const struct gl_texture_object *texObj, GLint level);
 157
 158 extern GLsizei
 159 _mesa_get_tex_max_num_levels(GLenum target, GLsizei width, GLsizei height,
 160                              GLsizei depth);
 161
 162 extern GLboolean
 163 _mesa_legal_texture_dimensions(struct gl_context *ctx, GLenum target,
 164                                GLint level, GLint width, GLint height,
 165                                GLint depth, GLint border);
 166
 167 extern mesa_format
 168 _mesa_validate_texbuffer_format(const struct gl_context *ctx,
 169                                 GLenum internalFormat);
 170
 171
 172 bool
 173 _mesa_legal_texture_base_format_for_target(struct gl_context *ctx,
 174                                            GLenum target,
 175                                            GLenum internalFormat,
 176                                            unsigned dimensions,
 177                                            const char *caller);
 178
 179 extern void
 180 _mesa_texture_sub_image(struct gl_context *ctx, GLuint dims,
 181                         struct gl_texture_object *texObj,
 182                         struct gl_texture_image *texImage,
 183                         GLenum target, GLint level,
 184                         GLint xoffset, GLint yoffset, GLint zoffset,
 185                         GLsizei width, GLsizei height, GLsizei depth,
 186                         GLenum format, GLenum type, const GLvoid *pixels,
 187                         bool dsa);
 188
 189 extern void
 190 _mesa_compressed_texture_sub_image(struct gl_context *ctx, GLuint dims,
 191                                    struct gl_texture_object *texObj,
 192                                    struct gl_texture_image *texImage,
 193                                    GLenum target, GLint level,
 194                                    GLint xoffset, GLint yoffset,
 195                                    GLint zoffset,
 196                                    GLsizei width, GLsizei height,
 197                                    GLsizei depth,
 198                                    GLenum format, GLsizei imageSize,
 199                                    const GLvoid *data);
 200
 201 extern void
 202 _mesa_copy_texture_sub_image(struct gl_context *ctx, GLuint dims,
 203                              struct gl_texture_object *texObj,
 204                              GLenum target, GLint level,
 205                              GLint xoffset, GLint yoffset, GLint zoffset,
 206                              GLint x, GLint y,
 207                              GLsizei width, GLsizei height,
 208                              const char *caller);
 209
 210 extern void
 211 _mesa_texture_buffer_range(struct gl_context *ctx,
 212                            struct gl_texture_object *texObj,
 213                            GLenum internalFormat,
 214                            struct gl_buffer_object *bufObj,
 215                            GLintptr offset, GLsizeiptr size,
 216                            const char *caller);
 217 /*@}*/
 218
 219
 220 /** \name API entry point functions */
 221 /*@{*/
 222
 223 extern void GLAPIENTRY
 224 _mesa_TexImage1D( GLenum target, GLint level, GLint internalformat,
 225                   GLsizei width, GLint border,
 226                   GLenum format, GLenum type, const GLvoid *pixels );
 227
 228
 229 extern void GLAPIENTRY
 230 _mesa_TexImage2D( GLenum target, GLint level, GLint internalformat,
 231                   GLsizei width, GLsizei height, GLint border,
 232                   GLenum format, GLenum type, const GLvoid *pixels );
 233
 234
 235 extern void GLAPIENTRY
 236 _mesa_TexImage3D( GLenum target, GLint level, GLint internalformat,
 237                   GLsizei width, GLsizei height, GLsizei depth, GLint border,
 238                   GLenum format, GLenum type, const GLvoid *pixels );
 239
 240
 241 extern void GLAPIENTRY
 242 _mesa_TexImage3DEXT( GLenum target, GLint level, GLenum internalformat,
 243                      GLsizei width, GLsizei height, GLsizei depth,
 244                      GLint border, GLenum format, GLenum type,
 245                      const GLvoid *pixels );
 246
 247 extern void GLAPIENTRY
 248 _mesa_EGLImageTargetTexture2DOES( GLenum target, GLeglImageOES image );
 249
 250 extern void GLAPIENTRY
 251 _mesa_TexSubImage1D( GLenum target, GLint level, GLint xoffset,
 252                      GLsizei width,
 253                      GLenum format, GLenum type,
 254                      const GLvoid *pixels );
 255
 256
 257 extern void GLAPIENTRY
 258 _mesa_TexSubImage2D( GLenum target, GLint level,
 259                      GLint xoffset, GLint yoffset,
 260                      GLsizei width, GLsizei height,
 261                      GLenum format, GLenum type,
 262                      const GLvoid *pixels );
 263
 264
 265 extern void GLAPIENTRY
 266 _mesa_TexSubImage3D( GLenum target, GLint level,
 267                      GLint xoffset, GLint yoffset, GLint zoffset,
 268                      GLsizei width, GLsizei height, GLsizei depth,
 269                      GLenum format, GLenum type,
 270                      const GLvoid *pixels );
 271
 272 extern void GLAPIENTRY
 273 _mesa_TextureSubImage1D(GLuint texture, GLint level, GLint xoffset,
 274                         GLsizei width,
 275                         GLenum format, GLenum type,
 276                         const GLvoid *pixels);
 277
 278
 279 extern void GLAPIENTRY
 280 _mesa_TextureSubImage2D(GLuint texture, GLint level,
 281                         GLint xoffset, GLint yoffset,
 282                         GLsizei width, GLsizei height,
 283                         GLenum format, GLenum type,
 284                         const GLvoid *pixels);
 285
 286 extern void GLAPIENTRY
 287 _mesa_TextureSubImage3D(GLuint texture, GLint level,
 288                         GLint xoffset, GLint yoffset, GLint zoffset,
 289                         GLsizei width, GLsizei height, GLsizei depth,
 290                         GLenum format, GLenum type,
 291                         const GLvoid *pixels);
 292
 293
 294 extern void GLAPIENTRY
 295 _mesa_CopyTexImage1D(GLenum target, GLint level, GLenum internalformat,
 296                      GLint x, GLint y, GLsizei width, GLint border);
 297
 298
 299 extern void GLAPIENTRY
 300 _mesa_CopyTexImage2D( GLenum target, GLint level,
 301                       GLenum internalformat, GLint x, GLint y,
 302                       GLsizei width, GLsizei height, GLint border );
 303
 304
 305 extern void GLAPIENTRY
 306 _mesa_CopyTexSubImage1D( GLenum target, GLint level, GLint xoffset,
 307                          GLint x, GLint y, GLsizei width );
 308
 309
 310 extern void GLAPIENTRY
 311 _mesa_CopyTexSubImage2D( GLenum target, GLint level,
 312                          GLint xoffset, GLint yoffset,
 313                          GLint x, GLint y, GLsizei width, GLsizei height );
 314
 315
 316 extern void GLAPIENTRY
 317 _mesa_CopyTexSubImage3D( GLenum target, GLint level,
 318                          GLint xoffset, GLint yoffset, GLint zoffset,
 319                          GLint x, GLint y, GLsizei width, GLsizei height );
 320
 321 extern void GLAPIENTRY
 322 _mesa_CopyTextureSubImage1D(GLuint texture, GLint level,
 323                             GLint xoffset, GLint x, GLint y, GLsizei width);
 324
 325 extern void GLAPIENTRY
 326 _mesa_CopyTextureSubImage2D(GLuint texture, GLint level,
 327                             GLint xoffset, GLint yoffset,
 328                             GLint x, GLint y,
 329                             GLsizei width, GLsizei height);
 330
 331 extern void GLAPIENTRY
 332 _mesa_CopyTextureSubImage3D(GLuint texture, GLint level,
 333                             GLint xoffset, GLint yoffset, GLint zoffset,
 334                             GLint x, GLint y,
 335                             GLsizei width, GLsizei height);
 336
 337 extern void GLAPIENTRY
 338 _mesa_ClearTexSubImage( GLuint texture, GLint level,
 339                         GLint xoffset, GLint yoffset, GLint zoffset,
 340                         GLsizei width, GLsizei height, GLsizei depth,
 341                         GLenum format, GLenum type, const void *data );
 342
 343 extern void GLAPIENTRY
 344 _mesa_ClearTexImage( GLuint texture, GLint level,
 345                      GLenum format, GLenum type, const void *data );
 346
 347 extern void GLAPIENTRY
 348 _mesa_CompressedTexImage1D(GLenum target, GLint level,
 349                               GLenum internalformat, GLsizei width,
 350                               GLint border, GLsizei imageSize,
 351                               const GLvoid *data);
 352
 353 extern void GLAPIENTRY
 354 _mesa_CompressedTexImage2D(GLenum target, GLint level,
 355                               GLenum internalformat, GLsizei width,
 356                               GLsizei height, GLint border, GLsizei imageSize,
 357                               const GLvoid *data);
 358
 359 extern void GLAPIENTRY
 360 _mesa_CompressedTexImage3D(GLenum target, GLint level,
 361                               GLenum internalformat, GLsizei width,
 362                               GLsizei height, GLsizei depth, GLint border,
 363                               GLsizei imageSize, const GLvoid *data);
 364
 365 extern void GLAPIENTRY
 366 _mesa_CompressedTexSubImage1D(GLenum target, GLint level, GLint xoffset,
 367                                  GLsizei width, GLenum format,
 368                                  GLsizei imageSize, const GLvoid *data);
 369
 370 extern void GLAPIENTRY
 371 _mesa_CompressedTextureSubImage1D(GLuint texture, GLint level, GLint xoffset,
 372                                   GLsizei width, GLenum format,
 373                                   GLsizei imageSize, const GLvoid *data);
 374
 375 extern void GLAPIENTRY
 376 _mesa_CompressedTexSubImage2D(GLenum target, GLint level, GLint xoffset,
 377                                  GLint yoffset, GLsizei width, GLsizei height,
 378                                  GLenum format, GLsizei imageSize,
 379                                  const GLvoid *data);
 380
 381 extern void GLAPIENTRY
 382 _mesa_CompressedTextureSubImage2D(GLuint texture, GLint level, GLint xoffset,
 383                                   GLint yoffset,
 384                                   GLsizei width, GLsizei height,
 385                                   GLenum format, GLsizei imageSize,
 386                                   const GLvoid *data);
 387
 388 extern void GLAPIENTRY
 389 _mesa_CompressedTexSubImage3D(GLenum target, GLint level, GLint xoffset,
 390                                  GLint yoffset, GLint zoffset, GLsizei width,
 391                                  GLsizei height, GLsizei depth, GLenum format,
 392                                  GLsizei imageSize, const GLvoid *data);
 393
 394 extern void GLAPIENTRY
 395 _mesa_CompressedTextureSubImage3D(GLuint texture, GLint level, GLint xoffset,
 396                                   GLint yoffset, GLint zoffset,
 397                                   GLsizei width, GLsizei height,
 398                                   GLsizei depth,
 399                                   GLenum format, GLsizei imageSize,
 400                                   const GLvoid *data);
 401
 402 extern void GLAPIENTRY
 403 _mesa_TexBuffer(GLenum target, GLenum internalFormat, GLuint buffer);
 404
 405 extern void GLAPIENTRY
 406 _mesa_TexBufferRange(GLenum target, GLenum internalFormat, GLuint buffer,
 407                      GLintptr offset, GLsizeiptr size);
 408
 409 extern void GLAPIENTRY
 410 _mesa_TextureBuffer(GLuint texture, GLenum internalFormat, GLuint buffer);
 411
 412 extern void GLAPIENTRY
 413 _mesa_TextureBufferRange(GLuint texture, GLenum internalFormat, GLuint buffer,
 414                          GLintptr offset, GLsizeiptr size);
 415
 416
 417 extern void GLAPIENTRY
 418 _mesa_TexImage2DMultisample(GLenum target, GLsizei samples,
 419                             GLenum internalformat, GLsizei width,
 420                             GLsizei height, GLboolean fixedsamplelocations);
 421
 422 extern void GLAPIENTRY
 423 _mesa_TexImage3DMultisample(GLenum target, GLsizei samples,
 424                             GLenum internalformat, GLsizei width,
 425                             GLsizei height, GLsizei depth,
 426                             GLboolean fixedsamplelocations);
 427
 428 extern void GLAPIENTRY
 429 _mesa_TexStorage2DMultisample(GLenum target, GLsizei samples,
 430                               GLenum internalformat, GLsizei width,
 431                               GLsizei height, GLboolean fixedsamplelocations);
 432
 433 extern void GLAPIENTRY
 434 _mesa_TexStorage3DMultisample(GLenum target, GLsizei samples,
 435                               GLenum internalformat, GLsizei width,
 436                               GLsizei height, GLsizei depth,
 437                               GLboolean fixedsamplelocations);
 438
 439 void GLAPIENTRY
 440 _mesa_TextureStorage2DMultisample(GLuint texture, GLsizei samples,
 441                                   GLenum internalformat, GLsizei width,
 442                                   GLsizei height,
 443                                   GLboolean fixedsamplelocations);
 444
 445 void GLAPIENTRY
 446 _mesa_TextureStorage3DMultisample(GLuint texture, GLsizei samples,
 447                                   GLenum internalformat, GLsizei width,
 448                                   GLsizei height, GLsizei depth,
 449                                   GLboolean fixedsamplelocations);
 450 /*@}*/
 451
 452 #ifdef __cplusplus
 453 }
 454 #endif
 455
 456 #endif