src/mesa/glapi/glapi.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.3
   4  *
   5  * Copyright (C) 1999-2004  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
  48 #include "GL/gl.h"
  49
  50 struct _glapi_table;
  51
  52 typedef void (*_glapi_warning_func)(void *ctx, const char *str, ...);
  53
  54 typedef void (*_glapi_proc)(void); /* generic function pointer */
  55
  56
  57 extern void *_glapi_Context;
  58
  59 extern struct _glapi_table *_glapi_Dispatch;
  60
  61
  62 extern void
  63 _glapi_noop_enable_warnings(GLboolean enable);
  64
  65 extern void
  66 _glapi_set_warning_func(_glapi_warning_func func);
  67
  68 extern void
  69 _glapi_check_multithread(void);
  70
  71
  72 extern void
  73 _glapi_set_context(void *context);
  74
  75
  76 extern void *
  77 _glapi_get_context(void);
  78
  79
  80 extern void
  81 _glapi_set_dispatch(struct _glapi_table *dispatch);
  82
  83
  84 extern struct _glapi_table *
  85 _glapi_get_dispatch(void);
  86
  87
  88 extern int
  89 _glapi_begin_dispatch_override(struct _glapi_table *override);
  90
  91
  92 extern void
  93 _glapi_end_dispatch_override(int layer);
  94
  95
  96 struct _glapi_table *
  97 _glapi_get_override_dispatch(int layer);
  98
  99
 100 extern GLuint
 101 _glapi_get_dispatch_table_size(void);
 102
 103
 104 extern const char *
 105 _glapi_get_version(void);
 106
 107
 108 extern void
 109 _glapi_check_table(const struct _glapi_table *table);
 110
 111
 112 extern GLboolean
 113 _glapi_add_entrypoint(const char *funcName, GLuint offset);
 114
 115
 116 extern GLint
 117 _glapi_get_proc_offset(const char *funcName);
 118
 119
 120 extern const _glapi_proc
 121 _glapi_get_proc_address(const char *funcName);
 122
 123
 124 extern const char *
 125 _glapi_get_proc_name(GLuint offset);
 126
 127
 128 #endif