summaryrefslogtreecommitdiff
path: root/src/gallium/include
diff options
context:
space:
mode:
authorJosé Fonseca <jrfonseca@tungstengraphics.com>2008-03-08 16:29:12 +0000
committerJosé Fonseca <jrfonseca@tungstengraphics.com>2008-03-08 17:36:19 +0000
commitfc96aec9b7aceb4a0e7471e797abe8a00fc40cf2 (patch)
tree800c34075990ee18ee83728141b0deeb81d2f36f /src/gallium/include
parent8143adafddabb6ac3a21c18927ae41425f26bfff (diff)
gallium: Document debug_printf usage.
Diffstat (limited to 'src/gallium/include')
-rw-r--r--src/gallium/include/pipe/p_debug.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/gallium/include/pipe/p_debug.h b/src/gallium/include/pipe/p_debug.h
index 2a11627b36..a14a1fc5f6 100644
--- a/src/gallium/include/pipe/p_debug.h
+++ b/src/gallium/include/pipe/p_debug.h
@@ -58,8 +58,22 @@ extern "C" {
#endif
+/**
+ * Print debug messages.
+ *
+ * A debug message will be printed regardless of the DEBUG/NDEBUG macros.
+ *
+ * The actual channel used to output debug message is platform specific. To
+ * avoid misformating or truncation, follow these rules of thumb:
+ * - output whole lines
+ * - avoid outputing large strings (512 bytes is the current maximum length
+ * that is guaranteed to be printed in all platforms)
+ */
void debug_printf(const char *format, ...);
+/**
+ * @sa debug_printf
+ */
void debug_vprintf(const char *format, va_list ap);
void debug_assert_fail(const char *expr, const char *file, unsigned line);