src/mesa/main/context.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  6.5.1
   4  *
   5  * Copyright (C) 1999-2006  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  * \file context.h
  28  * Mesa context and visual-related functions.
  29  *
  30  * There are three large Mesa data types/classes which are meant to be
  31  * used by device drivers:
  32  * - GLcontext: this contains the Mesa rendering state
  33  * - GLvisual:  this describes the color buffer (RGB vs. ci), whether or not
  34  *   there's a depth buffer, stencil buffer, etc.
  35  * - GLframebuffer:  contains pointers to the depth buffer, stencil buffer,
  36  *   accum buffer and alpha buffers.
  37  *
  38  * These types should be encapsulated by corresponding device driver
  39  * data types.  See xmesa.h and xmesaP.h for an example.
  40  *
  41  * In OOP terms, GLcontext, GLvisual, and GLframebuffer are base classes
  42  * which the device driver must derive from.
  43  *
  44  * The following functions create and destroy these data types.
  45  */
  46
  47
  48 #ifndef CONTEXT_H
  49 #define CONTEXT_H
  50
  51
  52 #include "glapi/glapi.h"
  53 #include "imports.h"
  54 #include "mtypes.h"
  55
  56
  57 /** \name Visual-related functions */
  58 /*@{*/
  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 /** \name Context-related functions */
 102 /*@{*/
 103
 104 extern GLcontext *
 105 _mesa_create_context( const GLvisual *visual,
 106                       GLcontext *share_list,
 107                       const struct dd_function_table *driverFunctions,
 108                       void *driverContext );
 109
 110 extern GLboolean
 111 _mesa_initialize_context( GLcontext *ctx,
 112                           const GLvisual *visual,
 113                           GLcontext *share_list,
 114                           const struct dd_function_table *driverFunctions,
 115                           void *driverContext );
 116
 117 extern void
 118 _mesa_free_context_data( GLcontext *ctx );
 119
 120 extern void
 121 _mesa_destroy_context( GLcontext *ctx );
 122
 123
 124 extern void
 125 _mesa_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
 126
 127
 128 extern void
 129 _mesa_make_current( GLcontext *ctx, GLframebuffer *drawBuffer,
 130                     GLframebuffer *readBuffer );
 131
 132 extern GLboolean
 133 _mesa_share_state(GLcontext *ctx, GLcontext *ctxToShare);
 134
 135 extern GLcontext *
 136 _mesa_get_current_context(void);
 137
 138 /*@}*/
 139
 140
 141 extern void
 142 _mesa_notifySwapBuffers(__GLcontext *gc);
 143
 144
 145 extern struct _glapi_table *
 146 _mesa_get_dispatch(GLcontext *ctx);
 147
 148
 149
 150 /** \name Miscellaneous */
 151 /*@{*/
 152
 153 extern void
 154 _mesa_record_error( GLcontext *ctx, GLenum error );
 155
 156 extern void GLAPIENTRY
 157 _mesa_Finish( void );
 158
 159 extern void GLAPIENTRY
 160 _mesa_Flush( void );
 161
 162 /*@}*/
 163
 164
 165
 166 /**
 167  * \name Macros for flushing buffered rendering commands before state changes,
 168  * checking if inside glBegin/glEnd, etc.
 169  */
 170 /*@{*/
 171
 172 /**
 173  * Flush vertices.
 174  *
 175  * \param ctx GL context.
 176  * \param newstate new state.
 177  *
 178  * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
 179  * and calls dd_function_table::FlushVertices if so. Marks
 180  * __GLcontextRec::NewState with \p newstate.
 181  */
 182 #define FLUSH_VERTICES(ctx, newstate)                           \
 183 do {                                                            \
 184    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 185       _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
 186    if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES)           \
 187       ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES);    \
 188    ctx->NewState |= newstate;                                   \
 189 } while (0)
 190
 191 /**
 192  * Flush current state.
 193  *
 194  * \param ctx GL context.
 195  * \param newstate new state.
 196  *
 197  * Checks if dd_function_table::NeedFlush is marked to flush current state,
 198  * and calls dd_function_table::FlushVertices if so. Marks
 199  * __GLcontextRec::NewState with \p newstate.
 200  */
 201 #define FLUSH_CURRENT(ctx, newstate)                            \
 202 do {                                                            \
 203    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 204       _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
 205    if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT)            \
 206       ctx->Driver.FlushVertices(ctx, FLUSH_UPDATE_CURRENT);     \
 207    ctx->NewState |= newstate;                                   \
 208 } while (0)
 209
 210 /**
 211  * Macro to assert that the API call was made outside the
 212  * glBegin()/glEnd() pair, with return value.
 213  *
 214  * \param ctx GL context.
 215  * \param retval value to return value in case the assertion fails.
 216  */
 217 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)               \
 218 do {                                                                    \
 219    if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {    \
 220       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 221       return retval;                                                    \
 222    }                                                                    \
 223 } while (0)
 224
 225 /**
 226  * Macro to assert that the API call was made outside the
 227  * glBegin()/glEnd() pair.
 228  *
 229  * \param ctx GL context.
 230  */
 231 #define ASSERT_OUTSIDE_BEGIN_END(ctx)                                   \
 232 do {                                                                    \
 233    if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {    \
 234       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 235       return;                                                           \
 236    }                                                                    \
 237 } while (0)
 238
 239 /**
 240  * Macro to assert that the API call was made outside the
 241  * glBegin()/glEnd() pair and flush the vertices.
 242  *
 243  * \param ctx GL context.
 244  */
 245 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx)                         \
 246 do {                                                                    \
 247    ASSERT_OUTSIDE_BEGIN_END(ctx);                                       \
 248    FLUSH_VERTICES(ctx, 0);                                              \
 249 } while (0)
 250
 251 /**
 252  * Macro to assert that the API call was made outside the
 253  * glBegin()/glEnd() pair and flush the vertices, with return value.
 254  *
 255  * \param ctx GL context.
 256  * \param retval value to return value in case the assertion fails.
 257  */
 258 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval)     \
 259 do {                                                                    \
 260    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval);                   \
 261    FLUSH_VERTICES(ctx, 0);                                              \
 262 } while (0)
 263
 264 /*@}*/
 265
 266
 267
 268 /**
 269  * Is the secondary color needed?
 270  */
 271 #define NEED_SECONDARY_COLOR(CTX)                                       \
 272    (((CTX)->Light.Enabled &&                                            \
 273      (CTX)->Light.Model.ColorControl == GL_SEPARATE_SPECULAR_COLOR)     \
 274     || (CTX)->Fog.ColorSumEnabled                                       \
 275     || ((CTX)->VertexProgram._Current &&                                \
 276         ((CTX)->VertexProgram._Current != (CTX)->VertexProgram._TnlProgram) &&    \
 277         ((CTX)->VertexProgram._Current->Base.InputsRead & VERT_BIT_COLOR1)) \
 278     || ((CTX)->FragmentProgram._Current &&                              \
 279         ((CTX)->FragmentProgram._Current != (CTX)->FragmentProgram._TexEnvProgram) &&  \
 280         ((CTX)->FragmentProgram._Current->Base.InputsRead & FRAG_BIT_COL1)) \
 281    )
 282
 283
 284 /**
 285  * Is RGBA LogicOp enabled?
 286  */
 287 #define RGBA_LOGICOP_ENABLED(CTX) \
 288   ((CTX)->Color.ColorLogicOpEnabled || \
 289    ((CTX)->Color.BlendEnabled && (CTX)->Color.BlendEquationRGB == GL_LOGIC_OP))
 290
 291
 292 #endif /* CONTEXT_H */