2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
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:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
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.
28 * Mesa context and visual-related functions.
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.
38 * These types should be encapsulated by corresponding device driver
39 * data types. See xmesa.h and xmesaP.h for an example.
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.
44 * The following functions create and destroy these data types.
64 /** \name Visual-related functions */
67 extern struct gl_config
*
68 _mesa_create_visual( GLboolean dbFlag
,
83 _mesa_initialize_visual( struct gl_config
*v
,
99 _mesa_destroy_visual( struct gl_config
*vis
);
104 /** \name Context-related functions */
108 _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
);
114 extern struct gl_context
*
115 _mesa_create_context(gl_api api
,
116 const struct gl_config
*visual
,
117 struct gl_context
*share_list
,
118 const struct dd_function_table
*driverFunctions
);
121 _mesa_free_context_data( struct gl_context
*ctx
);
124 _mesa_destroy_context( struct gl_context
*ctx
);
128 _mesa_copy_context(const struct gl_context
*src
, struct gl_context
*dst
, GLuint mask
);
132 _mesa_check_init_viewport(struct gl_context
*ctx
, GLuint width
, GLuint height
);
135 _mesa_make_current( struct gl_context
*ctx
, struct gl_framebuffer
*drawBuffer
,
136 struct gl_framebuffer
*readBuffer
);
139 _mesa_share_state(struct gl_context
*ctx
, struct gl_context
*ctxToShare
);
141 extern struct gl_context
*
142 _mesa_get_current_context(void);
147 _mesa_init_constants(struct gl_constants
*consts
, gl_api api
);
150 _mesa_init_get_hash(struct gl_context
*ctx
);
153 _mesa_notifySwapBuffers(struct gl_context
*gc
);
156 extern struct _glapi_table
*
157 _mesa_get_dispatch(struct gl_context
*ctx
);
161 _mesa_valid_to_render(struct gl_context
*ctx
, const char *where
);
165 /** \name Miscellaneous */
169 _mesa_record_error( struct gl_context
*ctx
, GLenum error
);
173 _mesa_finish(struct gl_context
*ctx
);
176 _mesa_flush(struct gl_context
*ctx
);
179 _mesa_generic_nop(void);
181 extern void GLAPIENTRY
182 _mesa_Finish( void );
184 extern void GLAPIENTRY
191 * Are we currently between glBegin and glEnd?
192 * During execution, not display list compilation.
194 static inline GLboolean
195 _mesa_inside_begin_end(const struct gl_context
*ctx
)
197 return ctx
->Driver
.CurrentExecPrimitive
!= PRIM_OUTSIDE_BEGIN_END
;
202 * Are we currently between glBegin and glEnd in a display list?
204 static inline GLboolean
205 _mesa_inside_dlist_begin_end(const struct gl_context
*ctx
)
207 return ctx
->Driver
.CurrentSavePrimitive
<= PRIM_MAX
;
213 * \name Macros for flushing buffered rendering commands before state changes,
214 * checking if inside glBegin/glEnd, etc.
221 * \param ctx GL context.
222 * \param newstate new state.
224 * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
225 * and calls dd_function_table::FlushVertices if so. Marks
226 * __struct gl_contextRec::NewState with \p newstate.
228 #define FLUSH_VERTICES(ctx, newstate) \
230 if (MESA_VERBOSE & VERBOSE_STATE) \
231 _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
232 if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES) \
233 ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES); \
234 ctx->NewState |= newstate; \
238 * Flush current state.
240 * \param ctx GL context.
241 * \param newstate new state.
243 * Checks if dd_function_table::NeedFlush is marked to flush current state,
244 * and calls dd_function_table::FlushVertices if so. Marks
245 * __struct gl_contextRec::NewState with \p newstate.
247 #define FLUSH_CURRENT(ctx, newstate) \
249 if (MESA_VERBOSE & VERBOSE_STATE) \
250 _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
251 if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT) \
252 ctx->Driver.FlushVertices(ctx, FLUSH_UPDATE_CURRENT); \
253 ctx->NewState |= newstate; \
257 * Macro to assert that the API call was made outside the
258 * glBegin()/glEnd() pair, with return value.
260 * \param ctx GL context.
261 * \param retval value to return in case the assertion fails.
263 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval) \
265 if (_mesa_inside_begin_end(ctx)) { \
266 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
272 * Macro to assert that the API call was made outside the
273 * glBegin()/glEnd() pair.
275 * \param ctx GL context.
277 #define ASSERT_OUTSIDE_BEGIN_END(ctx) \
279 if (_mesa_inside_begin_end(ctx)) { \
280 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
289 * Checks if the context is for Desktop GL (Compatibility or Core)
291 static inline GLboolean
292 _mesa_is_desktop_gl(const struct gl_context
*ctx
)
294 return ctx
->API
== API_OPENGL_COMPAT
|| ctx
->API
== API_OPENGL_CORE
;
299 * Checks if the context is for any GLES version
301 static inline GLboolean
302 _mesa_is_gles(const struct gl_context
*ctx
)
304 return ctx
->API
== API_OPENGLES
|| ctx
->API
== API_OPENGLES2
;
309 * Checks if the context is for GLES 3.x
311 static inline GLboolean
312 _mesa_is_gles3(const struct gl_context
*ctx
)
314 return ctx
->API
== API_OPENGLES2
&& ctx
->Version
>= 30;
319 * Checks if the context supports geometry shaders.
321 static inline GLboolean
322 _mesa_has_geometry_shaders(const struct gl_context
*ctx
)
324 return _mesa_is_desktop_gl(ctx
) &&
325 (ctx
->Version
>= 32 || ctx
->Extensions
.ARB_geometry_shader4
);
334 #endif /* CONTEXT_H */