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
);
121 extern struct gl_texture_image
*
122 _mesa_new_texture_image( struct gl_context
*ctx
);
126 _mesa_delete_texture_image( struct gl_context
*ctx
,
127 struct gl_texture_image
*teximage
);
131 _mesa_init_teximage_fields(struct gl_context
*ctx
,
132 struct gl_texture_image
*img
,
133 GLsizei width
, GLsizei height
, GLsizei depth
,
134 GLint border
, GLenum internalFormat
,
139 _mesa_choose_texture_format(struct gl_context
*ctx
,
140 struct gl_texture_object
*texObj
,
141 GLenum target
, GLint level
,
142 GLenum internalFormat
, GLenum format
, GLenum type
);
145 _mesa_update_fbo_texture(struct gl_context
*ctx
,
146 struct gl_texture_object
*texObj
,
147 GLuint face
, GLuint level
);
150 _mesa_clear_texture_image(struct gl_context
*ctx
,
151 struct gl_texture_image
*texImage
);
154 extern struct gl_texture_image
*
155 _mesa_select_tex_image(const struct gl_texture_object
*texObj
,
156 GLenum target
, GLint level
);
159 extern struct gl_texture_image
*
160 _mesa_get_tex_image(struct gl_context
*ctx
, struct gl_texture_object
*texObj
,
161 GLenum target
, GLint level
);
165 * Return the base-level texture image for the given texture object.
167 static inline const struct gl_texture_image
*
168 _mesa_base_tex_image(const struct gl_texture_object
*texObj
)
170 return texObj
->Image
[0][texObj
->BaseLevel
];
175 _mesa_max_texture_levels(struct gl_context
*ctx
, GLenum target
);
179 _mesa_test_proxy_teximage(struct gl_context
*ctx
, GLenum target
,
180 GLuint numLevels
, GLint level
,
181 mesa_format format
, GLuint numSamples
,
182 GLint width
, GLint height
, GLint depth
);
185 _mesa_target_can_be_compressed(const struct gl_context
*ctx
, GLenum target
,
186 GLenum intFormat
, GLenum
*error
);
189 _mesa_get_texture_dimensions(GLenum target
);
192 _mesa_tex_target_is_layered(GLenum target
);
195 _mesa_get_texture_layers(const struct gl_texture_object
*texObj
, GLint level
);
198 _mesa_get_tex_max_num_levels(GLenum target
, GLsizei width
, GLsizei height
,
202 _mesa_legal_texture_dimensions(struct gl_context
*ctx
, GLenum target
,
203 GLint level
, GLint width
, GLint height
,
204 GLint depth
, GLint border
);
207 _mesa_validate_texbuffer_format(const struct gl_context
*ctx
,
208 GLenum internalFormat
);
212 _mesa_legal_texture_base_format_for_target(struct gl_context
*ctx
,
214 GLenum internalFormat
);
217 _mesa_format_no_online_compression(const struct gl_context
*ctx
, GLenum format
);
220 _mesa_is_renderable_texture_format(struct gl_context
*ctx
, GLenum internalformat
);
223 _mesa_texture_sub_image(struct gl_context
*ctx
, GLuint dims
,
224 struct gl_texture_object
*texObj
,
225 struct gl_texture_image
*texImage
,
226 GLenum target
, GLint level
,
227 GLint xoffset
, GLint yoffset
, GLint zoffset
,
228 GLsizei width
, GLsizei height
, GLsizei depth
,
229 GLenum format
, GLenum type
, const GLvoid
*pixels
,
233 _mesa_compressed_texture_sub_image(struct gl_context
*ctx
, GLuint dims
,
234 struct gl_texture_object
*texObj
,
235 struct gl_texture_image
*texImage
,
236 GLenum target
, GLint level
,
237 GLint xoffset
, GLint yoffset
,
239 GLsizei width
, GLsizei height
,
241 GLenum format
, GLsizei imageSize
,
245 _mesa_copy_texture_sub_image(struct gl_context
*ctx
, GLuint dims
,
246 struct gl_texture_object
*texObj
,
247 GLenum target
, GLint level
,
248 GLint xoffset
, GLint yoffset
, GLint zoffset
,
250 GLsizei width
, GLsizei height
,
254 _mesa_is_cube_map_texture(GLenum target
);
259 /** \name API entry point functions */
262 extern void GLAPIENTRY
263 _mesa_TexImage1D( GLenum target
, GLint level
, GLint internalformat
,
264 GLsizei width
, GLint border
,
265 GLenum format
, GLenum type
, const GLvoid
*pixels
);
268 extern void GLAPIENTRY
269 _mesa_TexImage2D( GLenum target
, GLint level
, GLint internalformat
,
270 GLsizei width
, GLsizei height
, GLint border
,
271 GLenum format
, GLenum type
, const GLvoid
*pixels
);
274 extern void GLAPIENTRY
275 _mesa_TexImage3D( GLenum target
, GLint level
, GLint internalformat
,
276 GLsizei width
, GLsizei height
, GLsizei depth
, GLint border
,
277 GLenum format
, GLenum type
, const GLvoid
*pixels
);
280 extern void GLAPIENTRY
281 _mesa_TexImage3DEXT( GLenum target
, GLint level
, GLenum internalformat
,
282 GLsizei width
, GLsizei height
, GLsizei depth
,
283 GLint border
, GLenum format
, GLenum type
,
284 const GLvoid
*pixels
);
286 extern void GLAPIENTRY
287 _mesa_EGLImageTargetTexture2DOES( GLenum target
, GLeglImageOES image
);
289 extern void GLAPIENTRY
290 _mesa_TexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
292 GLenum format
, GLenum type
,
293 const GLvoid
*pixels
);
296 extern void GLAPIENTRY
297 _mesa_TexSubImage2D( GLenum target
, GLint level
,
298 GLint xoffset
, GLint yoffset
,
299 GLsizei width
, GLsizei height
,
300 GLenum format
, GLenum type
,
301 const GLvoid
*pixels
);
304 extern void GLAPIENTRY
305 _mesa_TexSubImage3D( GLenum target
, GLint level
,
306 GLint xoffset
, GLint yoffset
, GLint zoffset
,
307 GLsizei width
, GLsizei height
, GLsizei depth
,
308 GLenum format
, GLenum type
,
309 const GLvoid
*pixels
);
311 extern void GLAPIENTRY
312 _mesa_TextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
314 GLenum format
, GLenum type
,
315 const GLvoid
*pixels
);
318 extern void GLAPIENTRY
319 _mesa_TextureSubImage2D(GLuint texture
, GLint level
,
320 GLint xoffset
, GLint yoffset
,
321 GLsizei width
, GLsizei height
,
322 GLenum format
, GLenum type
,
323 const GLvoid
*pixels
);
325 extern void GLAPIENTRY
326 _mesa_TextureSubImage3D(GLuint texture
, GLint level
,
327 GLint xoffset
, GLint yoffset
, GLint zoffset
,
328 GLsizei width
, GLsizei height
, GLsizei depth
,
329 GLenum format
, GLenum type
,
330 const GLvoid
*pixels
);
333 extern void GLAPIENTRY
334 _mesa_CopyTexImage1D(GLenum target
, GLint level
, GLenum internalformat
,
335 GLint x
, GLint y
, GLsizei width
, GLint border
);
338 extern void GLAPIENTRY
339 _mesa_CopyTexImage2D( GLenum target
, GLint level
,
340 GLenum internalformat
, GLint x
, GLint y
,
341 GLsizei width
, GLsizei height
, GLint border
);
344 extern void GLAPIENTRY
345 _mesa_CopyTexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
346 GLint x
, GLint y
, GLsizei width
);
349 extern void GLAPIENTRY
350 _mesa_CopyTexSubImage2D( GLenum target
, GLint level
,
351 GLint xoffset
, GLint yoffset
,
352 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
355 extern void GLAPIENTRY
356 _mesa_CopyTexSubImage3D( GLenum target
, GLint level
,
357 GLint xoffset
, GLint yoffset
, GLint zoffset
,
358 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
360 extern void GLAPIENTRY
361 _mesa_CopyTextureSubImage1D(GLuint texture
, GLint level
,
362 GLint xoffset
, GLint x
, GLint y
, GLsizei width
);
364 extern void GLAPIENTRY
365 _mesa_CopyTextureSubImage2D(GLuint texture
, GLint level
,
366 GLint xoffset
, GLint yoffset
,
368 GLsizei width
, GLsizei height
);
370 extern void GLAPIENTRY
371 _mesa_CopyTextureSubImage3D(GLuint texture
, GLint level
,
372 GLint xoffset
, GLint yoffset
, GLint zoffset
,
374 GLsizei width
, GLsizei height
);
376 extern void GLAPIENTRY
377 _mesa_ClearTexSubImage( GLuint texture
, GLint level
,
378 GLint xoffset
, GLint yoffset
, GLint zoffset
,
379 GLsizei width
, GLsizei height
, GLsizei depth
,
380 GLenum format
, GLenum type
, const void *data
);
382 extern void GLAPIENTRY
383 _mesa_ClearTexImage( GLuint texture
, GLint level
,
384 GLenum format
, GLenum type
, const void *data
);
386 extern void GLAPIENTRY
387 _mesa_CompressedTexImage1D(GLenum target
, GLint level
,
388 GLenum internalformat
, GLsizei width
,
389 GLint border
, GLsizei imageSize
,
392 extern void GLAPIENTRY
393 _mesa_CompressedTexImage2D(GLenum target
, GLint level
,
394 GLenum internalformat
, GLsizei width
,
395 GLsizei height
, GLint border
, GLsizei imageSize
,
398 extern void GLAPIENTRY
399 _mesa_CompressedTexImage3D(GLenum target
, GLint level
,
400 GLenum internalformat
, GLsizei width
,
401 GLsizei height
, GLsizei depth
, GLint border
,
402 GLsizei imageSize
, const GLvoid
*data
);
404 extern void GLAPIENTRY
405 _mesa_CompressedTexSubImage1D(GLenum target
, GLint level
, GLint xoffset
,
406 GLsizei width
, GLenum format
,
407 GLsizei imageSize
, const GLvoid
*data
);
409 extern void GLAPIENTRY
410 _mesa_CompressedTextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
411 GLsizei width
, GLenum format
,
412 GLsizei imageSize
, const GLvoid
*data
);
414 extern void GLAPIENTRY
415 _mesa_CompressedTexSubImage2D(GLenum target
, GLint level
, GLint xoffset
,
416 GLint yoffset
, GLsizei width
, GLsizei height
,
417 GLenum format
, GLsizei imageSize
,
420 extern void GLAPIENTRY
421 _mesa_CompressedTextureSubImage2D(GLuint texture
, GLint level
, GLint xoffset
,
423 GLsizei width
, GLsizei height
,
424 GLenum format
, GLsizei imageSize
,
427 extern void GLAPIENTRY
428 _mesa_CompressedTexSubImage3D(GLenum target
, GLint level
, GLint xoffset
,
429 GLint yoffset
, GLint zoffset
, GLsizei width
,
430 GLsizei height
, GLsizei depth
, GLenum format
,
431 GLsizei imageSize
, const GLvoid
*data
);
433 extern void GLAPIENTRY
434 _mesa_CompressedTextureSubImage3D(GLuint texture
, GLint level
, GLint xoffset
,
435 GLint yoffset
, GLint zoffset
,
436 GLsizei width
, GLsizei height
,
438 GLenum format
, GLsizei imageSize
,
441 extern void GLAPIENTRY
442 _mesa_TexBuffer(GLenum target
, GLenum internalFormat
, GLuint buffer
);
444 extern void GLAPIENTRY
445 _mesa_TexBufferRange(GLenum target
, GLenum internalFormat
, GLuint buffer
,
446 GLintptr offset
, GLsizeiptr size
);
448 extern void GLAPIENTRY
449 _mesa_TextureBuffer(GLuint texture
, GLenum internalFormat
, GLuint buffer
);
451 extern void GLAPIENTRY
452 _mesa_TextureBufferRange(GLuint texture
, GLenum internalFormat
, GLuint buffer
,
453 GLintptr offset
, GLsizeiptr size
);
456 extern void GLAPIENTRY
457 _mesa_TexImage2DMultisample(GLenum target
, GLsizei samples
,
458 GLenum internalformat
, GLsizei width
,
459 GLsizei height
, GLboolean fixedsamplelocations
);
461 extern void GLAPIENTRY
462 _mesa_TexImage3DMultisample(GLenum target
, GLsizei samples
,
463 GLenum internalformat
, GLsizei width
,
464 GLsizei height
, GLsizei depth
,
465 GLboolean fixedsamplelocations
);
467 extern void GLAPIENTRY
468 _mesa_TexStorage2DMultisample(GLenum target
, GLsizei samples
,
469 GLenum internalformat
, GLsizei width
,
470 GLsizei height
, GLboolean fixedsamplelocations
);
472 extern void GLAPIENTRY
473 _mesa_TexStorage3DMultisample(GLenum target
, GLsizei samples
,
474 GLenum internalformat
, GLsizei width
,
475 GLsizei height
, GLsizei depth
,
476 GLboolean fixedsamplelocations
);
479 _mesa_TextureStorage2DMultisample(GLuint texture
, GLsizei samples
,
480 GLenum internalformat
, GLsizei width
,
482 GLboolean fixedsamplelocations
);
485 _mesa_TextureStorage3DMultisample(GLuint texture
, GLsizei samples
,
486 GLenum internalformat
, GLsizei width
,
487 GLsizei height
, GLsizei depth
,
488 GLboolean fixedsamplelocations
);