1 /* $Id: context.h,v 1.35 2002/10/24 23:57:20 brianp Exp $ */
4 * Mesa 3-D graphics library
7 * Copyright (C) 1999-2001 Brian Paul All Rights Reserved.
9 * Permission is hereby granted, free of charge, to any person obtaining a
10 * copy of this software and associated documentation files (the "Software"),
11 * to deal in the Software without restriction, including without limitation
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13 * and/or sell copies of the Software, and to permit persons to whom the
14 * Software is furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
23 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
24 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
37 * There are three Mesa datatypes which are meant to be used by device
39 * GLcontext: this contains the Mesa rendering state
40 * GLvisual: this describes the color buffer (rgb vs. ci), whether
41 * or not there's a depth buffer, stencil buffer, etc.
42 * GLframebuffer: contains pointers to the depth buffer, stencil
43 * buffer, accum buffer and alpha buffers.
45 * These types should be encapsulated by corresponding device driver
46 * datatypes. See xmesa.h and xmesaP.h for an example.
48 * In OOP terms, GLcontext, GLvisual, and GLframebuffer are base classes
49 * which the device driver must derive from.
51 * The following functions create and destroy these datatypes.
56 * Create/destroy a GLvisual.
59 _mesa_create_visual( GLboolean rgbFlag
,
76 _mesa_initialize_visual( GLvisual
*v
,
94 _mesa_destroy_visual( GLvisual
*vis
);
99 * Create/destroy a GLframebuffer.
101 extern GLframebuffer
*
102 _mesa_create_framebuffer( const GLvisual
*visual
,
103 GLboolean softwareDepth
,
104 GLboolean softwareStencil
,
105 GLboolean softwareAccum
,
106 GLboolean softwareAlpha
);
109 _mesa_initialize_framebuffer( GLframebuffer
*fb
,
110 const GLvisual
*visual
,
111 GLboolean softwareDepth
,
112 GLboolean softwareStencil
,
113 GLboolean softwareAccum
,
114 GLboolean softwareAlpha
);
117 _mesa_free_framebuffer_data( GLframebuffer
*buffer
);
120 _mesa_destroy_framebuffer( GLframebuffer
*buffer
);
125 * Create/destroy a GLcontext.
128 _mesa_create_context( const GLvisual
*visual
,
129 GLcontext
*share_list
,
134 _mesa_initialize_context( GLcontext
*ctx
,
135 const GLvisual
*visual
,
136 GLcontext
*share_list
,
141 _mesa_free_context_data( GLcontext
*ctx
);
144 _mesa_destroy_context( GLcontext
*ctx
);
148 _mesa_copy_context(const GLcontext
*src
, GLcontext
*dst
, GLuint mask
);
152 _mesa_make_current( GLcontext
*ctx
, GLframebuffer
*buffer
);
156 _mesa_make_current2( GLcontext
*ctx
, GLframebuffer
*drawBuffer
,
157 GLframebuffer
*readBuffer
);
161 _mesa_get_current_context(void);
166 * Macros for fetching current context.
170 #define GET_CURRENT_CONTEXT(C) GLcontext *C = (GLcontext *) (_glapi_Context ? _glapi_Context : _glapi_get_context())
174 #define GET_CURRENT_CONTEXT(C) GLcontext *C = (GLcontext *) _glapi_Context
180 /* OpenGL SI-style export functions. */
183 _mesa_destroyContext(__GLcontext
*gc
);
186 _mesa_loseCurrent(__GLcontext
*gc
);
189 _mesa_makeCurrent(__GLcontext
*gc
);
192 _mesa_shareContext(__GLcontext
*gc
, __GLcontext
*gcShare
);
195 _mesa_copyContext(__GLcontext
*dst
, const __GLcontext
*src
, GLuint mask
);
198 _mesa_forceCurrent(__GLcontext
*gc
);
201 _mesa_notifyResize(__GLcontext
*gc
);
204 _mesa_notifyDestroy(__GLcontext
*gc
);
207 _mesa_notifySwapBuffers(__GLcontext
*gc
);
209 extern struct __GLdispatchStateRec
*
210 _mesa_dispatchExec(__GLcontext
*gc
);
213 _mesa_beginDispatchOverride(__GLcontext
*gc
);
216 _mesa_endDispatchOverride(__GLcontext
*gc
);
220 extern struct _glapi_table
*
221 _mesa_get_dispatch(GLcontext
*ctx
);
230 _mesa_record_error( GLcontext
*ctx
, GLenum error
);
234 _mesa_Finish( void );