2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
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:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
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.
27 * \mainpage Mesa GL API Module
29 * \section GLAPIIntroduction Introduction
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
36 * A per-thread current dispatch table and per-thread current context
37 * pointer are managed by this module too.
39 * This module is intended to be non-Mesa-specific so it can be used
40 * with the X/DRI libGL also.
47 #include "util/macros.h"
55 #ifdef _GLAPI_NO_EXPORTS
56 # define _GLAPI_EXPORT
57 #else /* _GLAPI_NO_EXPORTS */
59 # ifdef _GLAPI_DLL_EXPORTS
60 # define _GLAPI_EXPORT __declspec(dllexport)
62 # define _GLAPI_EXPORT __declspec(dllimport)
64 # elif defined(__GNUC__)
65 # define _GLAPI_EXPORT __attribute__((visibility("default")))
67 # define _GLAPI_EXPORT
69 #endif /* _GLAPI_NO_EXPORTS */
72 typedef void (*_glapi_proc
)(void);
74 typedef void (*_glapi_nop_handler_proc
)(const char *name
);
79 #if defined (USE_ELF_TLS)
81 _GLAPI_EXPORT
extern __thread
struct _glapi_table
* _glapi_tls_Dispatch
82 __attribute__((tls_model("initial-exec")));
84 _GLAPI_EXPORT
extern __thread
void * _glapi_tls_Context
85 __attribute__((tls_model("initial-exec")));
87 _GLAPI_EXPORT
extern const struct _glapi_table
*_glapi_Dispatch
;
88 _GLAPI_EXPORT
extern const void *_glapi_Context
;
90 # define GET_DISPATCH() _glapi_tls_Dispatch
91 # define GET_CURRENT_CONTEXT(C) struct gl_context *C = (struct gl_context *) _glapi_tls_Context
95 _GLAPI_EXPORT
extern struct _glapi_table
*_glapi_Dispatch
;
96 _GLAPI_EXPORT
extern void *_glapi_Context
;
98 #define GET_DISPATCH() \
99 (likely(_glapi_Dispatch) ? _glapi_Dispatch : _glapi_get_dispatch())
101 #define GET_CURRENT_CONTEXT(C) struct gl_context *C = (struct gl_context *) \
102 (likely(_glapi_Context) ? _glapi_Context : _glapi_get_context())
104 #endif /* defined (USE_ELF_TLS) */
108 _glapi_destroy_multithread(void);
112 _glapi_check_multithread(void);
116 _glapi_set_context(void *context
);
120 _glapi_get_context(void);
124 _glapi_set_dispatch(struct _glapi_table
*dispatch
);
127 _GLAPI_EXPORT
struct _glapi_table
*
128 _glapi_get_dispatch(void);
131 _GLAPI_EXPORT
unsigned int
132 _glapi_get_dispatch_table_size(void);
136 _glapi_add_dispatch( const char * const * function_names
,
137 const char * parameter_signature
);
140 _glapi_get_proc_offset(const char *funcName
);
143 _GLAPI_EXPORT _glapi_proc
144 _glapi_get_proc_address(const char *funcName
);
147 _GLAPI_EXPORT
const char *
148 _glapi_get_proc_name(unsigned int offset
);
151 #if defined(GLX_USE_APPLEGL) || defined(GLX_USE_WINDOWSGL)
152 _GLAPI_EXPORT
struct _glapi_table
*
153 _glapi_create_table_from_handle(void *handle
, const char *symbol_prefix
);
156 _glapi_table_patch(struct _glapi_table
*, const char *name
, void *wrapper
);
161 _glapi_set_nop_handler(_glapi_nop_handler_proc func
);
163 /** Return pointer to new dispatch table filled with no-op functions */
164 _GLAPI_EXPORT
struct _glapi_table
*
165 _glapi_new_nop_table(unsigned num_entries
);
168 /** Deprecated function */
169 _GLAPI_EXPORT
unsigned long
170 _glthread_GetID(void);
174 * These stubs are kept so that the old DRI drivers still load.
177 _glapi_noop_enable_warnings(unsigned char enable
);
181 _glapi_set_warning_func(_glapi_proc func
);
188 #endif /* _GLAPI_H */