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
156
157 /** \name Miscellaneous */
158 /*@{*/
159
160 extern void
161 _mesa_record_error( struct gl_context *ctx, GLenum error );
162
163
164 extern void
165 _mesa_finish(struct gl_context *ctx);
166
167 extern void
168 _mesa_flush(struct gl_context *ctx);
169
170 extern void GLAPIENTRY
171 _mesa_Finish( void );
172
173 extern void GLAPIENTRY
174 _mesa_Flush( void );
175
176 /*@}*/
177
178
179 /**
180 * Are we currently between glBegin and glEnd?
181 * During execution, not display list compilation.
182 */
183 static inline GLboolean
_mesa_inside_begin_end(const struct gl_context * ctx)184 _mesa_inside_begin_end(const struct gl_context *ctx)
185 {
186 return ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END;
187 }
188
189
190 /**
191 * Are we currently between glBegin and glEnd in a display list?
192 */
193 static inline GLboolean
_mesa_inside_dlist_begin_end(const struct gl_context * ctx)194 _mesa_inside_dlist_begin_end(const struct gl_context *ctx)
195 {
196 return ctx->Driver.CurrentSavePrimitive <= PRIM_MAX;
197 }
198
199
200
201 /**
202 * \name Macros for flushing buffered rendering commands before state changes,
203 * checking if inside glBegin/glEnd, etc.
204 */
205 /*@{*/
206
207 /**
208 * Flush vertices.
209 *
210 * \param ctx GL context.
211 * \param newstate new state.
212 *
213 * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
214 * and calls dd_function_table::FlushVertices if so. Marks
215 * __struct gl_contextRec::NewState with \p newstate.
216 */
217 #define FLUSH_VERTICES(ctx, newstate) \
218 do { \
219 if (MESA_VERBOSE & VERBOSE_STATE) \
220 _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
221 if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES) \
222 vbo_exec_FlushVertices(ctx, FLUSH_STORED_VERTICES); \
223 ctx->NewState |= newstate; \
224 } while (0)
225
226 /**
227 * Flush current state.
228 *
229 * \param ctx GL context.
230 * \param newstate new state.
231 *
232 * Checks if dd_function_table::NeedFlush is marked to flush current state,
233 * and calls dd_function_table::FlushVertices if so. Marks
234 * __struct gl_contextRec::NewState with \p newstate.
235 */
236 #define FLUSH_CURRENT(ctx, newstate) \
237 do { \
238 if (MESA_VERBOSE & VERBOSE_STATE) \
239 _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
240 if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT) \
241 vbo_exec_FlushVertices(ctx, FLUSH_UPDATE_CURRENT); \
242 ctx->NewState |= newstate; \
243 } while (0)
244
245 /**
246 * Macro to assert that the API call was made outside the
247 * glBegin()/glEnd() pair, with return value.
248 *
249 * \param ctx GL context.
250 * \param retval value to return in case the assertion fails.
251 */
252 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval) \
253 do { \
254 if (_mesa_inside_begin_end(ctx)) { \
255 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
256 return retval; \
257 } \
258 } while (0)
259
260 /**
261 * Macro to assert that the API call was made outside the
262 * glBegin()/glEnd() pair.
263 *
264 * \param ctx GL context.
265 */
266 #define ASSERT_OUTSIDE_BEGIN_END(ctx) \
267 do { \
268 if (_mesa_inside_begin_end(ctx)) { \
269 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
270 return; \
271 } \
272 } while (0)
273
274 /*@}*/
275
276
277 /**
278 * Checks if the context is for Desktop GL (Compatibility or Core)
279 */
280 static inline bool
_mesa_is_desktop_gl(const struct gl_context * ctx)281 _mesa_is_desktop_gl(const struct gl_context *ctx)
282 {
283 return ctx->API == API_OPENGL_COMPAT || ctx->API == API_OPENGL_CORE;
284 }
285
286
287 /**
288 * Checks if the context is for any GLES version
289 */
290 static inline bool
_mesa_is_gles(const struct gl_context * ctx)291 _mesa_is_gles(const struct gl_context *ctx)
292 {
293 return ctx->API == API_OPENGLES || ctx->API == API_OPENGLES2;
294 }
295
296
297 /**
298 * Checks if the context is for GLES 3.0 or later
299 */
300 static inline bool
_mesa_is_gles3(const struct gl_context * ctx)301 _mesa_is_gles3(const struct gl_context *ctx)
302 {
303 return ctx->API == API_OPENGLES2 && ctx->Version >= 30;
304 }
305
306
307 /**
308 * Checks if the context is for GLES 3.1 or later
309 */
310 static inline bool
_mesa_is_gles31(const struct gl_context * ctx)311 _mesa_is_gles31(const struct gl_context *ctx)
312 {
313 return ctx->API == API_OPENGLES2 && ctx->Version >= 31;
314 }
315
316
317 /**
318 * Checks if the context is for GLES 3.2 or later
319 */
320 static inline bool
_mesa_is_gles32(const struct gl_context * ctx)321 _mesa_is_gles32(const struct gl_context *ctx)
322 {
323 return ctx->API == API_OPENGLES2 && ctx->Version >= 32;
324 }
325
326
327 /**
328 * Checks if the context supports geometry shaders.
329 */
330 static inline bool
_mesa_has_geometry_shaders(const struct gl_context * ctx)331 _mesa_has_geometry_shaders(const struct gl_context *ctx)
332 {
333 return _mesa_has_OES_geometry_shader(ctx) ||
334 (_mesa_is_desktop_gl(ctx) && ctx->Version >= 32);
335 }
336
337
338 /**
339 * Checks if the context supports compute shaders.
340 */
341 static inline bool
_mesa_has_compute_shaders(const struct gl_context * ctx)342 _mesa_has_compute_shaders(const struct gl_context *ctx)
343 {
344 return _mesa_has_ARB_compute_shader(ctx) ||
345 (ctx->API == API_OPENGLES2 && ctx->Version >= 31);
346 }
347
348 /**
349 * Checks if the context supports tessellation.
350 */
351 static inline GLboolean
_mesa_has_tessellation(const struct gl_context * ctx)352 _mesa_has_tessellation(const struct gl_context *ctx)
353 {
354 /* _mesa_has_EXT_tessellation_shader(ctx) is redundant with the OES
355 * check, so don't bother calling it.
356 */
357 return _mesa_has_OES_tessellation_shader(ctx) ||
358 _mesa_has_ARB_tessellation_shader(ctx);
359 }
360
361 static inline bool
_mesa_has_texture_cube_map_array(const struct gl_context * ctx)362 _mesa_has_texture_cube_map_array(const struct gl_context *ctx)
363 {
364 return _mesa_has_ARB_texture_cube_map_array(ctx) ||
365 _mesa_has_OES_texture_cube_map_array(ctx);
366 }
367
368 #ifdef __cplusplus
369 }
370 #endif
371
372
373 #endif /* CONTEXT_H */
374