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