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 "imports.h"
  53 #include "mtypes.h"
  54
  55
  56 struct _glapi_table;
  57
  58
  59 /** \name Visual-related functions */
  60 /*@{*/
  61
  62 extern GLvisual *
  63 _mesa_create_visual( GLboolean rgbFlag,
  64                      GLboolean dbFlag,
  65                      GLboolean stereoFlag,
  66                      GLint redBits,
  67                      GLint greenBits,
  68                      GLint blueBits,
  69                      GLint alphaBits,
  70                      GLint indexBits,
  71                      GLint depthBits,
  72                      GLint stencilBits,
  73                      GLint accumRedBits,
  74                      GLint accumGreenBits,
  75                      GLint accumBlueBits,
  76                      GLint accumAlphaBits,
  77                      GLint numSamples );
  78
  79 extern GLboolean
  80 _mesa_initialize_visual( GLvisual *v,
  81                          GLboolean rgbFlag,
  82                          GLboolean dbFlag,
  83                          GLboolean stereoFlag,
  84                          GLint redBits,
  85                          GLint greenBits,
  86                          GLint blueBits,
  87                          GLint alphaBits,
  88                          GLint indexBits,
  89                          GLint depthBits,
  90                          GLint stencilBits,
  91                          GLint accumRedBits,
  92                          GLint accumGreenBits,
  93                          GLint accumBlueBits,
  94                          GLint accumAlphaBits,
  95                          GLint numSamples );
  96
  97 extern void
  98 _mesa_destroy_visual( GLvisual *vis );
  99
 100 /*@}*/
 101
 102
 103 /** \name Context-related functions */
 104 /*@{*/
 105
 106 extern GLcontext *
 107 _mesa_create_context( const GLvisual *visual,
 108                       GLcontext *share_list,
 109                       const struct dd_function_table *driverFunctions,
 110                       void *driverContext );
 111
 112 extern GLboolean
 113 _mesa_initialize_context( GLcontext *ctx,
 114                           const GLvisual *visual,
 115                           GLcontext *share_list,
 116                           const struct dd_function_table *driverFunctions,
 117                           void *driverContext );
 118
 119 extern void
 120 _mesa_initialize_context_extra(GLcontext *ctx);
 121
 122 extern void
 123 _mesa_free_context_data( GLcontext *ctx );
 124
 125 extern void
 126 _mesa_destroy_context( GLcontext *ctx );
 127
 128
 129 extern void
 130 _mesa_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
 131
 132
 133 extern void
 134 _mesa_make_current( GLcontext *ctx, GLframebuffer *drawBuffer,
 135                     GLframebuffer *readBuffer );
 136
 137 extern GLboolean
 138 _mesa_share_state(GLcontext *ctx, GLcontext *ctxToShare);
 139
 140 extern GLcontext *
 141 _mesa_get_current_context(void);
 142
 143 /*@}*/
 144
 145
 146 extern void
 147 _mesa_notifySwapBuffers(__GLcontext *gc);
 148
 149
 150 extern struct _glapi_table *
 151 _mesa_get_dispatch(GLcontext *ctx);
 152
 153
 154
 155 /** \name Miscellaneous */
 156 /*@{*/
 157
 158 extern void
 159 _mesa_record_error( GLcontext *ctx, GLenum error );
 160
 161 extern void GLAPIENTRY
 162 _mesa_Finish( void );
 163
 164 extern void GLAPIENTRY
 165 _mesa_Flush( void );
 166
 167 /*@}*/
 168
 169
 170
 171 /**
 172  * \name Macros for flushing buffered rendering commands before state changes,
 173  * checking if inside glBegin/glEnd, etc.
 174  */
 175 /*@{*/
 176
 177 /**
 178  * Flush vertices.
 179  *
 180  * \param ctx GL context.
 181  * \param newstate new state.
 182  *
 183  * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
 184  * and calls dd_function_table::FlushVertices if so. Marks
 185  * __GLcontextRec::NewState with \p newstate.
 186  */
 187 #define FLUSH_VERTICES(ctx, newstate)                           \
 188 do {                                                            \
 189    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 190       _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
 191    if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES)           \
 192       ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES);    \
 193    ctx->NewState |= newstate;                                   \
 194 } while (0)
 195
 196 /**
 197  * Flush current state.
 198  *
 199  * \param ctx GL context.
 200  * \param newstate new state.
 201  *
 202  * Checks if dd_function_table::NeedFlush is marked to flush current state,
 203  * and calls dd_function_table::FlushVertices if so. Marks
 204  * __GLcontextRec::NewState with \p newstate.
 205  */
 206 #define FLUSH_CURRENT(ctx, newstate)                            \
 207 do {                                                            \
 208    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 209       _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
 210    if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT)            \
 211       ctx->Driver.FlushVertices(ctx, FLUSH_UPDATE_CURRENT);     \
 212    ctx->NewState |= newstate;                                   \
 213 } while (0)
 214
 215 /**
 216  * Macro to assert that the API call was made outside the
 217  * glBegin()/glEnd() pair, with return value.
 218  *
 219  * \param ctx GL context.
 220  * \param retval value to return value in case the assertion fails.
 221  */
 222 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)               \
 223 do {                                                                    \
 224    if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {    \
 225       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 226       return retval;                                                    \
 227    }                                                                    \
 228 } while (0)
 229
 230 /**
 231  * Macro to assert that the API call was made outside the
 232  * glBegin()/glEnd() pair.
 233  *
 234  * \param ctx GL context.
 235  */
 236 #define ASSERT_OUTSIDE_BEGIN_END(ctx)                                   \
 237 do {                                                                    \
 238    if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {    \
 239       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 240       return;                                                           \
 241    }                                                                    \
 242 } while (0)
 243
 244 /**
 245  * Macro to assert that the API call was made outside the
 246  * glBegin()/glEnd() pair and flush the vertices.
 247  *
 248  * \param ctx GL context.
 249  */
 250 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx)                         \
 251 do {                                                                    \
 252    ASSERT_OUTSIDE_BEGIN_END(ctx);                                       \
 253    FLUSH_VERTICES(ctx, 0);                                              \
 254 } while (0)
 255
 256 /**
 257  * Macro to assert that the API call was made outside the
 258  * glBegin()/glEnd() pair and flush the vertices, with return value.
 259  *
 260  * \param ctx GL context.
 261  * \param retval value to return value in case the assertion fails.
 262  */
 263 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval)     \
 264 do {                                                                    \
 265    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval);                   \
 266    FLUSH_VERTICES(ctx, 0);                                              \
 267 } while (0)
 268
 269 /*@}*/
 270
 271
 272
 273 /**
 274  * Is the secondary color needed?
 275  */
 276 #define NEED_SECONDARY_COLOR(CTX)                                       \
 277    (((CTX)->Light.Enabled &&                                            \
 278      (CTX)->Light.Model.ColorControl == GL_SEPARATE_SPECULAR_COLOR)     \
 279     || (CTX)->Fog.ColorSumEnabled                                       \
 280     || ((CTX)->VertexProgram._Current &&                                \
 281         ((CTX)->VertexProgram._Current != (CTX)->VertexProgram._TnlProgram) &&    \
 282         ((CTX)->VertexProgram._Current->Base.InputsRead & VERT_BIT_COLOR1)) \
 283     || ((CTX)->FragmentProgram._Current &&                              \
 284         ((CTX)->FragmentProgram._Current != (CTX)->FragmentProgram._TexEnvProgram) &&  \
 285         ((CTX)->FragmentProgram._Current->Base.InputsRead & FRAG_BIT_COL1)) \
 286    )
 287
 288
 289 /**
 290  * Is RGBA LogicOp enabled?
 291  */
 292 #define RGBA_LOGICOP_ENABLED(CTX) \
 293   ((CTX)->Color.ColorLogicOpEnabled || \
 294    ((CTX)->Color.BlendEnabled && (CTX)->Color.BlendEquationRGB == GL_LOGIC_OP))
 295
 296
 297 #endif /* CONTEXT_H */