context.h revision 4a49301e 
1/*
2 * Mesa 3-D graphics library
3 * Version:  6.5.1
4 *
5 * Copyright (C) 1999-2006  Brian Paul   All Rights Reserved.
6 *
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:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
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.
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 * - 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.
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, GLcontext, GLvisual, and GLframebuffer are base classes
42 * 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 "mtypes.h"
54
55
56struct _glapi_table;
57
58
59/** \name Visual-related functions */
60/*@{*/
61
62extern GLvisual *
63_mesa_create_visual( GLboolean rgbFlag,
64                     GLboolean dbFlag,
65                     GLboolean stereoFlag,
66                     GLint redBits,
67                     GLint greenBits,
68                     GLint blueBits,
69                     GLint alphaBits,
70                     GLint indexBits,
71                     GLint depthBits,
72                     GLint stencilBits,
73                     GLint accumRedBits,
74                     GLint accumGreenBits,
75                     GLint accumBlueBits,
76                     GLint accumAlphaBits,
77                     GLint numSamples );
78
79extern GLboolean
80_mesa_initialize_visual( GLvisual *v,
81                         GLboolean rgbFlag,
82                         GLboolean dbFlag,
83                         GLboolean stereoFlag,
84                         GLint redBits,
85                         GLint greenBits,
86                         GLint blueBits,
87                         GLint alphaBits,
88                         GLint indexBits,
89                         GLint depthBits,
90                         GLint stencilBits,
91                         GLint accumRedBits,
92                         GLint accumGreenBits,
93                         GLint accumBlueBits,
94                         GLint accumAlphaBits,
95                         GLint numSamples );
96
97extern void
98_mesa_destroy_visual( GLvisual *vis );
99
100/*@}*/
101
102
103/** \name Context-related functions */
104/*@{*/
105
106extern GLcontext *
107_mesa_create_context( const GLvisual *visual,
108                      GLcontext *share_list,
109                      const struct dd_function_table *driverFunctions,
110                      void *driverContext );
111
112extern GLboolean
113_mesa_initialize_context( GLcontext *ctx,
114                          const GLvisual *visual,
115                          GLcontext *share_list,
116                          const struct dd_function_table *driverFunctions,
117                          void *driverContext );
118
119extern void
120_mesa_initialize_context_extra(GLcontext *ctx);
121
122extern void
123_mesa_free_context_data( GLcontext *ctx );
124
125extern void
126_mesa_destroy_context( GLcontext *ctx );
127
128
129extern void
130_mesa_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
131
132
133extern void
134_mesa_check_init_viewport(GLcontext *ctx, GLuint width, GLuint height);
135
136extern GLboolean
137_mesa_make_current( GLcontext *ctx, GLframebuffer *drawBuffer,
138                    GLframebuffer *readBuffer );
139
140extern GLboolean
141_mesa_share_state(GLcontext *ctx, GLcontext *ctxToShare);
142
143extern GLcontext *
144_mesa_get_current_context(void);
145
146/*@}*/
147
148
149extern void
150_mesa_notifySwapBuffers(__GLcontext *gc);
151
152
153extern struct _glapi_table *
154_mesa_get_dispatch(GLcontext *ctx);
155
156
157void
158_mesa_set_mvp_with_dp4( GLcontext *ctx,
159                        GLboolean flag );
160
161
162extern GLboolean
163_mesa_valid_to_render(GLcontext *ctx, const char *where);
164
165
166
167/** \name Miscellaneous */
168/*@{*/
169
170extern void
171_mesa_record_error( GLcontext *ctx, GLenum error );
172
173
174extern void
175_mesa_finish(GLcontext *ctx);
176
177extern void
178_mesa_flush(GLcontext *ctx);
179
180
181extern void GLAPIENTRY
182_mesa_Finish( void );
183
184extern void GLAPIENTRY
185_mesa_Flush( void );
186
187/*@}*/
188
189
190/**
191 * \name Macros for flushing buffered rendering commands before state changes,
192 * checking if inside glBegin/glEnd, etc.
193 */
194/*@{*/
195
196/**
197 * Flush vertices.
198 *
199 * \param ctx GL context.
200 * \param newstate new state.
201 *
202 * Checks if dd_function_table::NeedFlush is marked to flush stored vertices,
203 * and calls dd_function_table::FlushVertices if so. Marks
204 * __GLcontextRec::NewState with \p newstate.
205 */
206#define FLUSH_VERTICES(ctx, newstate)				\
207do {								\
208   if (MESA_VERBOSE & VERBOSE_STATE)				\
209      _mesa_debug(ctx, "FLUSH_VERTICES in %s\n", MESA_FUNCTION);\
210   if (ctx->Driver.NeedFlush)		\
211      ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES | FLUSH_UPDATE_CURRENT);     \
212   ctx->NewState |= newstate;					\
213} while (0)
214
215/**
216 * Flush current state.
217 *
218 * \param ctx GL context.
219 * \param newstate new state.
220 *
221 * Checks if dd_function_table::NeedFlush is marked to flush current state,
222 * and calls dd_function_table::FlushVertices if so. Marks
223 * __GLcontextRec::NewState with \p newstate.
224 */
225#define FLUSH_CURRENT(ctx, newstate)				\
226do {								\
227   if (MESA_VERBOSE & VERBOSE_STATE)				\
228      _mesa_debug(ctx, "FLUSH_CURRENT in %s\n", MESA_FUNCTION);	\
229   if (ctx->Driver.NeedFlush)		\
230      ctx->Driver.FlushVertices(ctx, FLUSH_STORED_VERTICES | FLUSH_UPDATE_CURRENT);	\
231   ctx->NewState |= newstate;					\
232} while (0)
233
234/**
235 * Macro to assert that the API call was made outside the
236 * glBegin()/glEnd() pair, with return value.
237 *
238 * \param ctx GL context.
239 * \param retval value to return value in case the assertion fails.
240 */
241#define ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval)		\
242do {									\
243   if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {	\
244      _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");	\
245      return retval;							\
246   }									\
247} while (0)
248
249/**
250 * Macro to assert that the API call was made outside the
251 * glBegin()/glEnd() pair.
252 *
253 * \param ctx GL context.
254 */
255#define ASSERT_OUTSIDE_BEGIN_END(ctx)					\
256do {									\
257   if (ctx->Driver.CurrentExecPrimitive != PRIM_OUTSIDE_BEGIN_END) {	\
258      _mesa_error(ctx, GL_INVALID_OPERATION, "Inside glBegin/glEnd");	\
259      return;								\
260   }									\
261} while (0)
262
263/**
264 * Macro to assert that the API call was made outside the
265 * glBegin()/glEnd() pair and flush the vertices.
266 *
267 * \param ctx GL context.
268 */
269#define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH(ctx)				\
270do {									\
271   ASSERT_OUTSIDE_BEGIN_END(ctx);					\
272   FLUSH_VERTICES(ctx, 0);						\
273} while (0)
274
275/**
276 * Macro to assert that the API call was made outside the
277 * glBegin()/glEnd() pair and flush the vertices, with return value.
278 *
279 * \param ctx GL context.
280 * \param retval value to return value in case the assertion fails.
281 */
282#define ASSERT_OUTSIDE_BEGIN_END_AND_FLUSH_WITH_RETVAL(ctx, retval)	\
283do {									\
284   ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx, retval);			\
285   FLUSH_VERTICES(ctx, 0);						\
286} while (0)
287
288/*@}*/
289
290
291
292/**
293 * Is the secondary color needed?
294 */
295#define NEED_SECONDARY_COLOR(CTX)					\
296   (((CTX)->Light.Enabled &&						\
297     (CTX)->Light.Model.ColorControl == GL_SEPARATE_SPECULAR_COLOR)	\
298    || (CTX)->Fog.ColorSumEnabled					\
299    || ((CTX)->VertexProgram._Current &&				\
300        ((CTX)->VertexProgram._Current != (CTX)->VertexProgram._TnlProgram) &&    \
301        ((CTX)->VertexProgram._Current->Base.InputsRead & VERT_BIT_COLOR1)) \
302    || ((CTX)->FragmentProgram._Current &&				\
303        ((CTX)->FragmentProgram._Current != (CTX)->FragmentProgram._TexEnvProgram) &&  \
304        ((CTX)->FragmentProgram._Current->Base.InputsRead & FRAG_BIT_COL1)) \
305   )
306
307
308/**
309 * Is RGBA LogicOp enabled?
310 */
311#define RGBA_LOGICOP_ENABLED(CTX) \
312  ((CTX)->Color.ColorLogicOpEnabled || \
313   ((CTX)->Color.BlendEnabled && (CTX)->Color.BlendEquationRGB == GL_LOGIC_OP))
314
315
316#endif /* CONTEXT_H */
317