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 "util/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__) 66 # define _GLAPI_EXPORT __attribute__((visibility("default"))) 67 # else 68 # define _GLAPI_EXPORT 69 # endif 70 #endif /* _GLAPI_NO_EXPORTS */ 71 72 73 typedef void (*_glapi_proc)(void); 74 75 typedef void (*_glapi_nop_handler_proc)(const char *name); 76 77 struct _glapi_table; 78 79 80 #if defined (USE_ELF_TLS) 81 82 #ifdef _MSC_VER 83 extern __declspec(thread) struct _glapi_table * _glapi_tls_Dispatch; 84 extern __declspec(thread) void * _glapi_tls_Context; 85 #else 86 _GLAPI_EXPORT extern __THREAD_INITIAL_EXEC struct _glapi_table * _glapi_tls_Dispatch; 87 88 _GLAPI_EXPORT extern __THREAD_INITIAL_EXEC void * _glapi_tls_Context; 89 #endif 90 91 _GLAPI_EXPORT extern const struct _glapi_table *_glapi_Dispatch; 92 _GLAPI_EXPORT extern const void *_glapi_Context; 93 94 # define GET_DISPATCH() _glapi_tls_Dispatch 95 # define GET_CURRENT_CONTEXT(C) struct gl_context *C = (struct gl_context *) _glapi_tls_Context 96 97 #else 98 99 _GLAPI_EXPORT extern struct _glapi_table *_glapi_Dispatch; 100 _GLAPI_EXPORT extern void *_glapi_Context; 101 102 #define GET_DISPATCH() \ 103 (likely(_glapi_Dispatch) ? _glapi_Dispatch : _glapi_get_dispatch()) 104 105 #define GET_CURRENT_CONTEXT(C) struct gl_context *C = (struct gl_context *) \ 106 (likely(_glapi_Context) ? _glapi_Context : _glapi_get_context()) 107 108 #endif /* defined (USE_ELF_TLS) */ 109 110 111 _GLAPI_EXPORT void 112 _glapi_destroy_multithread(void); 113 114 115 _GLAPI_EXPORT void 116 _glapi_check_multithread(void); 117 118 119 _GLAPI_EXPORT void 120 _glapi_set_context(void *context); 121 122 123 _GLAPI_EXPORT void * 124 _glapi_get_context(void); 125 126 127 _GLAPI_EXPORT void 128 _glapi_set_dispatch(struct _glapi_table *dispatch); 129 130 131 _GLAPI_EXPORT struct _glapi_table * 132 _glapi_get_dispatch(void); 133 134 135 _GLAPI_EXPORT unsigned int 136 _glapi_get_dispatch_table_size(void); 137 138 139 _GLAPI_EXPORT int 140 _glapi_add_dispatch( const char * const * function_names, 141 const char * parameter_signature ); 142 143 _GLAPI_EXPORT int 144 _glapi_get_proc_offset(const char *funcName); 145 146 147 _GLAPI_EXPORT _glapi_proc 148 _glapi_get_proc_address(const char *funcName); 149 150 151 _GLAPI_EXPORT const char * 152 _glapi_get_proc_name(unsigned int offset); 153 154 155 #if defined(GLX_USE_APPLEGL) || defined(GLX_USE_WINDOWSGL) 156 _GLAPI_EXPORT struct _glapi_table * 157 _glapi_create_table_from_handle(void *handle, const char *symbol_prefix); 158 159 _GLAPI_EXPORT void 160 _glapi_table_patch(struct _glapi_table *, const char *name, void *wrapper); 161 #endif 162 163 164 _GLAPI_EXPORT void 165 _glapi_set_nop_handler(_glapi_nop_handler_proc func); 166 167 /** Return pointer to new dispatch table filled with no-op functions */ 168 _GLAPI_EXPORT struct _glapi_table * 169 _glapi_new_nop_table(unsigned num_entries); 170 171 172 /** Deprecated function */ 173 _GLAPI_EXPORT unsigned long 174 _glthread_GetID(void); 175 176 177 /* 178 * These stubs are kept so that the old DRI drivers still load. 179 */ 180 _GLAPI_EXPORT void 181 _glapi_noop_enable_warnings(unsigned char enable); 182 183 184 _GLAPI_EXPORT void 185 _glapi_set_warning_func(_glapi_proc func); 186 187 188 #ifdef __cplusplus 189 } 190 #endif 191 192 #endif /* _GLAPI_H */ 193