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