src/mapi/glapi/glapi.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  * \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 #include "util/macros.h"
  48 #include "u_thread.h"
  49
  50
  51 #ifdef __cplusplus
  52 extern "C" {
  53 #endif
  54
  55
  56 #ifdef _GLAPI_NO_EXPORTS
  57 #  define _GLAPI_EXPORT
  58 #else /* _GLAPI_NO_EXPORTS */
  59 #  ifdef _WIN32
  60 #    ifdef _GLAPI_DLL_EXPORTS
  61 #      define _GLAPI_EXPORT __declspec(dllexport)
  62 #    else
  63 #      define _GLAPI_EXPORT __declspec(dllimport)
  64 #    endif
  65 #  elif defined(__GNUC__) || (defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590))
  66 #    define _GLAPI_EXPORT __attribute__((visibility("default")))
  67 #  else
  68 #    define _GLAPI_EXPORT
  69 #  endif
  70 #endif /* _GLAPI_NO_EXPORTS */
  71
  72
  73 /* Is this needed?  It is incomplete anyway. */
  74 #ifdef USE_MGL_NAMESPACE
  75 #define _glapi_set_dispatch _mglapi_set_dispatch
  76 #define _glapi_get_dispatch _mglapi_get_dispatch
  77 #define _glapi_set_context _mglapi_set_context
  78 #define _glapi_get_context _mglapi_get_context
  79 #define _glapi_Dispatch _mglapi_Dispatch
  80 #define _glapi_Context _mglapi_Context
  81 #endif
  82
  83 typedef void (*_glapi_proc)(void);
  84 struct _glapi_table;
  85
  86
  87 #if defined (GLX_USE_TLS)
  88
  89 _GLAPI_EXPORT extern __thread struct _glapi_table * _glapi_tls_Dispatch
  90     __attribute__((tls_model("initial-exec")));
  91
  92 _GLAPI_EXPORT extern __thread void * _glapi_tls_Context
  93     __attribute__((tls_model("initial-exec")));
  94
  95 _GLAPI_EXPORT extern const struct _glapi_table *_glapi_Dispatch;
  96 _GLAPI_EXPORT extern const void *_glapi_Context;
  97
  98 # define GET_DISPATCH() _glapi_tls_Dispatch
  99 # define GET_CURRENT_CONTEXT(C)  struct gl_context *C = (struct gl_context *) _glapi_tls_Context
 100
 101 #else
 102
 103 _GLAPI_EXPORT extern struct _glapi_table *_glapi_Dispatch;
 104 _GLAPI_EXPORT extern void *_glapi_Context;
 105
 106 #define GET_DISPATCH() \
 107      (likely(_glapi_Dispatch) ? _glapi_Dispatch : _glapi_get_dispatch())
 108
 109 #define GET_CURRENT_CONTEXT(C)  struct gl_context *C = (struct gl_context *) \
 110      (likely(_glapi_Context) ? _glapi_Context : _glapi_get_context())
 111
 112 #endif /* defined (GLX_USE_TLS) */
 113
 114
 115 void
 116 _glapi_destroy_multithread(void);
 117
 118
 119 _GLAPI_EXPORT void
 120 _glapi_check_multithread(void);
 121
 122
 123 _GLAPI_EXPORT void
 124 _glapi_set_context(void *context);
 125
 126
 127 _GLAPI_EXPORT void *
 128 _glapi_get_context(void);
 129
 130
 131 _GLAPI_EXPORT void
 132 _glapi_set_dispatch(struct _glapi_table *dispatch);
 133
 134
 135 _GLAPI_EXPORT struct _glapi_table *
 136 _glapi_get_dispatch(void);
 137
 138
 139 _GLAPI_EXPORT unsigned int
 140 _glapi_get_dispatch_table_size(void);
 141
 142
 143 _GLAPI_EXPORT int
 144 _glapi_add_dispatch( const char * const * function_names,
 145                      const char * parameter_signature );
 146
 147 _GLAPI_EXPORT int
 148 _glapi_get_proc_offset(const char *funcName);
 149
 150
 151 _GLAPI_EXPORT _glapi_proc
 152 _glapi_get_proc_address(const char *funcName);
 153
 154
 155 _GLAPI_EXPORT const char *
 156 _glapi_get_proc_name(unsigned int offset);
 157
 158
 159 _GLAPI_EXPORT struct _glapi_table *
 160 _glapi_create_table_from_handle(void *handle, const char *symbol_prefix);
 161
 162
 163 /** Deprecated function */
 164 _GLAPI_EXPORT unsigned long
 165 _glthread_GetID(void);
 166
 167
 168 /*
 169  * These stubs are kept so that the old DRI drivers still load.
 170  */
 171 _GLAPI_EXPORT void
 172 _glapi_noop_enable_warnings(unsigned char enable);
 173
 174
 175 _GLAPI_EXPORT void
 176 _glapi_set_warning_func(_glapi_proc func);
 177
 178
 179 #ifdef __cplusplus
 180 }
 181 #endif
 182
 183 #endif /* _GLAPI_H */