Merge branch '7.8'
[mesa.git] / src / mesa / glapi / glapi.h
index 0baa0c2b50778dd50e1bca7f20795057e1adbf47..7dcf2e8910b2fe0201b6664ebb8e3e6f5e9d320c 100644 (file)
@@ -1,10 +1,8 @@
-/* $Id: glapi.h,v 1.3 1999/11/25 18:17:14 brianp Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  3.3
+ * Version:  7.1
  *
- * Copyright (C) 1999  Brian Paul   All Rights Reserved.
+ * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
  */
 
 
+/**
+ * \mainpage Mesa GL API Module
+ *
+ * \section GLAPIIntroduction Introduction
+ *
+ * The Mesa GL API module is responsible for dispatching all the
+ * gl*() functions.  All GL functions are dispatched by jumping through
+ * the current dispatch table (basically a struct full of function
+ * pointers.)
+ *
+ * A per-thread current dispatch table and per-thread current context
+ * pointer are managed by this module too.
+ *
+ * This module is intended to be non-Mesa-specific so it can be used
+ * with the X/DRI libGL also.
+ */
+
+
 #ifndef _GLAPI_H
 #define _GLAPI_H
 
+#include "glthread.h"
+
+
+struct _glapi_table;
+
+typedef void (*_glapi_proc)(void); /* generic function pointer */
+
+
+#if defined(USE_MGL_NAMESPACE)
+#define _glapi_set_dispatch _mglapi_set_dispatch
+#define _glapi_get_dispatch _mglapi_get_dispatch
+#define _glapi_set_context _mglapi_set_context
+#define _glapi_get_context _mglapi_get_context
+#define _glapi_Dispatch _mglapi_Dispatch
+#define _glapi_Context _mglapi_Context
+#endif
+
+
+#if defined(__GNUC__)
+#  define likely(x)   __builtin_expect(!!(x), 1)
+#  define unlikely(x) __builtin_expect(!!(x), 0)
+#else
+#  define likely(x)   (x)
+#  define unlikely(x) (x)
+#endif
+
+
+/**
+ ** Define the GET_DISPATCH() and GET_CURRENT_CONTEXT() macros.
+ **
+ ** \param C local variable which will hold the current context.
+ **/
+#if defined (GLX_USE_TLS)
+
+extern const struct _glapi_table *_glapi_Dispatch;
+
+extern const void *_glapi_Context;
+
+extern __thread struct _glapi_table * _glapi_tls_Dispatch
+    __attribute__((tls_model("initial-exec")));
+
+extern __thread void * _glapi_tls_Context
+    __attribute__((tls_model("initial-exec")));
+
+# define GET_DISPATCH() _glapi_tls_Dispatch
+
+# define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_tls_Context
+
+#else
+
+extern struct _glapi_table *_glapi_Dispatch;
 
-#include "GL/gl.h"
+extern void *_glapi_Context;
 
-#include "glapitable.h"
+# ifdef THREADS
 
+#  define GET_DISPATCH() \
+     (likely(_glapi_Dispatch) ? _glapi_Dispatch : _glapi_get_dispatch())
+
+#  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) \
+     (likely(_glapi_Context) ? _glapi_Context : _glapi_get_context())
+
+# else
+
+#  define GET_DISPATCH() _glapi_Dispatch
+
+#  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_Context
+
+# endif
+
+#endif /* defined (GLX_USE_TLS) */
+
+
+/**
+ ** GL API public functions
+ **/
 
 extern void
-_glapi_set_dispatch(struct _glapi_table *dispatch);
+_glapi_init_multithread(void);
 
 
-extern struct _glapi_table *
-_glapi_get_dispatch(void);
+extern void
+_glapi_destroy_multithread(void);
 
 
-extern const char *
-_glapi_get_version(void);
+extern void
+_glapi_check_multithread(void);
 
 
-extern const char *
-_glapi_get_extensions(void);
+extern void
+_glapi_set_context(void *context);
+
+
+extern void *
+_glapi_get_context(void);
 
 
 extern void
-_glapi_check_table(const struct _glapi_table *table);
+_glapi_set_dispatch(struct _glapi_table *dispatch);
 
 
-extern GLint
-_glapi_alloc_entrypoint(const char *funcName);
+extern struct _glapi_table *
+_glapi_get_dispatch(void);
 
 
-extern GLint
-_glapi_get_entrypoint(const char *funcName);
+extern unsigned int
+_glapi_get_dispatch_table_size(void);
 
 
-extern const GLvoid *
+extern int
+_glapi_add_dispatch( const char * const * function_names,
+                    const char * parameter_signature );
+
+extern int
+_glapi_get_proc_offset(const char *funcName);
+
+
+extern _glapi_proc
 _glapi_get_proc_address(const char *funcName);
 
 
+extern const char *
+_glapi_get_proc_name(unsigned int offset);
+
+
 #endif