src/mesa/main/context.h

   1 /* $Id: context.h,v 1.22 2000/11/22 07:32:16 joukj Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.3
   6  *
   7  * Copyright (C) 1999-2000  Brian Paul   All Rights Reserved.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included
  17  * in all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  22  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  23  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  24  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  */
  26
  27
  28 #ifndef CONTEXT_H
  29 #define CONTEXT_H
  30
  31
  32 #include "glapi.h"
  33 #include "mtypes.h"
  34
  35
  36 /*
  37  * There are three Mesa datatypes which are meant to be used by device
  38  * drivers:
  39  *   GLcontext:  this contains the Mesa rendering state
  40  *   GLvisual:  this describes the color buffer (rgb vs. ci), whether
  41  *              or not there's a depth buffer, stencil buffer, etc.
  42  *   GLframebuffer:  contains pointers to the depth buffer, stencil
  43  *                   buffer, accum buffer and alpha buffers.
  44  *
  45  * These types should be encapsulated by corresponding device driver
  46  * datatypes.  See xmesa.h and xmesaP.h for an example.
  47  *
  48  * In OOP terms, GLcontext, GLvisual, and GLframebuffer are base classes
  49  * which the device driver must derive from.
  50  *
  51  * The following functions create and destroy these datatypes.
  52  */
  53
  54
  55 /*
  56  * Create/destroy a GLvisual.  A GLvisual is like a GLX visual.  It describes
  57  * the colorbuffer, depth buffer, stencil buffer and accum buffer which will
  58  * be used by the GL context and framebuffer.
  59  */
  60 extern GLvisual *
  61 _mesa_create_visual( GLboolean rgbFlag,
  62                      GLboolean dbFlag,
  63                      GLboolean stereoFlag,
  64                      GLint redBits,
  65                      GLint greenBits,
  66                      GLint blueBits,
  67                      GLint alphaBits,
  68                      GLint indexBits,
  69                      GLint depthBits,
  70                      GLint stencilBits,
  71                      GLint accumRedBits,
  72                      GLint accumGreenBits,
  73                      GLint accumBlueBits,
  74                      GLint accumAlphaBits,
  75                      GLint numSamples );
  76
  77 extern GLboolean
  78 _mesa_initialize_visual( GLvisual *v,
  79                          GLboolean rgbFlag,
  80                          GLboolean dbFlag,
  81                          GLboolean stereoFlag,
  82                          GLint redBits,
  83                          GLint greenBits,
  84                          GLint blueBits,
  85                          GLint alphaBits,
  86                          GLint indexBits,
  87                          GLint depthBits,
  88                          GLint stencilBits,
  89                          GLint accumRedBits,
  90                          GLint accumGreenBits,
  91                          GLint accumBlueBits,
  92                          GLint accumAlphaBits,
  93                          GLint numSamples );
  94
  95 extern void
  96 _mesa_destroy_visual( GLvisual *vis );
  97
  98
  99
 100 /*
 101  * Create/destroy a GLframebuffer.  A GLframebuffer is like a GLX drawable.
 102  * It bundles up the depth buffer, stencil buffer and accum buffers into a
 103  * single entity.
 104  */
 105 extern GLframebuffer *
 106 _mesa_create_framebuffer( GLvisual *visual,
 107                           GLboolean softwareDepth,
 108                           GLboolean softwareStencil,
 109                           GLboolean softwareAccum,
 110                           GLboolean softwareAlpha );
 111
 112 extern void
 113 _mesa_initialize_framebuffer( GLframebuffer *fb,
 114                               GLvisual *visual,
 115                               GLboolean softwareDepth,
 116                               GLboolean softwareStencil,
 117                               GLboolean softwareAccum,
 118                               GLboolean softwareAlpha );
 119
 120 extern void
 121 _mesa_destroy_framebuffer( GLframebuffer *buffer );
 122
 123
 124
 125 /*
 126  * Create/destroy a GLcontext.  A GLcontext is like a GLX context.  It
 127  * contains the rendering state.
 128  */
 129 extern GLcontext *
 130 _mesa_create_context( GLvisual *visual,
 131                       GLcontext *share_list,
 132                       void *driver_ctx,
 133                       GLboolean direct);
 134
 135 extern GLboolean
 136 _mesa_initialize_context( GLcontext *ctx,
 137                           GLvisual *visual,
 138                           GLcontext *share_list,
 139                           void *driver_ctx,
 140                           GLboolean direct );
 141
 142 extern void
 143 _mesa_free_context_data( GLcontext *ctx );
 144
 145 extern void
 146 _mesa_destroy_context( GLcontext *ctx );
 147
 148
 149 extern void
 150 _mesa_context_initialize( GLcontext *ctx );
 151
 152
 153 extern void
 154 _mesa_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
 155
 156
 157 extern void
 158 _mesa_make_current( GLcontext *ctx, GLframebuffer *buffer );
 159
 160
 161 extern void
 162 _mesa_make_current2( GLcontext *ctx, GLframebuffer *drawBuffer,
 163                   GLframebuffer *readBuffer );
 164
 165
 166 extern GLcontext *
 167 _mesa_get_current_context(void);
 168
 169
 170
 171 /*
 172  * Macros for fetching current context.
 173  */
 174 #ifdef THREADS
 175
 176 #define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())
 177
 178 #else
 179
 180 #define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_Context
 181
 182 #endif
 183
 184
 185
 186 extern void
 187 _mesa_swapbuffers(GLcontext *ctx);
 188
 189
 190 extern struct _glapi_table *
 191 _mesa_get_dispatch(GLcontext *ctx);
 192
 193
 194
 195 /*
 196  * Miscellaneous
 197  */
 198
 199 extern void
 200 gl_problem( const GLcontext *ctx, const char *s );
 201
 202 extern void
 203 _mesa_warning( const GLcontext *ctx, const char *s );
 204
 205 extern void
 206 gl_error( GLcontext *ctx, GLenum error, const char *s );
 207
 208 extern void
 209 _mesa_compile_error( GLcontext *ctx, GLenum error, const char *s );
 210
 211
 212
 213 extern void
 214 _mesa_Finish( void );
 215
 216 extern void
 217 _mesa_Flush( void );
 218
 219
 220
 221 extern void
 222 gl_read_config_file(GLcontext *ctx);
 223
 224 extern void
 225 gl_register_config_var(const char *name, void (*notify)( const char *, int ));
 226
 227
 228 #endif