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_EGLImageTargetTexture2DOES( GLenum target
, GLeglImageOES image
);
274 extern void GLAPIENTRY
275 _mesa_TexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
277 GLenum format
, GLenum type
,
278 const GLvoid
*pixels
);
281 extern void GLAPIENTRY
282 _mesa_TexSubImage2D( GLenum target
, GLint level
,
283 GLint xoffset
, GLint yoffset
,
284 GLsizei width
, GLsizei height
,
285 GLenum format
, GLenum type
,
286 const GLvoid
*pixels
);
289 extern void GLAPIENTRY
290 _mesa_TexSubImage3D( GLenum target
, GLint level
,
291 GLint xoffset
, GLint yoffset
, GLint zoffset
,
292 GLsizei width
, GLsizei height
, GLsizei depth
,
293 GLenum format
, GLenum type
,
294 const GLvoid
*pixels
);
296 extern void GLAPIENTRY
297 _mesa_TextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
299 GLenum format
, GLenum type
,
300 const GLvoid
*pixels
);
303 extern void GLAPIENTRY
304 _mesa_TextureSubImage2D(GLuint texture
, GLint level
,
305 GLint xoffset
, GLint yoffset
,
306 GLsizei width
, GLsizei height
,
307 GLenum format
, GLenum type
,
308 const GLvoid
*pixels
);
310 extern void GLAPIENTRY
311 _mesa_TextureSubImage3D(GLuint texture
, GLint level
,
312 GLint xoffset
, GLint yoffset
, GLint zoffset
,
313 GLsizei width
, GLsizei height
, GLsizei depth
,
314 GLenum format
, GLenum type
,
315 const GLvoid
*pixels
);
318 extern void GLAPIENTRY
319 _mesa_CopyTexImage1D(GLenum target
, GLint level
, GLenum internalformat
,
320 GLint x
, GLint y
, GLsizei width
, GLint border
);
323 extern void GLAPIENTRY
324 _mesa_CopyTexImage2D( GLenum target
, GLint level
,
325 GLenum internalformat
, GLint x
, GLint y
,
326 GLsizei width
, GLsizei height
, GLint border
);
329 extern void GLAPIENTRY
330 _mesa_CopyTexSubImage1D( GLenum target
, GLint level
, GLint xoffset
,
331 GLint x
, GLint y
, GLsizei width
);
334 extern void GLAPIENTRY
335 _mesa_CopyTexSubImage2D( GLenum target
, GLint level
,
336 GLint xoffset
, GLint yoffset
,
337 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
340 extern void GLAPIENTRY
341 _mesa_CopyTexSubImage3D( GLenum target
, GLint level
,
342 GLint xoffset
, GLint yoffset
, GLint zoffset
,
343 GLint x
, GLint y
, GLsizei width
, GLsizei height
);
345 extern void GLAPIENTRY
346 _mesa_CopyTextureSubImage1D(GLuint texture
, GLint level
,
347 GLint xoffset
, GLint x
, GLint y
, GLsizei width
);
349 extern void GLAPIENTRY
350 _mesa_CopyTextureSubImage2D(GLuint texture
, GLint level
,
351 GLint xoffset
, GLint yoffset
,
353 GLsizei width
, GLsizei height
);
355 extern void GLAPIENTRY
356 _mesa_CopyTextureSubImage3D(GLuint texture
, GLint level
,
357 GLint xoffset
, GLint yoffset
, GLint zoffset
,
359 GLsizei width
, GLsizei height
);
361 extern void GLAPIENTRY
362 _mesa_ClearTexSubImage( GLuint texture
, GLint level
,
363 GLint xoffset
, GLint yoffset
, GLint zoffset
,
364 GLsizei width
, GLsizei height
, GLsizei depth
,
365 GLenum format
, GLenum type
, const void *data
);
367 extern void GLAPIENTRY
368 _mesa_ClearTexImage( GLuint texture
, GLint level
,
369 GLenum format
, GLenum type
, const void *data
);
371 extern void GLAPIENTRY
372 _mesa_CompressedTexImage1D(GLenum target
, GLint level
,
373 GLenum internalformat
, GLsizei width
,
374 GLint border
, GLsizei imageSize
,
377 extern void GLAPIENTRY
378 _mesa_CompressedTexImage2D(GLenum target
, GLint level
,
379 GLenum internalformat
, GLsizei width
,
380 GLsizei height
, GLint border
, GLsizei imageSize
,
383 extern void GLAPIENTRY
384 _mesa_CompressedTexImage3D(GLenum target
, GLint level
,
385 GLenum internalformat
, GLsizei width
,
386 GLsizei height
, GLsizei depth
, GLint border
,
387 GLsizei imageSize
, const GLvoid
*data
);
390 extern void GLAPIENTRY
391 _mesa_CompressedTexSubImage1D_no_error(GLenum target
, GLint level
,
392 GLint xoffset
, GLsizei width
,
393 GLenum format
, GLsizei imageSize
,
395 extern void GLAPIENTRY
396 _mesa_CompressedTexSubImage1D(GLenum target
, GLint level
, GLint xoffset
,
397 GLsizei width
, GLenum format
,
398 GLsizei imageSize
, const GLvoid
*data
);
400 extern void GLAPIENTRY
401 _mesa_CompressedTextureSubImage1D_no_error(GLuint texture
, GLint level
,
402 GLint xoffset
, GLsizei width
,
403 GLenum format
, GLsizei imageSize
,
405 extern void GLAPIENTRY
406 _mesa_CompressedTextureSubImage1D(GLuint texture
, GLint level
, GLint xoffset
,
407 GLsizei width
, GLenum format
,
408 GLsizei imageSize
, const GLvoid
*data
);
410 extern void GLAPIENTRY
411 _mesa_CompressedTexSubImage2D(GLenum target
, GLint level
, GLint xoffset
,
412 GLint yoffset
, GLsizei width
, GLsizei height
,
413 GLenum format
, GLsizei imageSize
,
416 extern void GLAPIENTRY
417 _mesa_CompressedTextureSubImage2D(GLuint texture
, GLint level
, GLint xoffset
,
419 GLsizei width
, GLsizei height
,
420 GLenum format
, GLsizei imageSize
,
423 extern void GLAPIENTRY
424 _mesa_CompressedTexSubImage3D(GLenum target
, GLint level
, GLint xoffset
,
425 GLint yoffset
, GLint zoffset
, GLsizei width
,
426 GLsizei height
, GLsizei depth
, GLenum format
,
427 GLsizei imageSize
, const GLvoid
*data
);
429 extern void GLAPIENTRY
430 _mesa_CompressedTextureSubImage3D(GLuint texture
, GLint level
, GLint xoffset
,
431 GLint yoffset
, GLint zoffset
,
432 GLsizei width
, GLsizei height
,
434 GLenum format
, GLsizei imageSize
,
437 extern void GLAPIENTRY
438 _mesa_TexBuffer(GLenum target
, GLenum internalFormat
, GLuint buffer
);
440 extern void GLAPIENTRY
441 _mesa_TexBufferRange(GLenum target
, GLenum internalFormat
, GLuint buffer
,
442 GLintptr offset
, GLsizeiptr size
);
444 extern void GLAPIENTRY
445 _mesa_TextureBuffer(GLuint texture
, GLenum internalFormat
, GLuint buffer
);
447 extern void GLAPIENTRY
448 _mesa_TextureBufferRange(GLuint texture
, GLenum internalFormat
, GLuint buffer
,
449 GLintptr offset
, GLsizeiptr size
);
452 extern void GLAPIENTRY
453 _mesa_TexImage2DMultisample(GLenum target
, GLsizei samples
,
454 GLenum internalformat
, GLsizei width
,
455 GLsizei height
, GLboolean fixedsamplelocations
);
457 extern void GLAPIENTRY
458 _mesa_TexImage3DMultisample(GLenum target
, GLsizei samples
,
459 GLenum internalformat
, GLsizei width
,
460 GLsizei height
, GLsizei depth
,
461 GLboolean fixedsamplelocations
);
463 extern void GLAPIENTRY
464 _mesa_TexStorage2DMultisample(GLenum target
, GLsizei samples
,
465 GLenum internalformat
, GLsizei width
,
466 GLsizei height
, GLboolean fixedsamplelocations
);
468 extern void GLAPIENTRY
469 _mesa_TexStorage3DMultisample(GLenum target
, GLsizei samples
,
470 GLenum internalformat
, GLsizei width
,
471 GLsizei height
, GLsizei depth
,
472 GLboolean fixedsamplelocations
);
475 _mesa_TextureStorage2DMultisample(GLuint texture
, GLsizei samples
,
476 GLenum internalformat
, GLsizei width
,
478 GLboolean fixedsamplelocations
);
481 _mesa_TextureStorage3DMultisample(GLuint texture
, GLsizei samples
,
482 GLenum internalformat
, GLsizei width
,
483 GLsizei height
, GLsizei depth
,
484 GLboolean fixedsamplelocations
);