context.h revision afb833d4e89c312460a4ab9ed6a7a8ca4ebbfe1c 
1/* $Id: context.h,v 1.1 1999/08/19 00:55:41 jtg Exp $ */
2
3/*
4 * Mesa 3-D graphics library
5 * Version:  3.1
6 *
7 * Copyright (C) 1999  Brian Paul   All Rights Reserved.
8 *
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:
15 *
16 * The above copyright notice and this permission notice shall be included
17 * in all copies or substantial portions of the Software.
18 *
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.
25 */
26
27
28
29
30
31#ifndef CONTEXT_H
32#define CONTEXT_H
33
34
35#include "types.h"
36
37
38
39#ifdef THREADS
40   /*
41    * A seperate GLcontext for each thread
42    */
43   extern GLcontext *gl_get_thread_context( void );
44#else
45   /*
46    * All threads use same pointer to current context.
47    */
48   extern GLcontext *CC;
49   extern struct immediate *CURRENT_INPUT;
50#endif
51
52
53
54/*
55 * There are three Mesa datatypes which are meant to be used by device
56 * drivers:
57 *   GLcontext:  this contains the Mesa rendering state
58 *   GLvisual:  this describes the color buffer (rgb vs. ci), whether
59 *              or not there's a depth buffer, stencil buffer, etc.
60 *   GLframebuffer:  contains pointers to the depth buffer, stencil
61 *                   buffer, accum buffer and alpha buffers.
62 *
63 * These types should be encapsulated by corresponding device driver
64 * datatypes.  See xmesa.h and xmesaP.h for an example.
65 *
66 * In OOP terms, GLcontext, GLvisual, and GLframebuffer are base classes
67 * which the device driver must derive from.
68 *
69 * The following functions create and destroy these datatypes.
70 */
71
72
73/*
74 * Create/destroy a GLvisual.  A GLvisual is like a GLX visual.  It describes
75 * the colorbuffer, depth buffer, stencil buffer and accum buffer which will
76 * be used by the GL context and framebuffer.
77 */
78extern GLvisual *gl_create_visual( GLboolean rgbFlag,
79                                   GLboolean alphaFlag,
80                                   GLboolean dbFlag,
81                                   GLboolean stereoFlag,
82                                   GLint depthBits,
83                                   GLint stencilBits,
84                                   GLint accumBits,
85                                   GLint indexBits,
86                                   GLint redBits,
87                                   GLint greenBits,
88                                   GLint blueBits,
89                                   GLint alphaBits );
90
91extern void gl_destroy_visual( GLvisual *vis );
92
93
94/*
95 * Create/destroy a GLcontext.  A GLcontext is like a GLX context.  It
96 * contains the rendering state.
97 */
98extern GLcontext *gl_create_context( GLvisual *visual,
99                                     GLcontext *share_list,
100                                     void *driver_ctx,
101                                     GLboolean direct);
102
103extern void gl_destroy_context( GLcontext *ctx );
104
105/* Called by the driver after both the context and driver are fully
106 * initialized.  Currently just reads the config file.
107 */
108extern void gl_context_initialize( GLcontext *ctx );
109
110/*
111 * Create/destroy a GLframebuffer.  A GLframebuffer is like a GLX drawable.
112 * It bundles up the depth buffer, stencil buffer and accum buffers into a
113 * single entity.
114 */
115extern GLframebuffer *gl_create_framebuffer( GLvisual *visual );
116
117extern void gl_destroy_framebuffer( GLframebuffer *buffer );
118
119
120
121extern void gl_make_current( GLcontext *ctx, GLframebuffer *buffer );
122
123extern GLcontext *gl_get_current_context(void);
124
125extern void gl_copy_context(const GLcontext *src, GLcontext *dst, GLuint mask);
126
127extern void gl_set_api_table( GLcontext *ctx, const struct gl_api_table *api );
128
129
130
131/*
132 * GL_MESA_resize_buffers extension
133 */
134extern void gl_ResizeBuffersMESA( GLcontext *ctx );
135
136
137
138/*
139 * Miscellaneous
140 */
141
142extern void gl_problem( const GLcontext *ctx, const char *s );
143
144extern void gl_warning( const GLcontext *ctx, const char *s );
145
146extern void gl_error( GLcontext *ctx, GLenum error, const char *s );
147extern void gl_compile_error( GLcontext *ctx, GLenum error, const char *s );
148
149extern GLenum gl_GetError( GLcontext *ctx );
150
151
152extern void gl_update_state( GLcontext *ctx );
153
154
155/* for debugging */
156extern void gl_print_state( const char *msg, GLuint state );
157
158/* for debugging */
159extern void gl_print_enable_flags( const char *msg, GLuint flags );
160
161
162#ifdef PROFILE
163extern GLdouble gl_time( void );
164#endif
165
166
167#endif
168