src/gallium/auxiliary/util/u_dump.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2009 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  * Dump data in human/machine readable format.
  31  *
  32  * @author Jose Fonseca <jfonseca@vmware.com>
  33  */
  34
  35 #ifndef U_DEBUG_DUMP_H_
  36 #define U_DEBUG_DUMP_H_
  37
  38
  39 #include "pipe/p_compiler.h"
  40 #include "pipe/p_state.h"
  41
  42
  43 #ifdef  __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 #define UTIL_DUMP_INVALID_NAME "<invalid>"
  49
  50
  51 struct os_stream;
  52
  53
  54 /* Duplicated here for convenience */
  55 extern struct os_stream *
  56 os_log_stream;
  57
  58
  59 /*
  60  * p_defines.h
  61  *
  62  * XXX: These functions don't really dump anything -- just translate into
  63  * strings so a verb better than "dump" should be used instead, in order to
  64  * free up the namespace to the true dumper functions.
  65  */
  66
  67 const char *
  68 util_dump_blend_factor(unsigned value, boolean shortened);
  69
  70 const char *
  71 util_dump_blend_func(unsigned value, boolean shortened);
  72
  73 const char *
  74 util_dump_logicop(unsigned value, boolean shortened);
  75
  76 const char *
  77 util_dump_func(unsigned value, boolean shortened);
  78
  79 const char *
  80 util_dump_stencil_op(unsigned value, boolean shortened);
  81
  82 const char *
  83 util_dump_tex_target(unsigned value, boolean shortened);
  84
  85 const char *
  86 util_dump_tex_wrap(unsigned value, boolean shortened);
  87
  88 const char *
  89 util_dump_tex_mipfilter(unsigned value, boolean shortened);
  90
  91 const char *
  92 util_dump_tex_filter(unsigned value, boolean shortened);
  93
  94
  95 /*
  96  * p_state.h, through an os_stream
  97  */
  98
  99 void
 100 util_dump_template(struct os_stream *stream,
 101                    const struct pipe_resource *templat);
 102
 103 void
 104 util_dump_rasterizer_state(struct os_stream *stream,
 105                            const struct pipe_rasterizer_state *state);
 106
 107 void
 108 util_dump_poly_stipple(struct os_stream *stream,
 109                        const struct pipe_poly_stipple *state);
 110
 111 void
 112 util_dump_viewport_state(struct os_stream *stream,
 113                          const struct pipe_viewport_state *state);
 114
 115 void
 116 util_dump_scissor_state(struct os_stream *stream,
 117                         const struct pipe_scissor_state *state);
 118
 119 void
 120 util_dump_clip_state(struct os_stream *stream,
 121                      const struct pipe_clip_state *state);
 122
 123 void
 124 util_dump_shader_state(struct os_stream *stream,
 125                        const struct pipe_shader_state *state);
 126
 127 void
 128 util_dump_depth_stencil_alpha_state(struct os_stream *stream,
 129                                     const struct pipe_depth_stencil_alpha_state *state);
 130
 131 void
 132 util_dump_rt_blend_state(struct os_stream *stream,
 133                          const struct pipe_rt_blend_state *state);
 134
 135 void
 136 util_dump_blend_state(struct os_stream *stream,
 137                       const struct pipe_blend_state *state);
 138
 139 void
 140 util_dump_blend_color(struct os_stream *stream,
 141                       const struct pipe_blend_color *state);
 142
 143 void
 144 util_dump_stencil_ref(struct os_stream *stream,
 145                       const struct pipe_stencil_ref *state);
 146
 147 void
 148 util_dump_framebuffer_state(struct os_stream *stream,
 149                             const struct pipe_framebuffer_state *state);
 150
 151 void
 152 util_dump_sampler_state(struct os_stream *stream,
 153                         const struct pipe_sampler_state *state);
 154
 155 void
 156 util_dump_surface(struct os_stream *stream,
 157                   const struct pipe_surface *state);
 158
 159 void
 160 util_dump_transfer(struct os_stream *stream,
 161                    const struct pipe_transfer *state);
 162
 163 void
 164 util_dump_vertex_buffer(struct os_stream *stream,
 165                         const struct pipe_vertex_buffer *state);
 166
 167 void
 168 util_dump_vertex_element(struct os_stream *stream,
 169                          const struct pipe_vertex_element *state);
 170
 171
 172 /* FIXME: Move the other debug_dump_xxx functions out of u_debug.h into here. */
 173
 174
 175 #ifdef  __cplusplus
 176 }
 177 #endif
 178
 179 #endif /* U_DEBUG_H_ */