src/mesa/main/errors.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   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 "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \file errors.h
  28  * Mesa debugging and error handling functions.
  29  *
  30  * This file provides functions to record errors, warnings, and miscellaneous
  31  * debug information.
  32  */
  33
  34
  35 #ifndef ERRORS_H
  36 #define ERRORS_H
  37
  38
  39 #include <stdio.h>
  40 #include <stdarg.h>
  41 #include "compiler.h"
  42 #include "glheader.h"
  43 #include "mtypes.h"
  44
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 struct _glapi_table;
  51
  52 extern void
  53 _mesa_init_errors( struct gl_context *ctx );
  54
  55 extern void
  56 _mesa_free_errors_data( struct gl_context *ctx );
  57
  58 extern void
  59 _mesa_warning( struct gl_context *gc, const char *fmtString, ... ) PRINTFLIKE(2, 3);
  60
  61 extern void
  62 _mesa_problem( const struct gl_context *ctx, const char *fmtString, ... ) PRINTFLIKE(2, 3);
  63
  64 extern void
  65 _mesa_error( struct gl_context *ctx, GLenum error, const char *fmtString, ... ) PRINTFLIKE(3, 4);
  66
  67 extern void
  68 _mesa_error_no_memory(const char *caller);
  69
  70 extern void
  71 _mesa_debug( const struct gl_context *ctx, const char *fmtString, ... ) PRINTFLIKE(2, 3);
  72
  73 extern void
  74 _mesa_log(const char *fmtString, ...) PRINTFLIKE(1, 2);
  75
  76 extern FILE *
  77 _mesa_get_log_file(void);
  78
  79 extern void
  80 _mesa_gl_vdebug(struct gl_context *ctx,
  81                 GLuint *id,
  82                 enum mesa_debug_source source,
  83                 enum mesa_debug_type type,
  84                 enum mesa_debug_severity severity,
  85                 const char *fmtString,
  86                 va_list args);
  87
  88 extern void
  89 _mesa_gl_debug(struct gl_context *ctx,
  90                GLuint *id,
  91                enum mesa_debug_source source,
  92                enum mesa_debug_type type,
  93                enum mesa_debug_severity severity,
  94                const char *fmtString, ...) PRINTFLIKE(6, 7);
  95
  96 #define _mesa_perf_debug(ctx, sev, ...) do {                              \
  97    static GLuint msg_id = 0;                                              \
  98    if (unlikely(ctx->Const.ContextFlags & GL_CONTEXT_FLAG_DEBUG_BIT)) {   \
  99       _mesa_gl_debug(ctx, &msg_id,                                        \
 100                      MESA_DEBUG_SOURCE_API,                               \
 101                      MESA_DEBUG_TYPE_PERFORMANCE,                         \
 102                      sev,                                                 \
 103                      __VA_ARGS__);                                        \
 104    }                                                                      \
 105 } while (0)
 106
 107 bool
 108 _mesa_set_debug_state_int(struct gl_context *ctx, GLenum pname, GLint val);
 109
 110 GLint
 111 _mesa_get_debug_state_int(struct gl_context *ctx, GLenum pname);
 112
 113 void *
 114 _mesa_get_debug_state_ptr(struct gl_context *ctx, GLenum pname);
 115
 116 extern void
 117 _mesa_shader_debug(struct gl_context *ctx, GLenum type, GLuint *id,
 118                    const char *msg);
 119
 120 void GLAPIENTRY
 121 _mesa_DebugMessageInsert(GLenum source, GLenum type, GLuint id,
 122                          GLenum severity, GLint length,
 123                          const GLchar* buf);
 124 GLuint GLAPIENTRY
 125 _mesa_GetDebugMessageLog(GLuint count, GLsizei logSize, GLenum* sources,
 126                          GLenum* types, GLenum* ids, GLenum* severities,
 127                          GLsizei* lengths, GLchar* messageLog);
 128 void GLAPIENTRY
 129 _mesa_DebugMessageControl(GLenum source, GLenum type, GLenum severity,
 130                           GLsizei count, const GLuint *ids,
 131                           GLboolean enabled);
 132 void GLAPIENTRY
 133 _mesa_DebugMessageCallback(GLDEBUGPROC callback,
 134                            const void *userParam);
 135 void GLAPIENTRY
 136 _mesa_PushDebugGroup(GLenum source, GLuint id, GLsizei length,
 137                      const GLchar *message);
 138 void GLAPIENTRY
 139 _mesa_PopDebugGroup(void);
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145
 146 #endif /* ERRORS_H */