2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2005 Brian Paul All Rights Reserved.
6 * Copyright (C) 2009 VMware, Inc. All Rights Reserved.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35 #include "pixelstore.h"
41 tex_target_name(GLenum tgt)
47 { GL_TEXTURE_1D, "GL_TEXTURE_1D" },
48 { GL_TEXTURE_2D, "GL_TEXTURE_2D" },
49 { GL_TEXTURE_3D, "GL_TEXTURE_3D" },
50 { GL_TEXTURE_CUBE_MAP, "GL_TEXTURE_CUBE_MAP" },
51 { GL_TEXTURE_RECTANGLE, "GL_TEXTURE_RECTANGLE" },
52 { GL_TEXTURE_1D_ARRAY_EXT, "GL_TEXTURE_1D_ARRAY" },
53 { GL_TEXTURE_2D_ARRAY_EXT, "GL_TEXTURE_2D_ARRAY" },
54 { GL_TEXTURE_EXTERNAL_OES, "GL_TEXTURE_EXTERNAL_OES" }
57 for (i = 0; i < Elements(tex_targets); i++) {
58 if (tex_targets[i].target == tgt)
59 return tex_targets[i].name;
61 return "UNKNOWN TEX TARGET";
66 _mesa_print_state( const char *msg, GLuint state )
69 "%s: (0x%x) %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
72 (state & _NEW_MODELVIEW) ? "ctx->ModelView, " : "",
73 (state & _NEW_PROJECTION) ? "ctx->Projection, " : "",
74 (state & _NEW_TEXTURE_MATRIX) ? "ctx->TextureMatrix, " : "",
75 (state & _NEW_COLOR) ? "ctx->Color, " : "",
76 (state & _NEW_DEPTH) ? "ctx->Depth, " : "",
77 (state & _NEW_EVAL) ? "ctx->Eval/EvalMap, " : "",
78 (state & _NEW_FOG) ? "ctx->Fog, " : "",
79 (state & _NEW_HINT) ? "ctx->Hint, " : "",
80 (state & _NEW_LIGHT) ? "ctx->Light, " : "",
81 (state & _NEW_LINE) ? "ctx->Line, " : "",
82 (state & _NEW_PIXEL) ? "ctx->Pixel, " : "",
83 (state & _NEW_POINT) ? "ctx->Point, " : "",
84 (state & _NEW_POLYGON) ? "ctx->Polygon, " : "",
85 (state & _NEW_POLYGONSTIPPLE) ? "ctx->PolygonStipple, " : "",
86 (state & _NEW_SCISSOR) ? "ctx->Scissor, " : "",
87 (state & _NEW_STENCIL) ? "ctx->Stencil, " : "",
88 (state & _NEW_TEXTURE) ? "ctx->Texture, " : "",
89 (state & _NEW_TRANSFORM) ? "ctx->Transform, " : "",
90 (state & _NEW_VIEWPORT) ? "ctx->Viewport, " : "",
91 (state & _NEW_ARRAY) ? "ctx->Array, " : "",
92 (state & _NEW_RENDERMODE) ? "ctx->RenderMode, " : "",
93 (state & _NEW_BUFFERS) ? "ctx->Visual, ctx->DrawBuffer,, " : "");
99 * Print information about this Mesa version and build options.
101 void _mesa_print_info( void )
103 _mesa_debug(NULL, "Mesa GL_VERSION = %s\n",
104 (char *) _mesa_GetString(GL_VERSION));
105 _mesa_debug(NULL, "Mesa GL_RENDERER = %s\n",
106 (char *) _mesa_GetString(GL_RENDERER));
107 _mesa_debug(NULL, "Mesa GL_VENDOR = %s\n",
108 (char *) _mesa_GetString(GL_VENDOR));
109 _mesa_debug(NULL, "Mesa GL_EXTENSIONS = %s\n",
110 (char *) _mesa_GetString(GL_EXTENSIONS));
112 _mesa_debug(NULL, "Mesa thread-safe: YES\n");
114 _mesa_debug(NULL, "Mesa thread-safe: NO\n");
116 #if defined(USE_X86_ASM)
117 _mesa_debug(NULL, "Mesa x86-optimized: YES\n");
119 _mesa_debug(NULL, "Mesa x86-optimized: NO\n");
121 #if defined(USE_SPARC_ASM)
122 _mesa_debug(NULL, "Mesa sparc-optimized: YES\n");
124 _mesa_debug(NULL, "Mesa sparc-optimized: NO\n");
130 * Set verbose logging flags. When these flags are set, GL API calls
131 * in the various categories will be printed to stderr.
132 * \param str a comma-separated list of keywords
135 set_verbose_flags(const char *str)
142 static const struct option opts[] = {
143 { "varray", VERBOSE_VARRAY },
144 { "tex", VERBOSE_TEXTURE },
145 { "mat", VERBOSE_MATERIAL },
146 { "pipe", VERBOSE_PIPELINE },
147 { "driver", VERBOSE_DRIVER },
148 { "state", VERBOSE_STATE },
149 { "api", VERBOSE_API },
150 { "list", VERBOSE_DISPLAY_LIST },
151 { "lighting", VERBOSE_LIGHTING },
152 { "disassem", VERBOSE_DISASSEM },
153 { "draw", VERBOSE_DRAW },
154 { "swap", VERBOSE_SWAPBUFFERS }
162 for (i = 0; i < Elements(opts); i++) {
163 if (strstr(str, opts[i].name) || strcmp(str, "all") == 0)
164 MESA_VERBOSE |= opts[i].flag;
171 * Set debugging flags. When these flags are set, Mesa will do additional
172 * debug checks or actions.
173 * \param str a comma-separated list of keywords
176 set_debug_flags(const char *str)
183 static const struct option opts[] = {
184 { "silent", DEBUG_SILENT }, /* turn off debug messages */
185 { "flush", DEBUG_ALWAYS_FLUSH }, /* flush after each drawing command */
186 { "incomplete_tex", DEBUG_INCOMPLETE_TEXTURE },
187 { "incomplete_fbo", DEBUG_INCOMPLETE_FBO }
194 MESA_DEBUG_FLAGS = 0x0;
195 for (i = 0; i < Elements(opts); i++) {
196 if (strstr(str, opts[i].name))
197 MESA_DEBUG_FLAGS |= opts[i].flag;
204 * Initialize debugging variables from env vars.
207 _mesa_init_debug( struct gl_context *ctx )
209 set_debug_flags(_mesa_getenv("MESA_DEBUG"));
210 set_verbose_flags(_mesa_getenv("MESA_VERBOSE"));
218 write_ppm(const char *filename, const GLubyte *buffer, int width, int height,
219 int comps, int rcomp, int gcomp, int bcomp, GLboolean invert)
221 FILE *f = fopen( filename, "w" );
224 const GLubyte *ptr = buffer;
226 fprintf(f,"# ppm-file created by osdemo.c\n");
227 fprintf(f,"%i %i\n", width,height);
230 f = fopen( filename, "ab" ); /* reopen in binary append mode */
231 for (y=0; y < height; y++) {
232 for (x = 0; x < width; x++) {
233 int yy = invert ? (height - 1 - y) : y;
234 int i = (yy * width + x) * comps;
235 fputc(ptr[i+rcomp], f); /* write red */
236 fputc(ptr[i+gcomp], f); /* write green */
237 fputc(ptr[i+bcomp], f); /* write blue */
243 fprintf(stderr, "Unable to create %s in write_ppm()\n", filename);
249 * Write a texture image to a ppm file.
250 * \param face cube face in [0,5]
251 * \param level mipmap level
254 write_texture_image(struct gl_texture_object *texObj,
255 GLuint face, GLuint level)
257 struct gl_texture_image *img = texObj->Image[face][level];
259 GET_CURRENT_CONTEXT(ctx);
260 struct gl_pixelstore_attrib store;
264 buffer = malloc(img->Width * img->Height
267 store = ctx->Pack; /* save */
268 ctx->Pack = ctx->DefaultPacking;
270 ctx->Driver.GetTexImage(ctx, GL_RGBA, GL_UNSIGNED_BYTE, buffer, img);
273 _mesa_snprintf(s, sizeof(s), "/tmp/tex%u.l%u.f%u.ppm", texObj->Name, level, face);
275 printf(" Writing image level %u to %s\n", level, s);
276 write_ppm(s, buffer, img->Width, img->Height, 4, 0, 1, 2, GL_FALSE);
278 ctx->Pack = store; /* restore */
286 * Write renderbuffer image to a ppm file.
289 _mesa_write_renderbuffer_image(const struct gl_renderbuffer *rb)
291 GET_CURRENT_CONTEXT(ctx);
296 if (rb->_BaseFormat == GL_RGB ||
297 rb->_BaseFormat == GL_RGBA) {
299 type = GL_UNSIGNED_BYTE;
301 else if (rb->_BaseFormat == GL_DEPTH_STENCIL) {
302 format = GL_DEPTH_STENCIL;
303 type = GL_UNSIGNED_INT_24_8;
307 "Unsupported BaseFormat 0x%x in "
308 "_mesa_write_renderbuffer_image()\n",
313 buffer = malloc(rb->Width * rb->Height * 4);
315 ctx->Driver.ReadPixels(ctx, 0, 0, rb->Width, rb->Height,
316 format, type, &ctx->DefaultPacking, buffer);
319 _mesa_snprintf(s, sizeof(s), "/tmp/renderbuffer%u.ppm", rb->Name);
320 _mesa_snprintf(s, sizeof(s), "C:\\renderbuffer%u.ppm", rb->Name);
322 printf(" Writing renderbuffer image to %s\n", s);
324 _mesa_debug(NULL, " Writing renderbuffer image to %s\n", s);
326 write_ppm(s, buffer, rb->Width, rb->Height, 4, 0, 1, 2, GL_TRUE);
332 /** How many texture images (mipmap levels, faces) to write to files */
337 static GLuint WriteImages;
341 dump_texture(struct gl_texture_object *texObj, GLuint writeImages)
343 const GLuint numFaces = texObj->Target == GL_TEXTURE_CUBE_MAP ? 6 : 1;
344 GLboolean written = GL_FALSE;
347 printf("Texture %u\n", texObj->Name);
348 printf(" Target %s\n", tex_target_name(texObj->Target));
349 for (i = 0; i < MAX_TEXTURE_LEVELS; i++) {
350 for (j = 0; j < numFaces; j++) {
351 struct gl_texture_image *texImg = texObj->Image[j][i];
353 printf(" Face %u level %u: %d x %d x %d, format %s\n",
355 texImg->Width, texImg->Height, texImg->Depth,
356 _mesa_get_format_name(texImg->TexFormat));
357 if (writeImages == WRITE_ALL ||
358 (writeImages == WRITE_ONE && !written)) {
359 write_texture_image(texObj, j, i);
369 * Dump a single texture.
372 _mesa_dump_texture(GLuint texture, GLuint writeImages)
374 GET_CURRENT_CONTEXT(ctx);
375 struct gl_texture_object *texObj = _mesa_lookup_texture(ctx, texture);
377 dump_texture(texObj, writeImages);
383 dump_texture_cb(GLuint id, void *data, void *userData)
385 struct gl_texture_object *texObj = (struct gl_texture_object *) data;
387 dump_texture(texObj, WriteImages);
392 * Print basic info about all texture objext to stdout.
393 * If dumpImages is true, write PPM of level[0] image to a file.
396 _mesa_dump_textures(GLuint writeImages)
398 GET_CURRENT_CONTEXT(ctx);
399 WriteImages = writeImages;
400 _mesa_HashWalk(ctx->Shared->TexObjects, dump_texture_cb, ctx);
405 dump_renderbuffer(const struct gl_renderbuffer *rb, GLboolean writeImage)
407 printf("Renderbuffer %u: %u x %u IntFormat = %s\n",
408 rb->Name, rb->Width, rb->Height,
409 _mesa_lookup_enum_by_nr(rb->InternalFormat));
411 _mesa_write_renderbuffer_image(rb);
417 dump_renderbuffer_cb(GLuint id, void *data, void *userData)
419 const struct gl_renderbuffer *rb = (const struct gl_renderbuffer *) data;
421 dump_renderbuffer(rb, WriteImages);
426 * Print basic info about all renderbuffers to stdout.
427 * If dumpImages is true, write PPM of level[0] image to a file.
430 _mesa_dump_renderbuffers(GLboolean writeImages)
432 GET_CURRENT_CONTEXT(ctx);
433 WriteImages = writeImages;
434 _mesa_HashWalk(ctx->Shared->RenderBuffers, dump_renderbuffer_cb, ctx);
440 _mesa_dump_color_buffer(const char *filename)
442 GET_CURRENT_CONTEXT(ctx);
443 const GLuint w = ctx->DrawBuffer->Width;
444 const GLuint h = ctx->DrawBuffer->Height;
447 buf = malloc(w * h * 4);
449 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
450 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
451 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
453 _mesa_ReadPixels(0, 0, w, h, GL_RGBA, GL_UNSIGNED_BYTE, buf);
455 printf("ReadBuffer %p 0x%x DrawBuffer %p 0x%x\n",
456 (void *) ctx->ReadBuffer->_ColorReadBuffer,
457 ctx->ReadBuffer->ColorReadBuffer,
458 (void *) ctx->DrawBuffer->_ColorDrawBuffers[0],
459 ctx->DrawBuffer->ColorDrawBuffer[0]);
460 printf("Writing %d x %d color buffer to %s\n", w, h, filename);
461 write_ppm(filename, buf, w, h, 4, 0, 1, 2, GL_TRUE);
463 _mesa_PopClientAttrib();
470 _mesa_dump_depth_buffer(const char *filename)
472 GET_CURRENT_CONTEXT(ctx);
473 const GLuint w = ctx->DrawBuffer->Width;
474 const GLuint h = ctx->DrawBuffer->Height;
479 buf = malloc(w * h * 4); /* 4 bpp */
480 buf2 = malloc(w * h * 3); /* 3 bpp */
482 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
483 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
484 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
486 _mesa_ReadPixels(0, 0, w, h, GL_DEPTH_COMPONENT, GL_UNSIGNED_INT, buf);
488 /* spread 24 bits of Z across R, G, B */
489 for (i = 0; i < w * h; i++) {
490 buf2[i*3+0] = (buf[i] >> 24) & 0xff;
491 buf2[i*3+1] = (buf[i] >> 16) & 0xff;
492 buf2[i*3+2] = (buf[i] >> 8) & 0xff;
495 printf("Writing %d x %d depth buffer to %s\n", w, h, filename);
496 write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
498 _mesa_PopClientAttrib();
506 _mesa_dump_stencil_buffer(const char *filename)
508 GET_CURRENT_CONTEXT(ctx);
509 const GLuint w = ctx->DrawBuffer->Width;
510 const GLuint h = ctx->DrawBuffer->Height;
515 buf = malloc(w * h); /* 1 bpp */
516 buf2 = malloc(w * h * 3); /* 3 bpp */
518 _mesa_PushClientAttrib(GL_CLIENT_PIXEL_STORE_BIT);
519 _mesa_PixelStorei(GL_PACK_ALIGNMENT, 1);
520 _mesa_PixelStorei(GL_PACK_INVERT_MESA, GL_TRUE);
522 _mesa_ReadPixels(0, 0, w, h, GL_STENCIL_INDEX, GL_UNSIGNED_BYTE, buf);
524 for (i = 0; i < w * h; i++) {
525 buf2[i*3+0] = buf[i];
526 buf2[i*3+1] = (buf[i] & 127) * 2;
527 buf2[i*3+2] = (buf[i] - 128) * 2;
530 printf("Writing %d x %d stencil buffer to %s\n", w, h, filename);
531 write_ppm(filename, buf2, w, h, 3, 0, 1, 2, GL_TRUE);
533 _mesa_PopClientAttrib();
541 _mesa_dump_image(const char *filename, const void *image, GLuint w, GLuint h,
542 GLenum format, GLenum type)
544 GLboolean invert = GL_TRUE;
546 if (format == GL_RGBA && type == GL_UNSIGNED_BYTE) {
547 write_ppm(filename, image, w, h, 4, 0, 1, 2, invert);
549 else if (format == GL_BGRA && type == GL_UNSIGNED_BYTE) {
550 write_ppm(filename, image, w, h, 4, 2, 1, 0, invert);
552 else if (format == GL_LUMINANCE_ALPHA && type == GL_UNSIGNED_BYTE) {
553 write_ppm(filename, image, w, h, 2, 1, 0, 0, invert);
555 else if (format == GL_RED && type == GL_UNSIGNED_BYTE) {
556 write_ppm(filename, image, w, h, 1, 0, 0, 0, invert);
558 else if (format == GL_RGBA && type == GL_FLOAT) {
559 /* convert floats to ubyte */
560 GLubyte *buf = malloc(w * h * 4 * sizeof(GLubyte));
561 const GLfloat *f = (const GLfloat *) image;
563 for (i = 0; i < w * h * 4; i++) {
564 UNCLAMPED_FLOAT_TO_UBYTE(buf[i], f[i]);
566 write_ppm(filename, buf, w, h, 4, 0, 1, 2, invert);
569 else if (format == GL_RED && type == GL_FLOAT) {
570 /* convert floats to ubyte */
571 GLubyte *buf = malloc(w * h * sizeof(GLubyte));
572 const GLfloat *f = (const GLfloat *) image;
574 for (i = 0; i < w * h; i++) {
575 UNCLAMPED_FLOAT_TO_UBYTE(buf[i], f[i]);
577 write_ppm(filename, buf, w, h, 1, 0, 0, 0, invert);
582 "Unsupported format 0x%x / type 0x%x in _mesa_dump_image()",
589 * Quick and dirty function to "print" a texture to stdout.
592 _mesa_print_texture(struct gl_context *ctx, struct gl_texture_image *img)
594 const GLint slice = 0;
599 ctx->Driver.MapTextureImage(ctx, img, slice,
600 0, 0, img->Width, img->Height, GL_MAP_READ_BIT,
601 &data, &srcRowStride);
604 printf("No texture data\n");
607 /* XXX add more formats or make into a new format utility function */
608 switch (img->TexFormat) {
614 case MESA_FORMAT_AL88:
615 case MESA_FORMAT_AL88_REV:
618 case MESA_FORMAT_RGB888:
619 case MESA_FORMAT_BGR888:
622 case MESA_FORMAT_RGBA8888:
623 case MESA_FORMAT_ARGB8888:
627 _mesa_problem(NULL, "error in PrintTexture\n");
631 for (i = 0; i < img->Height; i++) {
632 for (j = 0; j < img->Width; j++) {
634 printf("%02x ", data[0]);
636 printf("%02x%02x ", data[0], data[1]);
638 printf("%02x%02x%02x ", data[0], data[1], data[2]);
640 printf("%02x%02x%02x%02x ", data[0], data[1], data[2], data[3]);
641 data += (srcRowStride - img->Width) * c;
643 /* XXX use img->ImageStride here */
649 ctx->Driver.UnmapTextureImage(ctx, img, slice);