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
);
162 * Return the base-level texture image for the given texture object.
164 static inline const struct gl_texture_image
*
165 _mesa_base_tex_image(const struct gl_texture_object
*texObj
)
167 return texObj
->Image
[0][texObj
->BaseLevel
];
172 _mesa_max_texture_levels(struct gl_context
*ctx
, GLenum target
);
176 _mesa_test_proxy_teximage(struct gl_context
*ctx
, GLenum target
,
177 GLuint numLevels
, GLint level
,
178 mesa_format format
, GLuint numSamples
,
179 GLint width
, GLint height
, GLint depth
);
182 _mesa_target_can_be_compressed(const struct gl_context
*ctx
, GLenum target
,
183 GLenum intFormat
, GLenum
*error
);
186 _mesa_get_texture_dimensions(GLenum target
);
189 _mesa_tex_target_is_layered(GLenum target
);
192 _mesa_get_texture_layers(const struct gl_texture_object
*texObj
, GLint level
);
195 _mesa_get_tex_max_num_levels(GLenum target
, GLsizei width
, GLsizei height
,
199 _mesa_legal_texture_dimensions(struct gl_context
*ctx
, GLenum target
,
200 GLint level
, GLint width
, GLint height
,
201 GLint depth
, GLint border
);
204 _mesa_validate_texbuffer_format(const struct gl_context
*ctx
,
205 GLenum internalFormat
);
209 _mesa_legal_texture_base_format_for_target(struct gl_context
*ctx
,
211 GLenum internalFormat
);
214 _mesa_format_no_online_compression(const struct gl_context
*ctx
, GLenum format
);
217 _mesa_is_renderable_texture_format(struct gl_context
*ctx
, GLenum internalformat
);
220 _mesa_texture_sub_image(struct gl_context
*ctx
, GLuint dims
,
221 struct gl_texture_object
*texObj
,
222 struct gl_texture_image
*texImage
,
223 GLenum target
, GLint level
,
224 GLint xoffset
, GLint yoffset
, GLint zoffset
,
225 GLsizei width
, GLsizei height
, GLsizei depth
,
226 GLenum format
, GLenum type
, const GLvoid
*pixels
,
230 _mesa_copy_texture_sub_image(struct gl_context
*ctx
, GLuint dims
,
231 struct gl_texture_object
*texObj
,
232 GLenum target
, GLint level
,
233 GLint xoffset
, GLint yoffset
, GLint zoffset
,
235 GLsizei width
, GLsizei height
,
239 _mesa_is_cube_map_texture(GLenum target
);
244 /** \name API entry point functions */
247 extern void GLAPIENTRY
248 _mesa_TexImage1D( GLenum target
, GLint level
, GLint internalformat
,
249 GLsizei width
, GLint border
,
250 GLenum format
, GLenum type
, const GLvoid
*pixels
);
253 extern void GLAPIENTRY
254 _mesa_TexImage2D( GLenum target
, GLint level
, GLint internalformat
,
255 GLsizei width
, GLsizei height
, GLint border
,
256 GLenum format
, GLenum type
, const GLvoid
*pixels
);
259 extern void GLAPIENTRY
260 _mesa_TexImage3D( GLenum target
, GLint level
, GLint internalformat
,
261 GLsizei width
, GLsizei height
, GLsizei depth
, GLint border
,
262 GLenum format
, GLenum type
, const GLvoid
*pixels
);
265 extern void GLAPIENTRY
266 _mesa_TexImage3DEXT( GLenum target
, GLint level
, GLenum internalformat
,
267 GLsizei width
, GLsizei height
, GLsizei depth
,
268 GLint border
, GLenum format
, GLenum type
,
269 const GLvoid
*pixels
);
271 extern void GLAPIENTRY
272 _mesa_TexImage1D_no_error(GLenum target
, GLint level
, GLint internalformat
,
273 GLsizei width
, GLint border
,
274 GLenum format
, GLenum type
, const GLvoid
*pixels
);
276 extern void GLAPIENTRY
277 _mesa_TexImage2D_no_error(GLenum target
, GLint level
, GLint internalformat
,
278 GLsizei width
, GLsizei height
, GLint border
,
279 GLenum format
, GLenum type
, const GLvoid
*pixels
);
281 extern void GLAPIENTRY
282 _mesa_TexImage3D_no_error(GLenum target
, GLint level
, GLint internalformat
,
283 GLsizei width
, GLsizei height
, GLsizei depth
,
284 GLint border
, GLenum format
, GLenum type
,
285 const GLvoid
*pixels
);
287 extern void GLAPIENTRY
288 _mesa_EGLImageTargetTexture2DOES( GLenum target
, GLeglImageOES image
);
291 _mesa_TexSubImage1D_no_error(GLenum target
, GLint level
, GLint xoffset
,
293 GLenum format
, GLenum type
,
294 const GLvoid
*pixels
);
296 extern void GLAPIENTRY
297 _mesa_TexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
299 GLenum format
, GLenum type
,
300 const GLvoid
*pixels
);
303 _mesa_TexSubImage2D_no_error(GLenum target
, GLint level
,
304 GLint xoffset
, GLint yoffset
,
305 GLsizei width
, GLsizei height
,
306 GLenum format
, GLenum type
,
307 const GLvoid
*pixels
);
309 extern void GLAPIENTRY
310 _mesa_TexSubImage2D( GLenum target
, GLint level
,
311 GLint xoffset
, GLint yoffset
,
312 GLsizei width
, GLsizei height
,
313 GLenum format
, GLenum type
,
314 const GLvoid
*pixels
);
317 _mesa_TexSubImage3D_no_error(GLenum target
, GLint level
,
318 GLint xoffset
, GLint yoffset
, GLint zoffset
,
319 GLsizei width
, GLsizei height
, GLsizei depth
,
320 GLenum format
, GLenum type
,
321 const GLvoid
*pixels
);
323 extern void GLAPIENTRY
324 _mesa_TexSubImage3D( GLenum target
, GLint level
,
325 GLint xoffset
, GLint yoffset
, GLint zoffset
,
326 GLsizei width
, GLsizei height
, GLsizei depth
,
327 GLenum format
, GLenum type
,
328 const GLvoid
*pixels
);
330 extern void GLAPIENTRY
331 _mesa_TextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
333 GLenum format
, GLenum type
,
334 const GLvoid
*pixels
);
337 extern void GLAPIENTRY
338 _mesa_TextureSubImage2D(GLuint texture
, GLint level
,
339 GLint xoffset
, GLint yoffset
,
340 GLsizei width
, GLsizei height
,
341 GLenum format
, GLenum type
,
342 const GLvoid
*pixels
);
344 extern void GLAPIENTRY
345 _mesa_TextureSubImage3D(GLuint texture
, GLint level
,
346 GLint xoffset
, GLint yoffset
, GLint zoffset
,
347 GLsizei width
, GLsizei height
, GLsizei depth
,
348 GLenum format
, GLenum type
,
349 const GLvoid
*pixels
);
352 extern void GLAPIENTRY
353 _mesa_CopyTexImage1D(GLenum target
, GLint level
, GLenum internalformat
,
354 GLint x
, GLint y
, GLsizei width
, GLint border
);
357 extern void GLAPIENTRY
358 _mesa_CopyTexImage2D( GLenum target
, GLint level
,
359 GLenum internalformat
, GLint x
, GLint y
,
360 GLsizei width
, GLsizei height
, GLint border
);
363 extern void GLAPIENTRY
364 _mesa_CopyTexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
365 GLint x
, GLint y
, GLsizei width
);
368 extern void GLAPIENTRY
369 _mesa_CopyTexSubImage2D( GLenum target
, GLint level
,
370 GLint xoffset
, GLint yoffset
,
371 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
374 extern void GLAPIENTRY
375 _mesa_CopyTexSubImage3D( GLenum target
, GLint level
,
376 GLint xoffset
, GLint yoffset
, GLint zoffset
,
377 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
379 extern void GLAPIENTRY
380 _mesa_CopyTextureSubImage1D(GLuint texture
, GLint level
,
381 GLint xoffset
, GLint x
, GLint y
, GLsizei width
);
383 extern void GLAPIENTRY
384 _mesa_CopyTextureSubImage2D(GLuint texture
, GLint level
,
385 GLint xoffset
, GLint yoffset
,
387 GLsizei width
, GLsizei height
);
389 extern void GLAPIENTRY
390 _mesa_CopyTextureSubImage3D(GLuint texture
, GLint level
,
391 GLint xoffset
, GLint yoffset
, GLint zoffset
,
393 GLsizei width
, GLsizei height
);
395 extern void GLAPIENTRY
396 _mesa_ClearTexSubImage( GLuint texture
, GLint level
,
397 GLint xoffset
, GLint yoffset
, GLint zoffset
,
398 GLsizei width
, GLsizei height
, GLsizei depth
,
399 GLenum format
, GLenum type
, const void *data
);
401 extern void GLAPIENTRY
402 _mesa_ClearTexImage( GLuint texture
, GLint level
,
403 GLenum format
, GLenum type
, const void *data
);
405 extern void GLAPIENTRY
406 _mesa_CompressedTexImage1D(GLenum target
, GLint level
,
407 GLenum internalformat
, GLsizei width
,
408 GLint border
, GLsizei imageSize
,
411 extern void GLAPIENTRY
412 _mesa_CompressedTexImage2D(GLenum target
, GLint level
,
413 GLenum internalformat
, GLsizei width
,
414 GLsizei height
, GLint border
, GLsizei imageSize
,
417 extern void GLAPIENTRY
418 _mesa_CompressedTexImage3D(GLenum target
, GLint level
,
419 GLenum internalformat
, GLsizei width
,
420 GLsizei height
, GLsizei depth
, GLint border
,
421 GLsizei imageSize
, const GLvoid
*data
);
423 extern void GLAPIENTRY
424 _mesa_CompressedTexImage1D_no_error(GLenum target
, GLint level
,
425 GLenum internalformat
, GLsizei width
,
426 GLint border
, GLsizei imageSize
,
429 extern void GLAPIENTRY
430 _mesa_CompressedTexImage2D_no_error(GLenum target
, GLint level
,
431 GLenum internalformat
, GLsizei width
,
432 GLsizei height
, GLint border
,
433 GLsizei imageSize
, const GLvoid
*data
);
435 extern void GLAPIENTRY
436 _mesa_CompressedTexImage3D_no_error(GLenum target
, GLint level
,
437 GLenum internalformat
, GLsizei width
,
438 GLsizei height
, GLsizei depth
, GLint border
,
439 GLsizei imageSize
, const GLvoid
*data
);
442 extern void GLAPIENTRY
443 _mesa_CompressedTexSubImage1D_no_error(GLenum target
, GLint level
,
444 GLint xoffset
, GLsizei width
,
445 GLenum format
, GLsizei imageSize
,
447 extern void GLAPIENTRY
448 _mesa_CompressedTexSubImage1D(GLenum target
, GLint level
, GLint xoffset
,
449 GLsizei width
, GLenum format
,
450 GLsizei imageSize
, const GLvoid
*data
);
452 extern void GLAPIENTRY
453 _mesa_CompressedTextureSubImage1D_no_error(GLuint texture
, GLint level
,
454 GLint xoffset
, GLsizei width
,
455 GLenum format
, GLsizei imageSize
,
457 extern void GLAPIENTRY
458 _mesa_CompressedTextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
459 GLsizei width
, GLenum format
,
460 GLsizei imageSize
, const GLvoid
*data
);
462 extern void GLAPIENTRY
463 _mesa_CompressedTexSubImage2D_no_error(GLenum target
, GLint level
,
464 GLint xoffset
, GLint yoffset
,
465 GLsizei width
, GLsizei height
,
466 GLenum format
, GLsizei imageSize
,
468 extern void GLAPIENTRY
469 _mesa_CompressedTexSubImage2D(GLenum target
, GLint level
, GLint xoffset
,
470 GLint yoffset
, GLsizei width
, GLsizei height
,
471 GLenum format
, GLsizei imageSize
,
474 extern void GLAPIENTRY
475 _mesa_CompressedTextureSubImage2D_no_error(GLuint texture
, GLint level
,
476 GLint xoffset
, GLint yoffset
,
477 GLsizei width
, GLsizei height
,
478 GLenum format
, GLsizei imageSize
,
480 extern void GLAPIENTRY
481 _mesa_CompressedTextureSubImage2D(GLuint texture
, GLint level
, GLint xoffset
,
483 GLsizei width
, GLsizei height
,
484 GLenum format
, GLsizei imageSize
,
487 extern void GLAPIENTRY
488 _mesa_CompressedTexSubImage3D_no_error(GLenum target
, GLint level
,
489 GLint xoffset
, GLint yoffset
,
490 GLint zoffset
, GLsizei width
,
491 GLsizei height
, GLsizei depth
,
492 GLenum format
, GLsizei imageSize
,
494 extern void GLAPIENTRY
495 _mesa_CompressedTexSubImage3D(GLenum target
, GLint level
, GLint xoffset
,
496 GLint yoffset
, GLint zoffset
, GLsizei width
,
497 GLsizei height
, GLsizei depth
, GLenum format
,
498 GLsizei imageSize
, const GLvoid
*data
);
500 extern void GLAPIENTRY
501 _mesa_CompressedTextureSubImage3D_no_error(GLuint texture
, GLint level
,
502 GLint xoffset
, GLint yoffset
,
503 GLint zoffset
, GLsizei width
,
504 GLsizei height
, GLsizei depth
,
505 GLenum format
, GLsizei imageSize
,
507 extern void GLAPIENTRY
508 _mesa_CompressedTextureSubImage3D(GLuint texture
, GLint level
, GLint xoffset
,
509 GLint yoffset
, GLint zoffset
,
510 GLsizei width
, GLsizei height
,
512 GLenum format
, GLsizei imageSize
,
515 extern void GLAPIENTRY
516 _mesa_TexBuffer(GLenum target
, GLenum internalFormat
, GLuint buffer
);
518 extern void GLAPIENTRY
519 _mesa_TexBufferRange(GLenum target
, GLenum internalFormat
, GLuint buffer
,
520 GLintptr offset
, GLsizeiptr size
);
522 extern void GLAPIENTRY
523 _mesa_TextureBuffer(GLuint texture
, GLenum internalFormat
, GLuint buffer
);
525 extern void GLAPIENTRY
526 _mesa_TextureBufferRange(GLuint texture
, GLenum internalFormat
, GLuint buffer
,
527 GLintptr offset
, GLsizeiptr size
);
530 extern void GLAPIENTRY
531 _mesa_TexImage2DMultisample(GLenum target
, GLsizei samples
,
532 GLenum internalformat
, GLsizei width
,
533 GLsizei height
, GLboolean fixedsamplelocations
);
535 extern void GLAPIENTRY
536 _mesa_TexImage3DMultisample(GLenum target
, GLsizei samples
,
537 GLenum internalformat
, GLsizei width
,
538 GLsizei height
, GLsizei depth
,
539 GLboolean fixedsamplelocations
);
541 extern void GLAPIENTRY
542 _mesa_TexStorage2DMultisample(GLenum target
, GLsizei samples
,
543 GLenum internalformat
, GLsizei width
,
544 GLsizei height
, GLboolean fixedsamplelocations
);
546 extern void GLAPIENTRY
547 _mesa_TexStorage3DMultisample(GLenum target
, GLsizei samples
,
548 GLenum internalformat
, GLsizei width
,
549 GLsizei height
, GLsizei depth
,
550 GLboolean fixedsamplelocations
);
553 _mesa_TextureStorage2DMultisample(GLuint texture
, GLsizei samples
,
554 GLenum internalformat
, GLsizei width
,
556 GLboolean fixedsamplelocations
);
559 _mesa_TextureStorage3DMultisample(GLuint texture
, GLsizei samples
,
560 GLenum internalformat
, GLsizei width
,
561 GLsizei height
, GLsizei depth
,
562 GLboolean fixedsamplelocations
);