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 "errors.h"
53#include "imports.h"
54#include "extensions.h"
55#include "mtypes.h"
56#include "vbo/vbo.h"
57
58
59#ifdef __cplusplus
60extern "C" {
61#endif
62
63
64struct _glapi_table;
65
66
67/** \name Visual-related functions */
68/*@{*/
69
70extern struct gl_config *
71_mesa_create_visual( GLboolean dbFlag,
72                     GLboolean stereoFlag,
73                     GLint redBits,
74                     GLint greenBits,
75                     GLint blueBits,
76                     GLint alphaBits,
77                     GLint depthBits,
78                     GLint stencilBits,
79                     GLint accumRedBits,
80                     GLint accumGreenBits,
81                     GLint accumBlueBits,
82                     GLint accumAlphaBits,
83                     GLuint numSamples );
84
85extern GLboolean
86_mesa_initialize_visual( struct gl_config *v,
87                         GLboolean dbFlag,
88                         GLboolean stereoFlag,
89                         GLint redBits,
90                         GLint greenBits,
91                         GLint blueBits,
92                         GLint alphaBits,
93                         GLint depthBits,
94                         GLint stencilBits,
95                         GLint accumRedBits,
96                         GLint accumGreenBits,
97                         GLint accumBlueBits,
98                         GLint accumAlphaBits,
99                         GLuint numSamples );
100
101extern void
102_mesa_destroy_visual( struct gl_config *vis );
103
104/*@}*/
105
106
107/** \name Context-related functions */
108/*@{*/
109
110extern GLboolean
111_mesa_initialize_context( struct gl_context *ctx,
112                          gl_api api,
113                          const struct gl_config *visual,
114                          struct gl_context *share_list,
115                          const struct dd_function_table *driverFunctions);
116
117extern void
118_mesa_free_context_data(struct gl_context *ctx, bool destroy_compiler_types);
119
120extern void
121_mesa_destroy_context( struct gl_context *ctx );
122
123
124extern void
125_mesa_copy_context(const struct gl_context *src, struct gl_context *dst, GLuint mask);
126
127extern GLboolean
128_mesa_make_current( struct gl_context *ctx, struct gl_framebuffer *drawBuffer,
129                    struct gl_framebuffer *readBuffer );
130
131extern GLboolean
132_mesa_share_state(struct gl_context *ctx, struct gl_context *ctxToShare);
133
134extern struct gl_context *
135_mesa_get_current_context(void);
136
137/*@}*/
138
139extern void
140_mesa_init_constants(struct gl_constants *consts, gl_api api);
141
142extern void
143_mesa_notifySwapBuffers(struct gl_context *gc);
144
145
146extern struct _glapi_table *
147_mesa_get_dispatch(struct gl_context *ctx);
148
149extern void
150_mesa_set_context_lost_dispatch(struct gl_context *ctx);
151
152
153
154/** \name Miscellaneous */
155/*@{*/
156
157extern void
158_mesa_flush(struct gl_context *ctx);
159
160extern void GLAPIENTRY
161_mesa_Finish( void );
162
163extern void GLAPIENTRY
164_mesa_Flush( void );
165
166/*@}*/
167
168
169/**
170 * Are we currently between glBegin and glEnd?
171 * During execution, not display list compilation.
172 */
173static inline GLboolean
174_mesa_inside_begin_end(const struct gl_context *ctx)
175{
176   return ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END;
177}
178
179
180/**
181 * Are we currently between glBegin and glEnd in a display list?
182 */
183static inline GLboolean
184_mesa_inside_dlist_begin_end(const struct gl_context *ctx)
185{
186   return ctx->Driver.CurrentSavePrimitive <= PRIM_MAX;
187}
188
189
190
191/**
192 * \name Macros for flushing buffered rendering commands before state changes,
193 * checking if inside glBegin/glEnd, etc.
194 */
195/*@{*/
196
197/**
198 * Flush vertices.
199 *
200 * \param ctx GL context.
201 * \param newstate new state.
202 *
203 * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
204 * and calls dd_function_table::FlushVertices if so. Marks
205 * __struct gl_contextRec::NewState with \p newstate.
206 */
207#define FLUSH_VERTICES(ctx, newstate)				\
208do {								\
209   if (MESA_VERBOSE & VERBOSE_STATE)				\
210      _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", __func__);	\
211   if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES)		\
212      vbo_exec_FlushVertices(ctx, FLUSH_STORED_VERTICES);	\
213   ctx->NewState |= newstate;					\
214} while (0)
215
216/**
217 * Flush current state.
218 *
219 * \param ctx GL context.
220 * \param newstate new state.
221 *
222 * Checks if dd_function_table::NeedFlush is marked to flush current state,
223 * and calls dd_function_table::FlushVertices if so. Marks
224 * __struct gl_contextRec::NewState with \p newstate.
225 */
226#define FLUSH_CURRENT(ctx, newstate)				\
227do {								\
228   if (MESA_VERBOSE & VERBOSE_STATE)				\
229      _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", __func__);	\
230   if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT)		\
231      vbo_exec_FlushVertices(ctx, FLUSH_UPDATE_CURRENT);	\
232   ctx->NewState |= newstate;					\
233} while (0)
234
235/**
236 * Flush vertices.
237 *
238 * \param ctx GL context.
239 *
240 * Checks if dd_function_table::NeedFlush is marked to flush stored vertices
241 * or current state and calls dd_function_table::FlushVertices if so.
242 */
243#define FLUSH_FOR_DRAW(ctx)                                     \
244do {                                                            \
245   if (MESA_VERBOSE & VERBOSE_STATE)                            \
246      _mesa_debug(ctx, "FLUSH_FOR_DRAW in %s\n", __func__);     \
247   if (ctx->Driver.NeedFlush)                                   \
248      vbo_exec_FlushVertices(ctx, ctx->Driver.NeedFlush);       \
249} while (0)
250
251/**
252 * Macro to assert that the API call was made outside the
253 * glBegin()/glEnd() pair, with return value.
254 *
255 * \param ctx GL context.
256 * \param retval value to return in case the assertion fails.
257 */
258#define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)		\
259do {									\
260   if (_mesa_inside_begin_end(ctx)) {					\
261      _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");	\
262      return retval;							\
263   }									\
264} while (0)
265
266/**
267 * Macro to assert that the API call was made outside the
268 * glBegin()/glEnd() pair.
269 *
270 * \param ctx GL context.
271 */
272#define ASSERT_OUTSIDE_BEGIN_END(ctx)					\
273do {									\
274   if (_mesa_inside_begin_end(ctx)) {					\
275      _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");	\
276      return;								\
277   }									\
278} while (0)
279
280/*@}*/
281
282
283/**
284 * Checks if the context is for Desktop GL (Compatibility or Core)
285 */
286static inline bool
287_mesa_is_desktop_gl(const struct gl_context *ctx)
288{
289   return ctx->API == API_OPENGL_COMPAT || ctx->API == API_OPENGL_CORE;
290}
291
292
293/**
294 * Checks if the context is for any GLES version
295 */
296static inline bool
297_mesa_is_gles(const struct gl_context *ctx)
298{
299   return ctx->API == API_OPENGLES || ctx->API == API_OPENGLES2;
300}
301
302
303/**
304 * Checks if the context is for GLES 3.0 or later
305 */
306static inline bool
307_mesa_is_gles3(const struct gl_context *ctx)
308{
309   return ctx->API == API_OPENGLES2 && ctx->Version >= 30;
310}
311
312
313/**
314 * Checks if the context is for GLES 3.1 or later
315 */
316static inline bool
317_mesa_is_gles31(const struct gl_context *ctx)
318{
319   return ctx->API == API_OPENGLES2 && ctx->Version >= 31;
320}
321
322
323/**
324 * Checks if the context is for GLES 3.2 or later
325 */
326static inline bool
327_mesa_is_gles32(const struct gl_context *ctx)
328{
329   return ctx->API == API_OPENGLES2 && ctx->Version >= 32;
330}
331
332
333static inline bool
334_mesa_is_no_error_enabled(const struct gl_context *ctx)
335{
336   return ctx->Const.ContextFlags & GL_CONTEXT_FLAG_NO_ERROR_BIT_KHR;
337}
338
339
340static inline bool
341_mesa_has_integer_textures(const struct gl_context *ctx)
342{
343   return _mesa_has_EXT_texture_integer(ctx) || _mesa_is_gles3(ctx);
344}
345
346static inline bool
347_mesa_has_half_float_textures(const struct gl_context *ctx)
348{
349   return _mesa_has_ARB_texture_float(ctx) ||
350          _mesa_has_OES_texture_half_float(ctx) || _mesa_is_gles3(ctx);
351}
352
353static inline bool
354_mesa_has_float_textures(const struct gl_context *ctx)
355{
356   return _mesa_has_ARB_texture_float(ctx) ||
357          _mesa_has_OES_texture_float(ctx) || _mesa_is_gles3(ctx);
358 }
359
360static inline bool
361_mesa_has_texture_rgb10_a2ui(const struct gl_context *ctx)
362{
363   return _mesa_has_ARB_texture_rgb10_a2ui(ctx) || _mesa_is_gles3(ctx);
364}
365
366static inline bool
367_mesa_has_float_depth_buffer(const struct gl_context *ctx)
368{
369   return _mesa_has_ARB_depth_buffer_float(ctx) || _mesa_is_gles3(ctx);
370}
371
372static inline bool
373_mesa_has_packed_float(const struct gl_context *ctx)
374{
375   return _mesa_has_EXT_packed_float(ctx) || _mesa_is_gles3(ctx);
376}
377
378static inline bool
379_mesa_has_rg_textures(const struct gl_context *ctx)
380{
381   return _mesa_has_ARB_texture_rg(ctx) || _mesa_has_EXT_texture_rg(ctx) ||
382          _mesa_is_gles3(ctx);
383}
384
385static inline bool
386_mesa_has_texture_shared_exponent(const struct gl_context *ctx)
387{
388   return _mesa_has_EXT_texture_shared_exponent(ctx) || _mesa_is_gles3(ctx);
389}
390
391static inline bool
392_mesa_has_texture_type_2_10_10_10_REV(const struct gl_context *ctx)
393{
394   return _mesa_is_desktop_gl(ctx) ||
395          _mesa_has_EXT_texture_type_2_10_10_10_REV(ctx);
396}
397
398/**
399 * Checks if the context supports geometry shaders.
400 */
401static inline bool
402_mesa_has_geometry_shaders(const struct gl_context *ctx)
403{
404   return _mesa_has_OES_geometry_shader(ctx) ||
405          (_mesa_is_desktop_gl(ctx) && ctx->Version >= 32);
406}
407
408
409/**
410 * Checks if the context supports compute shaders.
411 */
412static inline bool
413_mesa_has_compute_shaders(const struct gl_context *ctx)
414{
415   return _mesa_has_ARB_compute_shader(ctx) ||
416      (ctx->API == API_OPENGLES2 && ctx->Version >= 31);
417}
418
419/**
420 * Checks if the context supports tessellation.
421 */
422static inline bool
423_mesa_has_tessellation(const struct gl_context *ctx)
424{
425   /* _mesa_has_EXT_tessellation_shader(ctx) is redundant with the OES
426    * check, so don't bother calling it.
427    */
428   return _mesa_has_OES_tessellation_shader(ctx) ||
429          _mesa_has_ARB_tessellation_shader(ctx);
430}
431
432static inline bool
433_mesa_has_texture_cube_map_array(const struct gl_context *ctx)
434{
435   return _mesa_has_ARB_texture_cube_map_array(ctx) ||
436          _mesa_has_OES_texture_cube_map_array(ctx);
437}
438
439static inline bool
440_mesa_has_texture_view(const struct gl_context *ctx)
441{
442   return _mesa_has_ARB_texture_view(ctx) ||
443          _mesa_has_OES_texture_view(ctx);
444}
445
446#ifdef __cplusplus
447}
448#endif
449
450
451#endif /* CONTEXT_H */
452