2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2006 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
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
,
113 void *driverContext
);
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
);
123 _mesa_free_context_data( struct gl_context
*ctx
);
126 _mesa_destroy_context( struct gl_context
*ctx
);
130 _mesa_copy_context(const struct gl_context
*src
, struct gl_context
*dst
, GLuint mask
);
134 _mesa_check_init_viewport(struct gl_context
*ctx
, GLuint width
, GLuint height
);
137 _mesa_make_current( struct gl_context
*ctx
, struct gl_framebuffer
*drawBuffer
,
138 struct gl_framebuffer
*readBuffer
);
141 _mesa_share_state(struct gl_context
*ctx
, struct gl_context
*ctxToShare
);
143 extern struct gl_context
*
144 _mesa_get_current_context(void);
149 _mesa_init_get_hash(struct gl_context
*ctx
);
152 _mesa_notifySwapBuffers(struct gl_context
*gc
);
155 extern struct _glapi_table
*
156 _mesa_get_dispatch(struct gl_context
*ctx
);
160 _mesa_set_mvp_with_dp4( struct gl_context
*ctx
,
165 _mesa_valid_to_render(struct gl_context
*ctx
, const char *where
);
169 /** \name Miscellaneous */
173 _mesa_record_error( struct gl_context
*ctx
, GLenum error
);
177 _mesa_finish(struct gl_context
*ctx
);
180 _mesa_flush(struct gl_context
*ctx
);
183 extern void GLAPIENTRY
184 _mesa_Finish( void );
186 extern void GLAPIENTRY
193 * \name Macros for flushing buffered rendering commands before state changes,
194 * checking if inside glBegin/glEnd, etc.
201 * \param ctx GL context.
202 * \param newstate new state.
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.
208 #define FLUSH_VERTICES(ctx, newstate) \
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; \
218 * Flush current state.
220 * \param ctx GL context.
221 * \param newstate new state.
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.
227 #define FLUSH_CURRENT(ctx, newstate) \
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; \
237 * Macro to assert that the API call was made outside the
238 * glBegin()/glEnd() pair, with return value.
240 * \param ctx GL context.
241 * \param retval value to return in case the assertion fails.
243 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval) \
245 if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) { \
246 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
252 * Macro to assert that the API call was made outside the
253 * glBegin()/glEnd() pair.
255 * \param ctx GL context.
257 #define ASSERT_OUTSIDE_BEGIN_END(ctx) \
259 if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) { \
260 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
266 * Macro to assert that the API call was made outside the
267 * glBegin()/glEnd() pair and flush the vertices.
269 * \param ctx GL context.
271 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx) \
273 ASSERT_OUTSIDE_BEGIN_END(ctx); \
274 FLUSH_VERTICES(ctx, 0); \
278 * Macro to assert that the API call was made outside the
279 * glBegin()/glEnd() pair and flush the vertices, with return value.
281 * \param ctx GL context.
282 * \param retval value to return in case the assertion fails.
284 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval) \
286 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval); \
287 FLUSH_VERTICES(ctx, 0); \
298 #endif /* CONTEXT_H */