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