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