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