3 * Texture images manipulation functions.
7 * Mesa 3-D graphics library
9 * Copyright (C) 1999-2005 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.
42 /** Is the given value one of the 6 cube faces? */
43 static inline GLboolean
44 _mesa_is_cube_face(GLenum target
)
46 return (target
>= GL_TEXTURE_CUBE_MAP_POSITIVE_X
&&
47 target
<= GL_TEXTURE_CUBE_MAP_NEGATIVE_Z
);
52 * Return number of faces for a texture target. This will be 6 for
53 * cube maps and 1 otherwise.
54 * NOTE: this function is not used for cube map arrays which operate
55 * more like 2D arrays than cube maps.
58 _mesa_num_tex_faces(GLenum target
)
61 case GL_TEXTURE_CUBE_MAP
:
62 case GL_PROXY_TEXTURE_CUBE_MAP
:
71 * If the target is GL_TEXTURE_CUBE_MAP, return one of the
72 * GL_TEXTURE_CUBE_MAP_POSITIVE/NEGATIVE_X/Y/Z targets corresponding to
74 * Else, return target as-is.
77 _mesa_cube_face_target(GLenum target
, unsigned face
)
79 if (target
== GL_TEXTURE_CUBE_MAP
) {
81 return GL_TEXTURE_CUBE_MAP_POSITIVE_X
+ face
;
90 * For cube map faces, return a face index in [0,5].
91 * For other targets return 0;
94 _mesa_tex_target_to_face(GLenum target
)
96 if (_mesa_is_cube_face(target
))
97 return (GLuint
) target
- (GLuint
) GL_TEXTURE_CUBE_MAP_POSITIVE_X
;
103 /** Are any of the dimensions of given texture equal to zero? */
104 static inline GLboolean
105 _mesa_is_zero_size_texture(const struct gl_texture_image
*texImage
)
107 return (texImage
->Width
== 0 ||
108 texImage
->Height
== 0 ||
109 texImage
->Depth
== 0);
112 /** \name Internal functions */
116 _mesa_is_proxy_texture(GLenum target
);
119 _mesa_is_array_texture(GLenum target
);
123 _mesa_delete_texture_image( struct gl_context
*ctx
,
124 struct gl_texture_image
*teximage
);
128 _mesa_init_teximage_fields(struct gl_context
*ctx
,
129 struct gl_texture_image
*img
,
130 GLsizei width
, GLsizei height
, GLsizei depth
,
131 GLint border
, GLenum internalFormat
,
136 _mesa_choose_texture_format(struct gl_context
*ctx
,
137 struct gl_texture_object
*texObj
,
138 GLenum target
, GLint level
,
139 GLenum internalFormat
, GLenum format
, GLenum type
);
142 _mesa_update_fbo_texture(struct gl_context
*ctx
,
143 struct gl_texture_object
*texObj
,
144 GLuint face
, GLuint level
);
147 _mesa_clear_texture_image(struct gl_context
*ctx
,
148 struct gl_texture_image
*texImage
);
151 extern struct gl_texture_image
*
152 _mesa_select_tex_image(const struct gl_texture_object
*texObj
,
153 GLenum target
, GLint level
);
156 extern struct gl_texture_image
*
157 _mesa_get_tex_image(struct gl_context
*ctx
, struct gl_texture_object
*texObj
,
158 GLenum target
, GLint level
);
161 _mesa_get_texbuffer_format(const struct gl_context
*ctx
, GLenum internalFormat
);
164 * Return the base-level texture image for the given texture object.
166 static inline const struct gl_texture_image
*
167 _mesa_base_tex_image(const struct gl_texture_object
*texObj
)
169 return texObj
->Image
[0][texObj
->BaseLevel
];
174 _mesa_max_texture_levels(struct gl_context
*ctx
, GLenum target
);
178 _mesa_test_proxy_teximage(struct gl_context
*ctx
, GLenum target
,
179 GLuint numLevels
, GLint level
,
180 mesa_format format
, GLuint numSamples
,
181 GLint width
, GLint height
, GLint depth
);
184 _mesa_target_can_be_compressed(const struct gl_context
*ctx
, GLenum target
,
185 GLenum intFormat
, GLenum
*error
);
188 _mesa_get_texture_dimensions(GLenum target
);
191 _mesa_tex_target_is_layered(GLenum target
);
194 _mesa_get_texture_layers(const struct gl_texture_object
*texObj
, GLint level
);
197 _mesa_get_tex_max_num_levels(GLenum target
, GLsizei width
, GLsizei height
,
201 _mesa_legal_texture_dimensions(struct gl_context
*ctx
, GLenum target
,
202 GLint level
, GLint width
, GLint height
,
203 GLint depth
, GLint border
);
206 _mesa_validate_texbuffer_format(const struct gl_context
*ctx
,
207 GLenum internalFormat
);
211 _mesa_legal_texture_base_format_for_target(struct gl_context
*ctx
,
213 GLenum internalFormat
);
216 _mesa_format_no_online_compression(const struct gl_context
*ctx
, GLenum format
);
219 _mesa_is_renderable_texture_format(struct gl_context
*ctx
, GLenum internalformat
);
222 _mesa_texture_sub_image(struct gl_context
*ctx
, GLuint dims
,
223 struct gl_texture_object
*texObj
,
224 struct gl_texture_image
*texImage
,
225 GLenum target
, GLint level
,
226 GLint xoffset
, GLint yoffset
, GLint zoffset
,
227 GLsizei width
, GLsizei height
, GLsizei depth
,
228 GLenum format
, GLenum type
, const GLvoid
*pixels
,
232 _mesa_texture_storage_ms_memory(struct gl_context
*ctx
, GLuint dims
,
233 struct gl_texture_object
*texObj
,
234 struct gl_memory_object
*memObj
,
235 GLenum target
, GLsizei samples
,
236 GLenum internalFormat
, GLsizei width
,
237 GLsizei height
, GLsizei depth
,
238 GLboolean fixedSampleLocations
,
239 GLuint64 offset
, const char* func
);
242 _mesa_is_cube_map_texture(GLenum target
);
247 /** \name API entry point functions */
250 extern void GLAPIENTRY
251 _mesa_TexImage1D( GLenum target
, GLint level
, GLint internalformat
,
252 GLsizei width
, GLint border
,
253 GLenum format
, GLenum type
, const GLvoid
*pixels
);
256 extern void GLAPIENTRY
257 _mesa_TexImage2D( GLenum target
, GLint level
, GLint internalformat
,
258 GLsizei width
, GLsizei height
, GLint border
,
259 GLenum format
, GLenum type
, const GLvoid
*pixels
);
262 extern void GLAPIENTRY
263 _mesa_TexImage3D( GLenum target
, GLint level
, GLint internalformat
,
264 GLsizei width
, GLsizei height
, GLsizei depth
, GLint border
,
265 GLenum format
, GLenum type
, const GLvoid
*pixels
);
268 extern void GLAPIENTRY
269 _mesa_TexImage3DEXT( GLenum target
, GLint level
, GLenum internalformat
,
270 GLsizei width
, GLsizei height
, GLsizei depth
,
271 GLint border
, GLenum format
, GLenum type
,
272 const GLvoid
*pixels
);
274 extern void GLAPIENTRY
275 _mesa_TexImage1D_no_error(GLenum target
, GLint level
, GLint internalformat
,
276 GLsizei width
, GLint border
,
277 GLenum format
, GLenum type
, const GLvoid
*pixels
);
279 extern void GLAPIENTRY
280 _mesa_TexImage2D_no_error(GLenum target
, GLint level
, GLint internalformat
,
281 GLsizei width
, GLsizei height
, GLint border
,
282 GLenum format
, GLenum type
, const GLvoid
*pixels
);
284 extern void GLAPIENTRY
285 _mesa_TexImage3D_no_error(GLenum target
, GLint level
, GLint internalformat
,
286 GLsizei width
, GLsizei height
, GLsizei depth
,
287 GLint border
, GLenum format
, GLenum type
,
288 const GLvoid
*pixels
);
290 extern void GLAPIENTRY
291 _mesa_EGLImageTargetTexture2DOES( GLenum target
, GLeglImageOES image
);
294 _mesa_TexSubImage1D_no_error(GLenum target
, GLint level
, GLint xoffset
,
296 GLenum format
, GLenum type
,
297 const GLvoid
*pixels
);
299 extern void GLAPIENTRY
300 _mesa_TexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
302 GLenum format
, GLenum type
,
303 const GLvoid
*pixels
);
306 _mesa_TexSubImage2D_no_error(GLenum target
, GLint level
,
307 GLint xoffset
, GLint yoffset
,
308 GLsizei width
, GLsizei height
,
309 GLenum format
, GLenum type
,
310 const GLvoid
*pixels
);
312 extern void GLAPIENTRY
313 _mesa_TexSubImage2D( GLenum target
, GLint level
,
314 GLint xoffset
, GLint yoffset
,
315 GLsizei width
, GLsizei height
,
316 GLenum format
, GLenum type
,
317 const GLvoid
*pixels
);
320 _mesa_TexSubImage3D_no_error(GLenum target
, GLint level
,
321 GLint xoffset
, GLint yoffset
, GLint zoffset
,
322 GLsizei width
, GLsizei height
, GLsizei depth
,
323 GLenum format
, GLenum type
,
324 const GLvoid
*pixels
);
326 extern void GLAPIENTRY
327 _mesa_TexSubImage3D( GLenum target
, GLint level
,
328 GLint xoffset
, GLint yoffset
, GLint zoffset
,
329 GLsizei width
, GLsizei height
, GLsizei depth
,
330 GLenum format
, GLenum type
,
331 const GLvoid
*pixels
);
334 _mesa_TextureSubImage1D_no_error(GLuint texture
, GLint level
, GLint xoffset
,
335 GLsizei width
, GLenum format
, GLenum type
,
336 const GLvoid
*pixels
);
338 extern void GLAPIENTRY
339 _mesa_TextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
341 GLenum format
, GLenum type
,
342 const GLvoid
*pixels
);
345 _mesa_TextureSubImage2D_no_error(GLuint texture
, GLint level
, GLint xoffset
,
346 GLint yoffset
, GLsizei width
, GLsizei height
,
347 GLenum format
, GLenum type
,
348 const GLvoid
*pixels
);
350 extern void GLAPIENTRY
351 _mesa_TextureSubImage2D(GLuint texture
, GLint level
,
352 GLint xoffset
, GLint yoffset
,
353 GLsizei width
, GLsizei height
,
354 GLenum format
, GLenum type
,
355 const GLvoid
*pixels
);
358 _mesa_TextureSubImage3D_no_error(GLuint texture
, GLint level
, GLint xoffset
,
359 GLint yoffset
, GLint zoffset
, GLsizei width
,
360 GLsizei height
, GLsizei depth
, GLenum format
,
361 GLenum type
, const GLvoid
*pixels
);
363 extern void GLAPIENTRY
364 _mesa_TextureSubImage3D(GLuint texture
, GLint level
,
365 GLint xoffset
, GLint yoffset
, GLint zoffset
,
366 GLsizei width
, GLsizei height
, GLsizei depth
,
367 GLenum format
, GLenum type
,
368 const GLvoid
*pixels
);
371 extern void GLAPIENTRY
372 _mesa_CopyTexImage1D(GLenum target
, GLint level
, GLenum internalformat
,
373 GLint x
, GLint y
, GLsizei width
, GLint border
);
376 extern void GLAPIENTRY
377 _mesa_CopyTexImage2D( GLenum target
, GLint level
,
378 GLenum internalformat
, GLint x
, GLint y
,
379 GLsizei width
, GLsizei height
, GLint border
);
382 extern void GLAPIENTRY
383 _mesa_CopyTexImage1D_no_error(GLenum target
, GLint level
, GLenum internalformat
,
384 GLint x
, GLint y
, GLsizei width
, GLint border
);
387 extern void GLAPIENTRY
388 _mesa_CopyTexImage2D_no_error(GLenum target
, GLint level
, GLenum internalformat
,
389 GLint x
, GLint y
, GLsizei width
, GLsizei height
,
393 extern void GLAPIENTRY
394 _mesa_CopyTexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
395 GLint x
, GLint y
, GLsizei width
);
398 extern void GLAPIENTRY
399 _mesa_CopyTexSubImage2D( GLenum target
, GLint level
,
400 GLint xoffset
, GLint yoffset
,
401 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
404 extern void GLAPIENTRY
405 _mesa_CopyTexSubImage3D( GLenum target
, GLint level
,
406 GLint xoffset
, GLint yoffset
, GLint zoffset
,
407 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
409 extern void GLAPIENTRY
410 _mesa_CopyTextureSubImage1D(GLuint texture
, GLint level
,
411 GLint xoffset
, GLint x
, GLint y
, GLsizei width
);
413 extern void GLAPIENTRY
414 _mesa_CopyTextureSubImage2D(GLuint texture
, GLint level
,
415 GLint xoffset
, GLint yoffset
,
417 GLsizei width
, GLsizei height
);
419 extern void GLAPIENTRY
420 _mesa_CopyTextureSubImage3D(GLuint texture
, GLint level
,
421 GLint xoffset
, GLint yoffset
, GLint zoffset
,
423 GLsizei width
, GLsizei height
);
425 extern void GLAPIENTRY
426 _mesa_CopyTexSubImage1D_no_error(GLenum target
, GLint level
, GLint xoffset
,
427 GLint x
, GLint y
, GLsizei width
);
429 extern void GLAPIENTRY
430 _mesa_CopyTexSubImage2D_no_error(GLenum target
, GLint level
, GLint xoffset
,
431 GLint yoffset
, GLint x
, GLint y
, GLsizei width
,
434 extern void GLAPIENTRY
435 _mesa_CopyTexSubImage3D_no_error(GLenum target
, GLint level
, GLint xoffset
,
436 GLint yoffset
, GLint zoffset
, GLint x
, GLint y
,
437 GLsizei width
, GLsizei height
);
439 extern void GLAPIENTRY
440 _mesa_CopyTextureSubImage1D_no_error(GLuint texture
, GLint level
, GLint xoffset
,
441 GLint x
, GLint y
, GLsizei width
);
443 extern void GLAPIENTRY
444 _mesa_CopyTextureSubImage2D_no_error(GLuint texture
, GLint level
, GLint xoffset
,
445 GLint yoffset
, GLint x
, GLint y
,
446 GLsizei width
, GLsizei height
);
448 extern void GLAPIENTRY
449 _mesa_CopyTextureSubImage3D_no_error(GLuint texture
, GLint level
, GLint xoffset
,
450 GLint yoffset
, GLint zoffset
, GLint x
,
451 GLint y
, GLsizei width
, GLsizei height
);
453 extern void GLAPIENTRY
454 _mesa_ClearTexSubImage( GLuint texture
, GLint level
,
455 GLint xoffset
, GLint yoffset
, GLint zoffset
,
456 GLsizei width
, GLsizei height
, GLsizei depth
,
457 GLenum format
, GLenum type
, const void *data
);
459 extern void GLAPIENTRY
460 _mesa_ClearTexImage( GLuint texture
, GLint level
,
461 GLenum format
, GLenum type
, const void *data
);
463 extern void GLAPIENTRY
464 _mesa_CompressedTexImage1D(GLenum target
, GLint level
,
465 GLenum internalformat
, GLsizei width
,
466 GLint border
, GLsizei imageSize
,
469 extern void GLAPIENTRY
470 _mesa_CompressedTexImage2D(GLenum target
, GLint level
,
471 GLenum internalformat
, GLsizei width
,
472 GLsizei height
, GLint border
, GLsizei imageSize
,
475 extern void GLAPIENTRY
476 _mesa_CompressedTexImage3D(GLenum target
, GLint level
,
477 GLenum internalformat
, GLsizei width
,
478 GLsizei height
, GLsizei depth
, GLint border
,
479 GLsizei imageSize
, const GLvoid
*data
);
481 extern void GLAPIENTRY
482 _mesa_CompressedTexImage1D_no_error(GLenum target
, GLint level
,
483 GLenum internalformat
, GLsizei width
,
484 GLint border
, GLsizei imageSize
,
487 extern void GLAPIENTRY
488 _mesa_CompressedTexImage2D_no_error(GLenum target
, GLint level
,
489 GLenum internalformat
, GLsizei width
,
490 GLsizei height
, GLint border
,
491 GLsizei imageSize
, const GLvoid
*data
);
493 extern void GLAPIENTRY
494 _mesa_CompressedTexImage3D_no_error(GLenum target
, GLint level
,
495 GLenum internalformat
, GLsizei width
,
496 GLsizei height
, GLsizei depth
, GLint border
,
497 GLsizei imageSize
, const GLvoid
*data
);
500 extern void GLAPIENTRY
501 _mesa_CompressedTexSubImage1D_no_error(GLenum target
, GLint level
,
502 GLint xoffset
, GLsizei width
,
503 GLenum format
, GLsizei imageSize
,
505 extern void GLAPIENTRY
506 _mesa_CompressedTexSubImage1D(GLenum target
, GLint level
, GLint xoffset
,
507 GLsizei width
, GLenum format
,
508 GLsizei imageSize
, const GLvoid
*data
);
510 extern void GLAPIENTRY
511 _mesa_CompressedTextureSubImage1D_no_error(GLuint texture
, GLint level
,
512 GLint xoffset
, GLsizei width
,
513 GLenum format
, GLsizei imageSize
,
515 extern void GLAPIENTRY
516 _mesa_CompressedTextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
517 GLsizei width
, GLenum format
,
518 GLsizei imageSize
, const GLvoid
*data
);
520 extern void GLAPIENTRY
521 _mesa_CompressedTexSubImage2D_no_error(GLenum target
, GLint level
,
522 GLint xoffset
, GLint yoffset
,
523 GLsizei width
, GLsizei height
,
524 GLenum format
, GLsizei imageSize
,
526 extern void GLAPIENTRY
527 _mesa_CompressedTexSubImage2D(GLenum target
, GLint level
, GLint xoffset
,
528 GLint yoffset
, GLsizei width
, GLsizei height
,
529 GLenum format
, GLsizei imageSize
,
532 extern void GLAPIENTRY
533 _mesa_CompressedTextureSubImage2D_no_error(GLuint texture
, GLint level
,
534 GLint xoffset
, GLint yoffset
,
535 GLsizei width
, GLsizei height
,
536 GLenum format
, GLsizei imageSize
,
538 extern void GLAPIENTRY
539 _mesa_CompressedTextureSubImage2D(GLuint texture
, GLint level
, GLint xoffset
,
541 GLsizei width
, GLsizei height
,
542 GLenum format
, GLsizei imageSize
,
545 extern void GLAPIENTRY
546 _mesa_CompressedTexSubImage3D_no_error(GLenum target
, GLint level
,
547 GLint xoffset
, GLint yoffset
,
548 GLint zoffset
, GLsizei width
,
549 GLsizei height
, GLsizei depth
,
550 GLenum format
, GLsizei imageSize
,
552 extern void GLAPIENTRY
553 _mesa_CompressedTexSubImage3D(GLenum target
, GLint level
, GLint xoffset
,
554 GLint yoffset
, GLint zoffset
, GLsizei width
,
555 GLsizei height
, GLsizei depth
, GLenum format
,
556 GLsizei imageSize
, const GLvoid
*data
);
558 extern void GLAPIENTRY
559 _mesa_CompressedTextureSubImage3D_no_error(GLuint texture
, GLint level
,
560 GLint xoffset
, GLint yoffset
,
561 GLint zoffset
, GLsizei width
,
562 GLsizei height
, GLsizei depth
,
563 GLenum format
, GLsizei imageSize
,
565 extern void GLAPIENTRY
566 _mesa_CompressedTextureSubImage3D(GLuint texture
, GLint level
, GLint xoffset
,
567 GLint yoffset
, GLint zoffset
,
568 GLsizei width
, GLsizei height
,
570 GLenum format
, GLsizei imageSize
,
573 extern void GLAPIENTRY
574 _mesa_TexBuffer(GLenum target
, GLenum internalFormat
, GLuint buffer
);
576 extern void GLAPIENTRY
577 _mesa_TexBufferRange(GLenum target
, GLenum internalFormat
, GLuint buffer
,
578 GLintptr offset
, GLsizeiptr size
);
580 extern void GLAPIENTRY
581 _mesa_TextureBuffer(GLuint texture
, GLenum internalFormat
, GLuint buffer
);
583 extern void GLAPIENTRY
584 _mesa_TextureBufferRange(GLuint texture
, GLenum internalFormat
, GLuint buffer
,
585 GLintptr offset
, GLsizeiptr size
);
588 extern void GLAPIENTRY
589 _mesa_TexImage2DMultisample(GLenum target
, GLsizei samples
,
590 GLenum internalformat
, GLsizei width
,
591 GLsizei height
, GLboolean fixedsamplelocations
);
593 extern void GLAPIENTRY
594 _mesa_TexImage3DMultisample(GLenum target
, GLsizei samples
,
595 GLenum internalformat
, GLsizei width
,
596 GLsizei height
, GLsizei depth
,
597 GLboolean fixedsamplelocations
);
599 extern void GLAPIENTRY
600 _mesa_TexStorage2DMultisample(GLenum target
, GLsizei samples
,
601 GLenum internalformat
, GLsizei width
,
602 GLsizei height
, GLboolean fixedsamplelocations
);
604 extern void GLAPIENTRY
605 _mesa_TexStorage3DMultisample(GLenum target
, GLsizei samples
,
606 GLenum internalformat
, GLsizei width
,
607 GLsizei height
, GLsizei depth
,
608 GLboolean fixedsamplelocations
);
611 _mesa_TextureStorage2DMultisample(GLuint texture
, GLsizei samples
,
612 GLenum internalformat
, GLsizei width
,
614 GLboolean fixedsamplelocations
);
617 _mesa_TextureStorage3DMultisample(GLuint texture
, GLsizei samples
,
618 GLenum internalformat
, GLsizei width
,
619 GLsizei height
, GLsizei depth
,
620 GLboolean fixedsamplelocations
);