src/mesa/main/context.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * 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 "extensions.h"
  54 #include "mtypes.h"
  55 #include "vbo/vbo.h"
  56
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61
  62
  63 struct _glapi_table;
  64
  65
  66 /** \name Visual-related functions */
  67 /*@{*/
  68
  69 extern struct gl_config *
  70 _mesa_create_visual( GLboolean dbFlag,
  71                      GLboolean stereoFlag,
  72                      GLint redBits,
  73                      GLint greenBits,
  74                      GLint blueBits,
  75                      GLint alphaBits,
  76                      GLint depthBits,
  77                      GLint stencilBits,
  78                      GLint accumRedBits,
  79                      GLint accumGreenBits,
  80                      GLint accumBlueBits,
  81                      GLint accumAlphaBits,
  82                      GLint numSamples );
  83
  84 extern GLboolean
  85 _mesa_initialize_visual( struct gl_config *v,
  86                          GLboolean dbFlag,
  87                          GLboolean stereoFlag,
  88                          GLint redBits,
  89                          GLint greenBits,
  90                          GLint blueBits,
  91                          GLint alphaBits,
  92                          GLint depthBits,
  93                          GLint stencilBits,
  94                          GLint accumRedBits,
  95                          GLint accumGreenBits,
  96                          GLint accumBlueBits,
  97                          GLint accumAlphaBits,
  98                          GLint numSamples );
  99
 100 extern void
 101 _mesa_destroy_visual( struct gl_config *vis );
 102
 103 /*@}*/
 104
 105
 106 /** \name Context-related functions */
 107 /*@{*/
 108
 109 extern GLboolean
 110 _mesa_initialize_context( struct gl_context *ctx,
 111                           gl_api api,
 112                           const struct gl_config *visual,
 113                           struct gl_context *share_list,
 114                           const struct dd_function_table *driverFunctions);
 115
 116 extern void
 117 _mesa_free_context_data( struct gl_context *ctx );
 118
 119 extern void
 120 _mesa_destroy_context( struct gl_context *ctx );
 121
 122
 123 extern void
 124 _mesa_copy_context(const struct gl_context *src, struct gl_context *dst, GLuint mask);
 125
 126
 127 extern void
 128 _mesa_check_init_viewport(struct gl_context *ctx, GLuint width, GLuint height);
 129
 130 extern GLboolean
 131 _mesa_make_current( struct gl_context *ctx, struct gl_framebuffer *drawBuffer,
 132                     struct gl_framebuffer *readBuffer );
 133
 134 extern GLboolean
 135 _mesa_share_state(struct gl_context *ctx, struct gl_context *ctxToShare);
 136
 137 extern struct gl_context *
 138 _mesa_get_current_context(void);
 139
 140 /*@}*/
 141
 142 extern void
 143 _mesa_init_constants(struct gl_constants *consts, gl_api api);
 144
 145 extern void
 146 _mesa_notifySwapBuffers(struct gl_context *gc);
 147
 148
 149 extern struct _glapi_table *
 150 _mesa_get_dispatch(struct gl_context *ctx);
 151
 152 extern void
 153 _mesa_set_context_lost_dispatch(struct gl_context *ctx);
 154
 155 extern GLboolean
 156 _mesa_valid_to_render(struct gl_context *ctx, const char *where);
 157
 158
 159
 160 /** \name Miscellaneous */
 161 /*@{*/
 162
 163 extern void
 164 _mesa_record_error( struct gl_context *ctx, GLenum error );
 165
 166
 167 extern void
 168 _mesa_finish(struct gl_context *ctx);
 169
 170 extern void
 171 _mesa_flush(struct gl_context *ctx);
 172
 173 extern void GLAPIENTRY
 174 _mesa_Finish( void );
 175
 176 extern void GLAPIENTRY
 177 _mesa_Flush( void );
 178
 179 /*@}*/
 180
 181
 182 /**
 183  * Are we currently between glBegin and glEnd?
 184  * During execution, not display list compilation.
 185  */
 186 static inline GLboolean
 187 _mesa_inside_begin_end(const struct gl_context *ctx)
 188 {
 189    return ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END;
 190 }
 191
 192
 193 /**
 194  * Are we currently between glBegin and glEnd in a display list?
 195  */
 196 static inline GLboolean
 197 _mesa_inside_dlist_begin_end(const struct gl_context *ctx)
 198 {
 199    return ctx->Driver.CurrentSavePrimitive <= PRIM_MAX;
 200 }
 201
 202
 203
 204 /**
 205  * \name Macros for flushing buffered rendering commands before state changes,
 206  * checking if inside glBegin/glEnd, etc.
 207  */
 208 /*@{*/
 209
 210 /**
 211  * Flush vertices.
 212  *
 213  * \param ctx GL context.
 214  * \param newstate new state.
 215  *
 216  * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
 217  * and calls dd_function_table::FlushVertices if so. Marks
 218  * __struct gl_contextRec::NewState with \p newstate.
 219  */
 220 #define FLUSH_VERTICES(ctx, newstate)                           \
 221 do {                                                            \
 222    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 223       _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
 224    if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES)           \
 225       vbo_exec_FlushVertices(ctx, FLUSH_STORED_VERTICES);       \
 226    ctx->NewState |= newstate;                                   \
 227 } while (0)
 228
 229 /**
 230  * Flush current state.
 231  *
 232  * \param ctx GL context.
 233  * \param newstate new state.
 234  *
 235  * Checks if dd_function_table::NeedFlush is marked to flush current state,
 236  * and calls dd_function_table::FlushVertices if so. Marks
 237  * __struct gl_contextRec::NewState with \p newstate.
 238  */
 239 #define FLUSH_CURRENT(ctx, newstate)                            \
 240 do {                                                            \
 241    if (MESA_VERBOSE & VERBOSE_STATE)                            \
 242       _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
 243    if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT)            \
 244       vbo_exec_FlushVertices(ctx, FLUSH_UPDATE_CURRENT);        \
 245    ctx->NewState |= newstate;                                   \
 246 } while (0)
 247
 248 /**
 249  * Macro to assert that the API call was made outside the
 250  * glBegin()/glEnd() pair, with return value.
 251  *
 252  * \param ctx GL context.
 253  * \param retval value to return in case the assertion fails.
 254  */
 255 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)               \
 256 do {                                                                    \
 257    if (_mesa_inside_begin_end(ctx)) {                                   \
 258       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 259       return retval;                                                    \
 260    }                                                                    \
 261 } while (0)
 262
 263 /**
 264  * Macro to assert that the API call was made outside the
 265  * glBegin()/glEnd() pair.
 266  *
 267  * \param ctx GL context.
 268  */
 269 #define ASSERT_OUTSIDE_BEGIN_END(ctx)                                   \
 270 do {                                                                    \
 271    if (_mesa_inside_begin_end(ctx)) {                                   \
 272       _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");   \
 273       return;                                                           \
 274    }                                                                    \
 275 } while (0)
 276
 277 /*@}*/
 278
 279
 280 /**
 281  * Checks if the context is for Desktop GL (Compatibility or Core)
 282  */
 283 static inline bool
 284 _mesa_is_desktop_gl(const struct gl_context *ctx)
 285 {
 286    return ctx->API == API_OPENGL_COMPAT || ctx->API == API_OPENGL_CORE;
 287 }
 288
 289
 290 /**
 291  * Checks if the context is for any GLES version
 292  */
 293 static inline bool
 294 _mesa_is_gles(const struct gl_context *ctx)
 295 {
 296    return ctx->API == API_OPENGLES || ctx->API == API_OPENGLES2;
 297 }
 298
 299
 300 /**
 301  * Checks if the context is for GLES 3.0 or later
 302  */
 303 static inline bool
 304 _mesa_is_gles3(const struct gl_context *ctx)
 305 {
 306    return ctx->API == API_OPENGLES2 && ctx->Version >= 30;
 307 }
 308
 309
 310 /**
 311  * Checks if the context is for GLES 3.1 or later
 312  */
 313 static inline bool
 314 _mesa_is_gles31(const struct gl_context *ctx)
 315 {
 316    return ctx->API == API_OPENGLES2 && ctx->Version >= 31;
 317 }
 318
 319
 320 /**
 321  * Checks if the context supports geometry shaders.
 322  */
 323 static inline bool
 324 _mesa_has_geometry_shaders(const struct gl_context *ctx)
 325 {
 326    return _mesa_has_OES_geometry_shader(ctx) ||
 327           (_mesa_is_desktop_gl(ctx) && ctx->Version >= 32);
 328 }
 329
 330
 331 /**
 332  * Checks if the context supports compute shaders.
 333  */
 334 static inline bool
 335 _mesa_has_compute_shaders(const struct gl_context *ctx)
 336 {
 337    return _mesa_has_ARB_compute_shader(ctx) ||
 338       (ctx->API == API_OPENGLES2 && ctx->Version >= 31);
 339 }
 340
 341 /**
 342  * Checks if the context supports shader subroutines.
 343  */
 344 static inline bool
 345 _mesa_has_shader_subroutine(const struct gl_context *ctx)
 346 {
 347    return ctx->API == API_OPENGL_CORE &&
 348       (ctx->Version >= 40 || ctx->Extensions.ARB_shader_subroutine);
 349 }
 350
 351 /**
 352  * Checks if the context supports tessellation.
 353  */
 354 static inline GLboolean
 355 _mesa_has_tessellation(const struct gl_context *ctx)
 356 {
 357    /* _mesa_has_EXT_tessellation_shader(ctx) is redundant with the OES
 358     * check, so don't bother calling it.
 359     */
 360    return _mesa_has_OES_tessellation_shader(ctx) ||
 361           _mesa_has_ARB_tessellation_shader(ctx);
 362 }
 363
 364
 365 #ifdef __cplusplus
 366 }
 367 #endif
 368
 369
 370 #endif /* CONTEXT_H */