src/mesa/glapi/glapi.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.3
   4  *
   5  * Copyright (C) 1999-2004  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \mainpage Mesa GL API Module
  28  *
  29  * \section GLAPIIntroduction Introduction
  30  *
  31  * The Mesa GL API module is responsible for dispatching all the
  32  * gl*() functions.  All GL functions are dispatched by jumping through
  33  * the current dispatch table (basically a struct full of function
  34  * pointers.)
  35  *
  36  * A per-thread current dispatch table and per-thread current context
  37  * pointer are managed by this module too.
  38  *
  39  * This module is intended to be non-Mesa-specific so it can be used
  40  * with the X/DRI libGL also.
  41  */
  42
  43
  44 #ifndef _GLAPI_H
  45 #define _GLAPI_H
  46
  47
  48 #include "GL/gl.h"
  49 #include "glapitable.h"
  50
  51 typedef void (*_glapi_warning_func)(void *ctx, const char *str, ...);
  52
  53 #if defined(USE_MGL_NAMESPACE)
  54 #define _glapi_set_dispatch _mglapi_set_dispatch
  55 #define _glapi_get_dispatch _mglapi_get_dispatch
  56 #define _glapi_set_context _mglapi_set_context
  57 #define _glapi_get_context _mglapi_get_context
  58 #define _glapi_Context _mglapi_Context
  59 #define _glapi_Dispatch _mglapi_Dispatch
  60 #endif
  61
  62 #if defined (GLX_USE_TLS)
  63
  64 const extern void *_glapi_Context;
  65 const extern struct _glapi_table *_glapi_Dispatch;
  66
  67 extern __thread void * _glapi_tls_Context
  68     __attribute__((tls_model("initial-exec")));
  69
  70 # define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_tls_Context
  71
  72 #else
  73
  74 extern void *_glapi_Context;
  75 extern struct _glapi_table *_glapi_Dispatch;
  76
  77 /**
  78  * Macro for declaration and fetching the current context.
  79  *
  80  * \param C local variable which will hold the current context.
  81  *
  82  * It should be used in the variable declaration area of a function:
  83  * \code
  84  * ...
  85  * {
  86  *   GET_CURRENT_CONTEXT(ctx);
  87  *   ...
  88  * \endcode
  89  */
  90 # ifdef THREADS
  91 #  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())
  92 # else
  93 #  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_Context
  94 # endif
  95
  96 #endif /* defined (GLX_USE_TLS) */
  97
  98 extern void
  99 _glapi_noop_enable_warnings(GLboolean enable);
 100
 101 extern void
 102 _glapi_set_warning_func(_glapi_warning_func func);
 103
 104 extern void
 105 _glapi_check_multithread(void);
 106
 107
 108 extern void
 109 _glapi_set_context(void *context);
 110
 111
 112 extern void *
 113 _glapi_get_context(void);
 114
 115
 116 extern void
 117 _glapi_set_dispatch(struct _glapi_table *dispatch);
 118
 119
 120 extern struct _glapi_table *
 121 _glapi_get_dispatch(void);
 122
 123
 124 extern int
 125 _glapi_begin_dispatch_override(struct _glapi_table *override);
 126
 127
 128 extern void
 129 _glapi_end_dispatch_override(int layer);
 130
 131
 132 struct _glapi_table *
 133 _glapi_get_override_dispatch(int layer);
 134
 135
 136 extern GLuint
 137 _glapi_get_dispatch_table_size(void);
 138
 139
 140 extern void
 141 _glapi_check_table(const struct _glapi_table *table);
 142
 143
 144 extern int
 145 _glapi_add_dispatch( const char * const * function_names,
 146                      const char * parameter_signature );
 147
 148 extern GLint
 149 _glapi_get_proc_offset(const char *funcName);
 150
 151
 152 extern _glapi_proc
 153 _glapi_get_proc_address(const char *funcName);
 154
 155
 156 extern const char *
 157 _glapi_get_proc_name(GLuint offset);
 158
 159
 160 #endif