src/mesa/main/context.h

   1 /* $Id: context.h,v 1.6 1999/12/17 12:21:39 brianp Exp $ */
   2
   3 /*
   4  * Mesa 3-D graphics library
   5  * Version:  3.3
   6  *
   7  * Copyright (C) 1999  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 "types.h"
  33
  34
  35 /*
  36  * There are three Mesa datatypes which are meant to be used by device
  37  * drivers:
  38  *   GLcontext:  this contains the Mesa rendering state
  39  *   GLvisual:  this describes the color buffer (rgb vs. ci), whether
  40  *              or not there's a depth buffer, stencil buffer, etc.
  41  *   GLframebuffer:  contains pointers to the depth buffer, stencil
  42  *                   buffer, accum buffer and alpha buffers.
  43  *
  44  * These types should be encapsulated by corresponding device driver
  45  * datatypes.  See xmesa.h and xmesaP.h for an example.
  46  *
  47  * In OOP terms, GLcontext, GLvisual, and GLframebuffer are base classes
  48  * which the device driver must derive from.
  49  *
  50  * The following functions create and destroy these datatypes.
  51  */
  52
  53
  54 /*
  55  * Create/destroy a GLvisual.  A GLvisual is like a GLX visual.  It describes
  56  * the colorbuffer, depth buffer, stencil buffer and accum buffer which will
  57  * be used by the GL context and framebuffer.
  58  */
  59 extern GLvisual *gl_create_visual( GLboolean rgbFlag,
  60                                    GLboolean alphaFlag,
  61                                    GLboolean dbFlag,
  62                                    GLboolean stereoFlag,
  63                                    GLint depthBits,
  64                                    GLint stencilBits,
  65                                    GLint accumBits,
  66                                    GLint indexBits,
  67                                    GLint redBits,
  68                                    GLint greenBits,
  69                                    GLint blueBits,
  70                                    GLint alphaBits );
  71
  72 extern void gl_destroy_visual( GLvisual *vis );
  73
  74
  75 /*
  76  * Create/destroy a GLcontext.  A GLcontext is like a GLX context.  It
  77  * contains the rendering state.
  78  */
  79 extern GLcontext *gl_create_context( GLvisual *visual,
  80                                      GLcontext *share_list,
  81                                      void *driver_ctx,
  82                                      GLboolean direct);
  83
  84 extern void gl_destroy_context( GLcontext *ctx );
  85
  86 /* Called by the driver after both the context and driver are fully
  87  * initialized.  Currently just reads the config file.
  88  */
  89 extern void gl_context_initialize( GLcontext *ctx );
  90
  91
  92 extern void gl_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
  93
  94
  95 /*
  96  * Create/destroy a GLframebuffer.  A GLframebuffer is like a GLX drawable.
  97  * It bundles up the depth buffer, stencil buffer and accum buffers into a
  98  * single entity.
  99  */
 100 extern GLframebuffer *gl_create_framebuffer( GLvisual *visual,
 101                                              GLboolean softwareDepth,
 102                                              GLboolean softwareStencil,
 103                                              GLboolean softwareAccum,
 104                                              GLboolean softwareAlpha );
 105
 106 extern void gl_destroy_framebuffer( GLframebuffer *buffer );
 107
 108
 109
 110 extern void gl_make_current( GLcontext *ctx, GLframebuffer *buffer );
 111
 112 extern void gl_make_current2( GLcontext *ctx, GLframebuffer *drawBuffer,
 113                               GLframebuffer *readBuffer );
 114
 115 extern GLcontext *gl_get_current_context(void);
 116
 117
 118 #ifdef THREADS
 119
 120 /*
 121  * A seperate GLcontext for each thread
 122  */
 123 #define GET_CURRENT_CONTEXT(C)  GLcontext *C = gl_get_current_context()
 124 #define GET_IMMEDIATE struct immediate *IM = (gl_get_current_context())->input;
 125 #define SET_IMMEDIATE(ctx, im)          \
 126 do {                                    \
 127    ctx->input = im;                     \
 128 } while (0)
 129
 130 #else
 131
 132 /*
 133  * All threads use same pointer to current context.
 134  */
 135 extern GLcontext *_mesa_current_context;
 136 extern struct immediate *CURRENT_INPUT;
 137 #define GET_CURRENT_CONTEXT(C)  GLcontext *C = _mesa_current_context
 138 #define GET_IMMEDIATE struct immediate *IM = CURRENT_INPUT
 139 #define SET_IMMEDIATE(ctx, im)          \
 140 do {                                    \
 141    ctx->input = im;                     \
 142    CURRENT_INPUT = im;                  \
 143 } while (0)
 144
 145 #endif
 146
 147
 148
 149 extern void
 150 _mesa_swapbuffers(GLcontext *ctx);
 151
 152 extern struct _glapi_table *
 153 _mesa_get_dispatch(GLcontext *ctx);
 154
 155
 156
 157 /*
 158  * GL_MESA_resize_buffers extension
 159  */
 160 extern void _mesa_ResizeBuffersMESA( void );
 161
 162
 163
 164 /*
 165  * Miscellaneous
 166  */
 167
 168 extern void gl_problem( const GLcontext *ctx, const char *s );
 169
 170 extern void gl_warning( const GLcontext *ctx, const char *s );
 171
 172 extern void gl_error( GLcontext *ctx, GLenum error, const char *s );
 173 extern void gl_compile_error( GLcontext *ctx, GLenum error, const char *s );
 174
 175
 176 extern void gl_update_state( GLcontext *ctx );
 177
 178
 179 /* for debugging */
 180 extern void gl_print_state( const char *msg, GLuint state );
 181
 182 /* for debugging */
 183 extern void gl_print_enable_flags( const char *msg, GLuint flags );
 184
 185
 186 #ifdef PROFILE
 187 extern GLdouble gl_time( void );
 188 #endif
 189
 190
 191 #endif