reactos/dll/opengl/mesa/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
  34  *   or not there's a depth buffer, stencil buffer, etc.
  35  * - struct gl_framebuffer:  contains pointers to the depth buffer, stencil
  36  *   buffer, 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
  42  * are base classes 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 #ifdef __cplusplus
  57 extern "C" {
  58 #endif
  59
  60
  61 struct _glapi_table;
  62
  63
  64 /** \name Visual-related functions */
  65 /*@{*/
  66
  67 extern struct gl_config *
  68 _mesa_create_visual( GLboolean dbFlag,
  69                      GLboolean stereoFlag,
  70                      GLint redBits,
  71                      GLint greenBits,
  72                      GLint blueBits,
  73                      GLint alphaBits,
  74                      GLint depthBits,
  75                      GLint stencilBits,
  76                      GLint accumRedBits,
  77                      GLint accumGreenBits,
  78                      GLint accumBlueBits,
  79                      GLint accumAlphaBits,
  80                      GLint numSamples );
  81
  82 extern GLboolean
  83 _mesa_initialize_visual( struct gl_config *v,
  84                          GLboolean dbFlag,
  85                          GLboolean stereoFlag,
  86                          GLint redBits,
  87                          GLint greenBits,
  88                          GLint blueBits,
  89                          GLint alphaBits,
  90                          GLint depthBits,
  91                          GLint stencilBits,
  92                          GLint accumRedBits,
  93                          GLint accumGreenBits,
  94                          GLint accumBlueBits,
  95                          GLint accumAlphaBits,
  96                          GLint numSamples );
  97
  98 extern void
  99 _mesa_destroy_visual( struct gl_config *vis );
 100
 101 /*@}*/
 102
 103
 104 /** \name Context-related functions */
 105 /*@{*/
 106
 107 extern GLboolean
 108 _mesa_initialize_context( struct gl_context *ctx,
 109                           gl_api api,
 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(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 void
 123 _mesa_free_context_data( struct gl_context *ctx );
 124
 125 extern void
 126 _mesa_destroy_context( struct gl_context *ctx );
 127
 128
 129 extern void
 130 _mesa_copy_context(const struct gl_context *src, struct gl_context *dst, GLuint mask);
 131
 132
 133 extern void
 134 _mesa_check_init_viewport(struct gl_context *ctx, GLuint width, GLuint height);
 135
 136 extern GLboolean
 137 _mesa_make_current( struct gl_context *ctx, struct gl_framebuffer *drawBuffer,
 138                     struct gl_framebuffer *readBuffer );
 139
 140 extern GLboolean
 141 _mesa_share_state(struct gl_context *ctx, struct gl_context *ctxToShare);
 142
 143 extern struct gl_context *
 144 _mesa_get_current_context(void);
 145
 146 /*@}*/
 147
 148 extern void
 149 _mesa_init_get_hash(struct gl_context *ctx);
 150
 151 extern void
 152 _mesa_notifySwapBuffers(struct gl_context *gc);
 153
 154
 155 extern struct _glapi_table *
 156 _mesa_get_dispatch(struct gl_context *ctx);
 157
 158
 159 void
 160 _mesa_set_mvp_with_dp4( struct gl_context *ctx,
 161                         GLboolean flag );
 162
 163
 164 extern GLboolean
 165 _mesa_valid_to_render(struct gl_context *ctx, const char *where);
 166
 167
 168
 169 /** \name Miscellaneous */
 170 /*@{*/
 171
 172 extern void
 173 _mesa_record_error( struct gl_context *ctx, GLenum error );
 174
 175
 176 extern void
 177 _mesa_finish(struct gl_context *ctx);
 178
 179 extern void
 180 _mesa_flush(struct gl_context *ctx);
 181
 182
 183 extern void GLAPIENTRY
 184 _mesa_Finish( void );
 185
 186 extern void GLAPIENTRY
 187 _mesa_Flush( void );
 188
 189 /*@}*/
 190
 191
 192 /**
 193  * \name Macros for flushing buffered rendering commands before state changes,
 194  * checking if inside glBegin/glEnd, etc.
 195  */
 196 /*@{*/
 197
 198 /**
 199  * Flush vertices.
 200  *
 201  * \param ctx GL context.
 202  * \param newstate new state.
 203  *
 204  * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
 205  * and calls dd_function_table::FlushVertices if so. Marks
 206  * __struct gl_contextRec::NewState with \p newstate.
 207  */
 208 #define FLUSH_VERTICES(ctx, newstate)                           \
 209 do {                                                            \
 210    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 211       _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
 212    if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES)           \
 213       ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES);    \
 214    ctx->NewState |= newstate;                                   \
 215 } while (0)
 216
 217 /**
 218  * Flush current state.
 219  *
 220  * \param ctx GL context.
 221  * \param newstate new state.
 222  *
 223  * Checks if dd_function_table::NeedFlush is marked to flush current state,
 224  * and calls dd_function_table::FlushVertices if so. Marks
 225  * __struct gl_contextRec::NewState with \p newstate.
 226  */
 227 #define FLUSH_CURRENT(ctx, newstate)                            \
 228 do {                                                            \
 229    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 230       _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
 231    if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT)            \
 232       ctx->Driver.FlushVertices(ctx, FLUSH_UPDATE_CURRENT);     \
 233    ctx->NewState |= newstate;                                   \
 234 } while (0)
 235
 236 /**
 237  * Macro to assert that the API call was made outside the
 238  * glBegin()/glEnd() pair, with return value.
 239  *
 240  * \param ctx GL context.
 241  * \param retval value to return in case the assertion fails.
 242  */
 243 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)               \
 244 do {                                                                    \
 245    if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {    \
 246       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 247       return retval;                                                    \
 248    }                                                                    \
 249 } while (0)
 250
 251 /**
 252  * Macro to assert that the API call was made outside the
 253  * glBegin()/glEnd() pair.
 254  *
 255  * \param ctx GL context.
 256  */
 257 #define ASSERT_OUTSIDE_BEGIN_END(ctx)                                   \
 258 do {                                                                    \
 259    if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {    \
 260       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 261       return;                                                           \
 262    }                                                                    \
 263 } while (0)
 264
 265 /**
 266  * Macro to assert that the API call was made outside the
 267  * glBegin()/glEnd() pair and flush the vertices.
 268  *
 269  * \param ctx GL context.
 270  */
 271 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx)                         \
 272 do {                                                                    \
 273    ASSERT_OUTSIDE_BEGIN_END(ctx);                                       \
 274    FLUSH_VERTICES(ctx, 0);                                              \
 275 } while (0)
 276
 277 /**
 278  * Macro to assert that the API call was made outside the
 279  * glBegin()/glEnd() pair and flush the vertices, with return value.
 280  *
 281  * \param ctx GL context.
 282  * \param retval value to return in case the assertion fails.
 283  */
 284 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval)     \
 285 do {                                                                    \
 286    ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval);                   \
 287    FLUSH_VERTICES(ctx, 0);                                              \
 288 } while (0)
 289
 290 /*@}*/
 291
 292
 293 #ifdef __cplusplus
 294 }
 295 #endif
 296
 297
 298 #endif /* CONTEXT_H */