mesa: make get_texbuffer_format() global
[mesa.git] / 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 &&
47 target <= GL_TEXTURE_CUBE_MAP_NEGATIVE_Z);
48 }
49
50
51 /**
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.
56 */
57 static inline GLuint
58 _mesa_num_tex_faces(GLenum target)
59 {
60 switch (target) {
61 case GL_TEXTURE_CUBE_MAP:
62 case GL_PROXY_TEXTURE_CUBE_MAP:
63 return 6;
64 default:
65 return 1;
66 }
67 }
68
69
70 /**
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
73 * the face parameter.
74 * Else, return target as-is.
75 */
76 static inline GLenum
77 _mesa_cube_face_target(GLenum target, unsigned face)
78 {
79 if (target == GL_TEXTURE_CUBE_MAP) {
80 assert(face < 6);
81 return GL_TEXTURE_CUBE_MAP_POSITIVE_X + face;
82 }
83 else {
84 return target;
85 }
86 }
87
88
89 /**
90 * For cube map faces, return a face index in [0,5].
91 * For other targets return 0;
92 */
93 static inline GLuint
94 _mesa_tex_target_to_face(GLenum target)
95 {
96 if (_mesa_is_cube_face(target))
97 return (GLuint) target - (GLuint) GL_TEXTURE_CUBE_MAP_POSITIVE_X;
98 else
99 return 0;
100 }
101
102
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)
106 {
107 return (texImage->Width == 0 ||
108 texImage->Height == 0 ||
109 texImage->Depth == 0);
110 }
111
112 /** \name Internal functions */
113 /*@{*/
114
115 extern GLboolean
116 _mesa_is_proxy_texture(GLenum target);
117
118 extern bool
119 _mesa_is_array_texture(GLenum target);
120
121
122 extern void
123 _mesa_delete_texture_image( struct gl_context *ctx,
124 struct gl_texture_image *teximage );
125
126
127 extern void
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,
132 mesa_format format);
133
134
135 extern mesa_format
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);
140
141 extern void
142 _mesa_update_fbo_texture(struct gl_context *ctx,
143 struct gl_texture_object *texObj,
144 GLuint face, GLuint level);
145
146 extern void
147 _mesa_clear_texture_image(struct gl_context *ctx,
148 struct gl_texture_image *texImage);
149
150
151 extern struct gl_texture_image *
152 _mesa_select_tex_image(const struct gl_texture_object *texObj,
153 GLenum target, GLint level);
154
155
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);
159
160 mesa_format
161 _mesa_get_texbuffer_format(const struct gl_context *ctx, GLenum internalFormat);
162
163 /**
164 * Return the base-level texture image for the given texture object.
165 */
166 static inline const struct gl_texture_image *
167 _mesa_base_tex_image(const struct gl_texture_object *texObj)
168 {
169 return texObj->Image[0][texObj->BaseLevel];
170 }
171
172
173 extern GLint
174 _mesa_max_texture_levels(struct gl_context *ctx, GLenum target);
175
176
177 extern GLboolean
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);
182
183 extern GLboolean
184 _mesa_target_can_be_compressed(const struct gl_context *ctx, GLenum target,
185 GLenum intFormat, GLenum *error);
186
187 extern GLint
188 _mesa_get_texture_dimensions(GLenum target);
189
190 extern GLboolean
191 _mesa_tex_target_is_layered(GLenum target);
192
193 extern GLuint
194 _mesa_get_texture_layers(const struct gl_texture_object *texObj, GLint level);
195
196 extern GLsizei
197 _mesa_get_tex_max_num_levels(GLenum target, GLsizei width, GLsizei height,
198 GLsizei depth);
199
200 extern GLboolean
201 _mesa_legal_texture_dimensions(struct gl_context *ctx, GLenum target,
202 GLint level, GLint width, GLint height,
203 GLint depth, GLint border);
204
205 extern mesa_format
206 _mesa_validate_texbuffer_format(const struct gl_context *ctx,
207 GLenum internalFormat);
208
209
210 bool
211 _mesa_legal_texture_base_format_for_target(struct gl_context *ctx,
212 GLenum target,
213 GLenum internalFormat);
214
215 bool
216 _mesa_format_no_online_compression(const struct gl_context *ctx, GLenum format);
217
218 GLboolean
219 _mesa_is_renderable_texture_format(struct gl_context *ctx, GLenum internalformat);
220
221 extern void
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,
229 bool dsa);
230
231 bool
232 _mesa_is_cube_map_texture(GLenum target);
233
234 /*@}*/
235
236
237 /** \name API entry point functions */
238 /*@{*/
239
240 extern void GLAPIENTRY
241 _mesa_TexImage1D( GLenum target, GLint level, GLint internalformat,
242 GLsizei width, GLint border,
243 GLenum format, GLenum type, const GLvoid *pixels );
244
245
246 extern void GLAPIENTRY
247 _mesa_TexImage2D( GLenum target, GLint level, GLint internalformat,
248 GLsizei width, GLsizei height, GLint border,
249 GLenum format, GLenum type, const GLvoid *pixels );
250
251
252 extern void GLAPIENTRY
253 _mesa_TexImage3D( GLenum target, GLint level, GLint internalformat,
254 GLsizei width, GLsizei height, GLsizei depth, GLint border,
255 GLenum format, GLenum type, const GLvoid *pixels );
256
257
258 extern void GLAPIENTRY
259 _mesa_TexImage3DEXT( GLenum target, GLint level, GLenum internalformat,
260 GLsizei width, GLsizei height, GLsizei depth,
261 GLint border, GLenum format, GLenum type,
262 const GLvoid *pixels );
263
264 extern void GLAPIENTRY
265 _mesa_TexImage1D_no_error(GLenum target, GLint level, GLint internalformat,
266 GLsizei width, GLint border,
267 GLenum format, GLenum type, const GLvoid *pixels);
268
269 extern void GLAPIENTRY
270 _mesa_TexImage2D_no_error(GLenum target, GLint level, GLint internalformat,
271 GLsizei width, GLsizei height, GLint border,
272 GLenum format, GLenum type, const GLvoid *pixels);
273
274 extern void GLAPIENTRY
275 _mesa_TexImage3D_no_error(GLenum target, GLint level, GLint internalformat,
276 GLsizei width, GLsizei height, GLsizei depth,
277 GLint border, GLenum format, GLenum type,
278 const GLvoid *pixels);
279
280 extern void GLAPIENTRY
281 _mesa_EGLImageTargetTexture2DOES( GLenum target, GLeglImageOES image );
282
283 void GLAPIENTRY
284 _mesa_TexSubImage1D_no_error(GLenum target, GLint level, GLint xoffset,
285 GLsizei width,
286 GLenum format, GLenum type,
287 const GLvoid *pixels);
288
289 extern void GLAPIENTRY
290 _mesa_TexSubImage1D( GLenum target, GLint level, GLint xoffset,
291 GLsizei width,
292 GLenum format, GLenum type,
293 const GLvoid *pixels );
294
295 void GLAPIENTRY
296 _mesa_TexSubImage2D_no_error(GLenum target, GLint level,
297 GLint xoffset, GLint yoffset,
298 GLsizei width, GLsizei height,
299 GLenum format, GLenum type,
300 const GLvoid *pixels);
301
302 extern void GLAPIENTRY
303 _mesa_TexSubImage2D( GLenum target, GLint level,
304 GLint xoffset, GLint yoffset,
305 GLsizei width, GLsizei height,
306 GLenum format, GLenum type,
307 const GLvoid *pixels );
308
309 void GLAPIENTRY
310 _mesa_TexSubImage3D_no_error(GLenum target, GLint level,
311 GLint xoffset, GLint yoffset, GLint zoffset,
312 GLsizei width, GLsizei height, GLsizei depth,
313 GLenum format, GLenum type,
314 const GLvoid *pixels);
315
316 extern void GLAPIENTRY
317 _mesa_TexSubImage3D( 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 );
322
323 void GLAPIENTRY
324 _mesa_TextureSubImage1D_no_error(GLuint texture, GLint level, GLint xoffset,
325 GLsizei width, GLenum format, GLenum type,
326 const GLvoid *pixels);
327
328 extern void GLAPIENTRY
329 _mesa_TextureSubImage1D(GLuint texture, GLint level, GLint xoffset,
330 GLsizei width,
331 GLenum format, GLenum type,
332 const GLvoid *pixels);
333
334 void GLAPIENTRY
335 _mesa_TextureSubImage2D_no_error(GLuint texture, GLint level, GLint xoffset,
336 GLint yoffset, GLsizei width, GLsizei height,
337 GLenum format, GLenum type,
338 const GLvoid *pixels);
339
340 extern void GLAPIENTRY
341 _mesa_TextureSubImage2D(GLuint texture, GLint level,
342 GLint xoffset, GLint yoffset,
343 GLsizei width, GLsizei height,
344 GLenum format, GLenum type,
345 const GLvoid *pixels);
346
347 void GLAPIENTRY
348 _mesa_TextureSubImage3D_no_error(GLuint texture, GLint level, GLint xoffset,
349 GLint yoffset, GLint zoffset, GLsizei width,
350 GLsizei height, GLsizei depth, GLenum format,
351 GLenum type, const GLvoid *pixels);
352
353 extern void GLAPIENTRY
354 _mesa_TextureSubImage3D(GLuint texture, GLint level,
355 GLint xoffset, GLint yoffset, GLint zoffset,
356 GLsizei width, GLsizei height, GLsizei depth,
357 GLenum format, GLenum type,
358 const GLvoid *pixels);
359
360
361 extern void GLAPIENTRY
362 _mesa_CopyTexImage1D(GLenum target, GLint level, GLenum internalformat,
363 GLint x, GLint y, GLsizei width, GLint border);
364
365
366 extern void GLAPIENTRY
367 _mesa_CopyTexImage2D( GLenum target, GLint level,
368 GLenum internalformat, GLint x, GLint y,
369 GLsizei width, GLsizei height, GLint border );
370
371
372 extern void GLAPIENTRY
373 _mesa_CopyTexImage1D_no_error(GLenum target, GLint level, GLenum internalformat,
374 GLint x, GLint y, GLsizei width, GLint border);
375
376
377 extern void GLAPIENTRY
378 _mesa_CopyTexImage2D_no_error(GLenum target, GLint level, GLenum internalformat,
379 GLint x, GLint y, GLsizei width, GLsizei height,
380 GLint border );
381
382
383 extern void GLAPIENTRY
384 _mesa_CopyTexSubImage1D( GLenum target, GLint level, GLint xoffset,
385 GLint x, GLint y, GLsizei width );
386
387
388 extern void GLAPIENTRY
389 _mesa_CopyTexSubImage2D( GLenum target, GLint level,
390 GLint xoffset, GLint yoffset,
391 GLint x, GLint y, GLsizei width, GLsizei height );
392
393
394 extern void GLAPIENTRY
395 _mesa_CopyTexSubImage3D( GLenum target, GLint level,
396 GLint xoffset, GLint yoffset, GLint zoffset,
397 GLint x, GLint y, GLsizei width, GLsizei height );
398
399 extern void GLAPIENTRY
400 _mesa_CopyTextureSubImage1D(GLuint texture, GLint level,
401 GLint xoffset, GLint x, GLint y, GLsizei width);
402
403 extern void GLAPIENTRY
404 _mesa_CopyTextureSubImage2D(GLuint texture, GLint level,
405 GLint xoffset, GLint yoffset,
406 GLint x, GLint y,
407 GLsizei width, GLsizei height);
408
409 extern void GLAPIENTRY
410 _mesa_CopyTextureSubImage3D(GLuint texture, GLint level,
411 GLint xoffset, GLint yoffset, GLint zoffset,
412 GLint x, GLint y,
413 GLsizei width, GLsizei height);
414
415 extern void GLAPIENTRY
416 _mesa_CopyTexSubImage1D_no_error(GLenum target, GLint level, GLint xoffset,
417 GLint x, GLint y, GLsizei width );
418
419 extern void GLAPIENTRY
420 _mesa_CopyTexSubImage2D_no_error(GLenum target, GLint level, GLint xoffset,
421 GLint yoffset, GLint x, GLint y, GLsizei width,
422 GLsizei height);
423
424 extern void GLAPIENTRY
425 _mesa_CopyTexSubImage3D_no_error(GLenum target, GLint level, GLint xoffset,
426 GLint yoffset, GLint zoffset, GLint x, GLint y,
427 GLsizei width, GLsizei height);
428
429 extern void GLAPIENTRY
430 _mesa_CopyTextureSubImage1D_no_error(GLuint texture, GLint level, GLint xoffset,
431 GLint x, GLint y, GLsizei width);
432
433 extern void GLAPIENTRY
434 _mesa_CopyTextureSubImage2D_no_error(GLuint texture, GLint level, GLint xoffset,
435 GLint yoffset, GLint x, GLint y,
436 GLsizei width, GLsizei height);
437
438 extern void GLAPIENTRY
439 _mesa_CopyTextureSubImage3D_no_error(GLuint texture, GLint level, GLint xoffset,
440 GLint yoffset, GLint zoffset, GLint x,
441 GLint y, GLsizei width, GLsizei height);
442
443 extern void GLAPIENTRY
444 _mesa_ClearTexSubImage( GLuint texture, GLint level,
445 GLint xoffset, GLint yoffset, GLint zoffset,
446 GLsizei width, GLsizei height, GLsizei depth,
447 GLenum format, GLenum type, const void *data );
448
449 extern void GLAPIENTRY
450 _mesa_ClearTexImage( GLuint texture, GLint level,
451 GLenum format, GLenum type, const void *data );
452
453 extern void GLAPIENTRY
454 _mesa_CompressedTexImage1D(GLenum target, GLint level,
455 GLenum internalformat, GLsizei width,
456 GLint border, GLsizei imageSize,
457 const GLvoid *data);
458
459 extern void GLAPIENTRY
460 _mesa_CompressedTexImage2D(GLenum target, GLint level,
461 GLenum internalformat, GLsizei width,
462 GLsizei height, GLint border, GLsizei imageSize,
463 const GLvoid *data);
464
465 extern void GLAPIENTRY
466 _mesa_CompressedTexImage3D(GLenum target, GLint level,
467 GLenum internalformat, GLsizei width,
468 GLsizei height, GLsizei depth, GLint border,
469 GLsizei imageSize, const GLvoid *data);
470
471 extern void GLAPIENTRY
472 _mesa_CompressedTexImage1D_no_error(GLenum target, GLint level,
473 GLenum internalformat, GLsizei width,
474 GLint border, GLsizei imageSize,
475 const GLvoid *data);
476
477 extern void GLAPIENTRY
478 _mesa_CompressedTexImage2D_no_error(GLenum target, GLint level,
479 GLenum internalformat, GLsizei width,
480 GLsizei height, GLint border,
481 GLsizei imageSize, const GLvoid *data);
482
483 extern void GLAPIENTRY
484 _mesa_CompressedTexImage3D_no_error(GLenum target, GLint level,
485 GLenum internalformat, GLsizei width,
486 GLsizei height, GLsizei depth, GLint border,
487 GLsizei imageSize, const GLvoid *data);
488
489
490 extern void GLAPIENTRY
491 _mesa_CompressedTexSubImage1D_no_error(GLenum target, GLint level,
492 GLint xoffset, GLsizei width,
493 GLenum format, GLsizei imageSize,
494 const GLvoid *data);
495 extern void GLAPIENTRY
496 _mesa_CompressedTexSubImage1D(GLenum target, GLint level, GLint xoffset,
497 GLsizei width, GLenum format,
498 GLsizei imageSize, const GLvoid *data);
499
500 extern void GLAPIENTRY
501 _mesa_CompressedTextureSubImage1D_no_error(GLuint texture, GLint level,
502 GLint xoffset, GLsizei width,
503 GLenum format, GLsizei imageSize,
504 const GLvoid *data);
505 extern void GLAPIENTRY
506 _mesa_CompressedTextureSubImage1D(GLuint texture, GLint level, GLint xoffset,
507 GLsizei width, GLenum format,
508 GLsizei imageSize, const GLvoid *data);
509
510 extern void GLAPIENTRY
511 _mesa_CompressedTexSubImage2D_no_error(GLenum target, GLint level,
512 GLint xoffset, GLint yoffset,
513 GLsizei width, GLsizei height,
514 GLenum format, GLsizei imageSize,
515 const GLvoid *data);
516 extern void GLAPIENTRY
517 _mesa_CompressedTexSubImage2D(GLenum target, GLint level, GLint xoffset,
518 GLint yoffset, GLsizei width, GLsizei height,
519 GLenum format, GLsizei imageSize,
520 const GLvoid *data);
521
522 extern void GLAPIENTRY
523 _mesa_CompressedTextureSubImage2D_no_error(GLuint texture, GLint level,
524 GLint xoffset, GLint yoffset,
525 GLsizei width, GLsizei height,
526 GLenum format, GLsizei imageSize,
527 const GLvoid *data);
528 extern void GLAPIENTRY
529 _mesa_CompressedTextureSubImage2D(GLuint texture, GLint level, GLint xoffset,
530 GLint yoffset,
531 GLsizei width, GLsizei height,
532 GLenum format, GLsizei imageSize,
533 const GLvoid *data);
534
535 extern void GLAPIENTRY
536 _mesa_CompressedTexSubImage3D_no_error(GLenum target, GLint level,
537 GLint xoffset, GLint yoffset,
538 GLint zoffset, GLsizei width,
539 GLsizei height, GLsizei depth,
540 GLenum format, GLsizei imageSize,
541 const GLvoid *data);
542 extern void GLAPIENTRY
543 _mesa_CompressedTexSubImage3D(GLenum target, GLint level, GLint xoffset,
544 GLint yoffset, GLint zoffset, GLsizei width,
545 GLsizei height, GLsizei depth, GLenum format,
546 GLsizei imageSize, const GLvoid *data);
547
548 extern void GLAPIENTRY
549 _mesa_CompressedTextureSubImage3D_no_error(GLuint texture, GLint level,
550 GLint xoffset, GLint yoffset,
551 GLint zoffset, GLsizei width,
552 GLsizei height, GLsizei depth,
553 GLenum format, GLsizei imageSize,
554 const GLvoid *data);
555 extern void GLAPIENTRY
556 _mesa_CompressedTextureSubImage3D(GLuint texture, GLint level, GLint xoffset,
557 GLint yoffset, GLint zoffset,
558 GLsizei width, GLsizei height,
559 GLsizei depth,
560 GLenum format, GLsizei imageSize,
561 const GLvoid *data);
562
563 extern void GLAPIENTRY
564 _mesa_TexBuffer(GLenum target, GLenum internalFormat, GLuint buffer);
565
566 extern void GLAPIENTRY
567 _mesa_TexBufferRange(GLenum target, GLenum internalFormat, GLuint buffer,
568 GLintptr offset, GLsizeiptr size);
569
570 extern void GLAPIENTRY
571 _mesa_TextureBuffer(GLuint texture, GLenum internalFormat, GLuint buffer);
572
573 extern void GLAPIENTRY
574 _mesa_TextureBufferRange(GLuint texture, GLenum internalFormat, GLuint buffer,
575 GLintptr offset, GLsizeiptr size);
576
577
578 extern void GLAPIENTRY
579 _mesa_TexImage2DMultisample(GLenum target, GLsizei samples,
580 GLenum internalformat, GLsizei width,
581 GLsizei height, GLboolean fixedsamplelocations);
582
583 extern void GLAPIENTRY
584 _mesa_TexImage3DMultisample(GLenum target, GLsizei samples,
585 GLenum internalformat, GLsizei width,
586 GLsizei height, GLsizei depth,
587 GLboolean fixedsamplelocations);
588
589 extern void GLAPIENTRY
590 _mesa_TexStorage2DMultisample(GLenum target, GLsizei samples,
591 GLenum internalformat, GLsizei width,
592 GLsizei height, GLboolean fixedsamplelocations);
593
594 extern void GLAPIENTRY
595 _mesa_TexStorage3DMultisample(GLenum target, GLsizei samples,
596 GLenum internalformat, GLsizei width,
597 GLsizei height, GLsizei depth,
598 GLboolean fixedsamplelocations);
599
600 void GLAPIENTRY
601 _mesa_TextureStorage2DMultisample(GLuint texture, GLsizei samples,
602 GLenum internalformat, GLsizei width,
603 GLsizei height,
604 GLboolean fixedsamplelocations);
605
606 void GLAPIENTRY
607 _mesa_TextureStorage3DMultisample(GLuint texture, GLsizei samples,
608 GLenum internalformat, GLsizei width,
609 GLsizei height, GLsizei depth,
610 GLboolean fixedsamplelocations);
611 /*@}*/
612
613 #ifdef __cplusplus
614 }
615 #endif
616
617 #endif