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 * - GLcontext: this contains the Mesa rendering state
33 * - GLvisual: this describes the color buffer (RGB vs. ci), whether or not
34 * there's a depth buffer, stencil buffer, etc.
35 * - GLframebuffer: contains pointers to the depth buffer, stencil buffer,
36 * 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, GLcontext, GLvisual, and GLframebuffer are base classes
42 * which the device driver must derive from.
44 * The following functions create and destroy these data types.
59 /** \name Visual-related functions */
63 _mesa_create_visual( GLboolean dbFlag
,
78 _mesa_initialize_visual( GLvisual
*v
,
94 _mesa_destroy_visual( GLvisual
*vis
);
99 /** \name Context-related functions */
103 _mesa_create_context( const GLvisual
*visual
,
104 GLcontext
*share_list
,
105 const struct dd_function_table
*driverFunctions
,
106 void *driverContext
);
109 _mesa_initialize_context( GLcontext
*ctx
,
110 const GLvisual
*visual
,
111 GLcontext
*share_list
,
112 const struct dd_function_table
*driverFunctions
,
113 void *driverContext
);
116 _mesa_create_context_for_api(gl_api api
,
117 const GLvisual
*visual
,
118 GLcontext
*share_list
,
119 const struct dd_function_table
*driverFunctions
,
120 void *driverContext
);
123 _mesa_initialize_context_for_api(GLcontext
*ctx
,
125 const GLvisual
*visual
,
126 GLcontext
*share_list
,
127 const struct dd_function_table
*driverFunctions
,
128 void *driverContext
);
131 _mesa_free_context_data( GLcontext
*ctx
);
134 _mesa_destroy_context( GLcontext
*ctx
);
138 _mesa_copy_context(const GLcontext
*src
, GLcontext
*dst
, GLuint mask
);
142 _mesa_check_init_viewport(GLcontext
*ctx
, GLuint width
, GLuint height
);
145 _mesa_make_current( GLcontext
*ctx
, GLframebuffer
*drawBuffer
,
146 GLframebuffer
*readBuffer
);
149 _mesa_share_state(GLcontext
*ctx
, GLcontext
*ctxToShare
);
152 _mesa_get_current_context(void);
157 _mesa_init_get_hash(GLcontext
*ctx
);
160 _mesa_notifySwapBuffers(__GLcontext
*gc
);
163 extern struct _glapi_table
*
164 _mesa_get_dispatch(GLcontext
*ctx
);
168 _mesa_set_mvp_with_dp4( GLcontext
*ctx
,
173 _mesa_valid_to_render(GLcontext
*ctx
, const char *where
);
177 /** \name Miscellaneous */
181 _mesa_record_error( GLcontext
*ctx
, GLenum error
);
185 _mesa_finish(GLcontext
*ctx
);
188 _mesa_flush(GLcontext
*ctx
);
191 extern void GLAPIENTRY
192 _mesa_Finish( void );
194 extern void GLAPIENTRY
201 * \name Macros for flushing buffered rendering commands before state changes,
202 * checking if inside glBegin/glEnd, etc.
209 * \param ctx GL context.
210 * \param newstate new state.
212 * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
213 * and calls dd_function_table::FlushVertices if so. Marks
214 * __GLcontextRec::NewState with \p newstate.
216 #define FLUSH_VERTICES(ctx, newstate) \
218 if (MESA_VERBOSE & VERBOSE_STATE) \
219 _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
220 if (ctx->Driver.NeedFlush & FLUSH_STORED_VERTICES) \
221 ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES); \
222 ctx->NewState |= newstate; \
226 * Flush current state.
228 * \param ctx GL context.
229 * \param newstate new state.
231 * Checks if dd_function_table::NeedFlush is marked to flush current state,
232 * and calls dd_function_table::FlushVertices if so. Marks
233 * __GLcontextRec::NewState with \p newstate.
235 #define FLUSH_CURRENT(ctx, newstate) \
237 if (MESA_VERBOSE & VERBOSE_STATE) \
238 _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION); \
239 if (ctx->Driver.NeedFlush & FLUSH_UPDATE_CURRENT) \
240 ctx->Driver.FlushVertices(ctx, FLUSH_UPDATE_CURRENT); \
241 ctx->NewState |= newstate; \
245 * Macro to assert that the API call was made outside the
246 * glBegin()/glEnd() pair, with return value.
248 * \param ctx GL context.
249 * \param retval value to return value in case the assertion fails.
251 #define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval) \
253 if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) { \
254 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
260 * Macro to assert that the API call was made outside the
261 * glBegin()/glEnd() pair.
263 * \param ctx GL context.
265 #define ASSERT_OUTSIDE_BEGIN_END(ctx) \
267 if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) { \
268 _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd"); \
274 * Macro to assert that the API call was made outside the
275 * glBegin()/glEnd() pair and flush the vertices.
277 * \param ctx GL context.
279 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx) \
281 ASSERT_OUTSIDE_BEGIN_END(ctx); \
282 FLUSH_VERTICES(ctx, 0); \
286 * Macro to assert that the API call was made outside the
287 * glBegin()/glEnd() pair and flush the vertices, with return value.
289 * \param ctx GL context.
290 * \param retval value to return value in case the assertion fails.
292 #define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval) \
294 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval); \
295 FLUSH_VERTICES(ctx, 0); \
303 * Is the secondary color needed?
305 #define NEED_SECONDARY_COLOR(CTX) \
306 (((CTX)->Light.Enabled && \
307 (CTX)->Light.Model.ColorControl == GL_SEPARATE_SPECULAR_COLOR) \
308 || (CTX)->Fog.ColorSumEnabled \
309 || ((CTX)->VertexProgram._Current && \
310 ((CTX)->VertexProgram._Current != (CTX)->VertexProgram._TnlProgram) && \
311 ((CTX)->VertexProgram._Current->Base.InputsRead & VERT_BIT_COLOR1)) \
312 || ((CTX)->FragmentProgram._Current && \
313 ((CTX)->FragmentProgram._Current != (CTX)->FragmentProgram._TexEnvProgram) && \
314 ((CTX)->FragmentProgram._Current->Base.InputsRead & FRAG_BIT_COL1)) \
319 * Is RGBA LogicOp enabled?
321 #define RGBA_LOGICOP_ENABLED(CTX) \
322 ((CTX)->Color.ColorLogicOpEnabled || \
323 ((CTX)->Color.BlendEnabled && (CTX)->Color.BlendEquationRGB == GL_LOGIC_OP))
326 #endif /* CONTEXT_H */