src/mesa/glapi/glapi.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.1
   4  *
   5  * Copyright (C) 1999-2008  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 #define GL_GLEXT_PROTOTYPES
  48
  49 #include "glthread.h"
  50
  51
  52 struct _glapi_table;
  53
  54 typedef void (*_glapi_proc)(void); /* generic function pointer */
  55
  56
  57 #if defined(USE_MGL_NAMESPACE)
  58 #define _glapi_set_dispatch _mglapi_set_dispatch
  59 #define _glapi_get_dispatch _mglapi_get_dispatch
  60 #define _glapi_set_context _mglapi_set_context
  61 #define _glapi_get_context _mglapi_get_context
  62 #define _glapi_Context _mglapi_Context
  63 #define _glapi_Dispatch _mglapi_Dispatch
  64 #endif
  65
  66
  67 /*
  68  * Number of extension functions which we can dynamically add at runtime.
  69  */
  70 #define MAX_EXTENSION_FUNCS 300
  71
  72
  73 /**
  74  ** Define the GET_CURRENT_CONTEXT() macro.
  75  ** \param C local variable which will hold the current context.
  76  **/
  77 #if defined (GLX_USE_TLS)
  78
  79 extern const void *_glapi_Context;
  80 extern const struct _glapi_table *_glapi_Dispatch;
  81
  82 extern __thread void * _glapi_tls_Context
  83     __attribute__((tls_model("initial-exec")));
  84
  85 # define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_tls_Context
  86
  87 #else
  88
  89 extern void *_glapi_Context;
  90 extern struct _glapi_table *_glapi_Dispatch;
  91
  92 # ifdef THREADS
  93 #  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())
  94 # else
  95 #  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_Context
  96 # endif
  97
  98 #endif /* defined (GLX_USE_TLS) */
  99
 100
 101 /**
 102  ** GL API public functions
 103  **/
 104
 105 extern void
 106 _glapi_check_multithread(void);
 107
 108
 109 extern void
 110 _glapi_set_context(void *context);
 111
 112
 113 extern void *
 114 _glapi_get_context(void);
 115
 116
 117 extern void
 118 _glapi_set_dispatch(struct _glapi_table *dispatch);
 119
 120
 121 extern struct _glapi_table *
 122 _glapi_get_dispatch(void);
 123
 124
 125 extern int
 126 _glapi_begin_dispatch_override(struct _glapi_table *override);
 127
 128
 129 extern void
 130 _glapi_end_dispatch_override(int layer);
 131
 132
 133 struct _glapi_table *
 134 _glapi_get_override_dispatch(int layer);
 135
 136
 137 extern unsigned int
 138 _glapi_get_dispatch_table_size(void);
 139
 140
 141 extern void
 142 _glapi_check_table(const struct _glapi_table *table);
 143
 144
 145 extern int
 146 _glapi_add_dispatch( const char * const * function_names,
 147                      const char * parameter_signature );
 148
 149 extern int
 150 _glapi_get_proc_offset(const char *funcName);
 151
 152
 153 extern _glapi_proc
 154 _glapi_get_proc_address(const char *funcName);
 155
 156
 157 extern const char *
 158 _glapi_get_proc_name(unsigned int offset);
 159
 160
 161 #endif