blob: 48b5501fe9ee292fd53302055000956a618ced5d [file] [log] [blame]
Adam Jacksoncb3610e2004-10-25 21:09:16 +00001/*
Adam Jacksondc8058c2008-09-19 17:16:53 -04002 * SGI FREE SOFTWARE LICENSE B (Version 2.0, Sept. 18, 2008)
3 * Copyright (C) 1991-2000 Silicon Graphics, Inc. All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice including the dates of first publication and
13 * either this permission notice or a reference to
14 * http://oss.sgi.com/projects/FreeB/
15 * shall be included 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 * SILICON GRAPHICS, INC. BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
21 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
22 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 *
25 * Except as contained in this notice, the name of Silicon Graphics, Inc.
26 * shall not be used in advertising or otherwise to promote the sale, use or
27 * other dealings in this Software without prior written authorization from
28 * Silicon Graphics, Inc.
29 */
Adam Jacksoncb3610e2004-10-25 21:09:16 +000030
31/**
32 * \file glxclient.h
33 * Direct rendering support added by Precision Insight, Inc.
34 *
35 * \author Kevin E. Martin <kevin@precisioninsight.com>
36 */
37
38#ifndef _GLX_client_h_
39#define _GLX_client_h_
Adam Jacksoncb3610e2004-10-25 21:09:16 +000040#include <X11/Xproto.h>
41#include <X11/Xlibint.h>
Robert Bragg7a9329b2010-01-20 03:01:14 +000042#include <X11/extensions/extutil.h>
Adam Jacksoncb3610e2004-10-25 21:09:16 +000043#define GLX_GLXEXT_PROTOTYPES
44#include <GL/glx.h>
45#include <GL/glxext.h>
46#include <string.h>
47#include <stdlib.h>
48#include <stdio.h>
Adam Jacksonad919c32004-11-15 15:31:32 +000049#ifdef WIN32
50#include <stdint.h>
51#endif
Adam Jacksoncb3610e2004-10-25 21:09:16 +000052#include "GL/glxint.h"
53#include "GL/glxproto.h"
54#include "GL/internal/glcore.h"
Brian4eb95ce2008-09-18 20:27:16 -060055#include "glapi/glapitable.h"
Kristian Høgsberg4a22ae82007-01-07 08:12:01 -050056#include "glxhash.h"
RALOVICH, Kristóf8363dff2009-07-23 17:58:08 +020057#if defined( PTHREADS )
Ian Romanick02986cb2005-04-18 16:59:53 +000058# include <pthread.h>
Adam Jacksoncb3610e2004-10-25 21:09:16 +000059#endif
Adam Jacksoncb3610e2004-10-25 21:09:16 +000060
Jeremy Huddlestonec770152008-08-08 02:37:14 -070061#include "glxextensions.h"
62
Brian Paula25e1aa2008-09-18 13:26:30 -060063
64/* If we build the library with gcc's -fvisibility=hidden flag, we'll
65 * use the PUBLIC macro to mark functions that are to be exported.
66 *
RALOVICH, Kristóf08962682009-08-12 12:41:22 +020067 * We also need to define a USED attribute, so the optimizer doesn't
Brian Paula25e1aa2008-09-18 13:26:30 -060068 * inline a static function that we later use in an alias. - ajax
69 */
Ian Romanick016fc302010-03-03 16:02:45 -080070#if defined(__GNUC__)
Brian Paula25e1aa2008-09-18 13:26:30 -060071# define PUBLIC __attribute__((visibility("default")))
72# define USED __attribute__((used))
73#else
74# define PUBLIC
75# define USED
76#endif
77
78
79
RALOVICH, Kristóf08962682009-08-12 12:41:22 +020080#define GLX_MAJOR_VERSION 1 /* current version numbers */
81#define GLX_MINOR_VERSION 4
Adam Jacksoncb3610e2004-10-25 21:09:16 +000082
83#define __GLX_MAX_TEXTURE_UNITS 32
84
Kristian Høgsbergaceccda2007-05-10 15:52:22 -040085typedef struct __GLXscreenConfigsRec __GLXscreenConfigs;
Adam Jacksoncb3610e2004-10-25 21:09:16 +000086typedef struct __GLXcontextRec __GLXcontext;
Kristian Høgsbergaceccda2007-05-10 15:52:22 -040087typedef struct __GLXdrawableRec __GLXdrawable;
Adam Jacksoncb3610e2004-10-25 21:09:16 +000088typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate;
89typedef struct _glapi_table __GLapi;
90
91/************************************************************************/
92
93#ifdef GLX_DIRECT_RENDERING
94
RALOVICH, Kristóf08962682009-08-12 12:41:22 +020095#define containerOf(ptr, type, member) \
Kristian Høgsbergaceccda2007-05-10 15:52:22 -040096 (type *)( (char *)ptr - offsetof(type,member) )
97
Kristian Høgsberg7b7845a2010-07-22 22:24:00 -040098extern void DRI_glXUseXFont(GLXContext CC,
99 Font font, int first, int count, int listbase);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000100
Jeremy Huddleston80b280d2010-04-02 01:35:19 -0700101#endif
102
103#if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
104
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000105/**
106 * Display dependent methods. This structure is initialized during the
107 * \c driCreateDisplay call.
108 */
Kristian Høgsberg425f9ed2008-03-08 19:02:10 -0500109typedef struct __GLXDRIdisplayRec __GLXDRIdisplay;
Kristian Høgsberg92d2a782008-03-08 20:34:24 -0500110typedef struct __GLXDRIscreenRec __GLXDRIscreen;
Kristian Høgsberg20b92302008-03-08 21:02:23 -0500111typedef struct __GLXDRIdrawableRec __GLXDRIdrawable;
Kristian Høgsberg020c64b2008-03-08 21:57:29 -0500112typedef struct __GLXDRIcontextRec __GLXDRIcontext;
Kristian Høgsberg92d2a782008-03-08 20:34:24 -0500113
Kristian Høgsberge82dd8c2008-03-26 19:26:59 -0400114#include "glxextensions.h"
115
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200116struct __GLXDRIdisplayRec
117{
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000118 /**
119 * Method to destroy the private DRI display data.
120 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200121 void (*destroyDisplay) (__GLXDRIdisplay * display);
Kristian Høgsberga1ea6f62008-03-08 19:15:50 -0500122
Kristian Høgsbergf9721152010-07-19 14:57:59 -0400123 __GLXscreenConfigs *(*createScreen)(int screen, __GLXdisplayPrivate * priv);
Kristian Høgsberg92d2a782008-03-08 20:34:24 -0500124};
125
Jesse Barnesdaf7fe62009-09-15 23:23:09 -0700126struct __GLXDRIscreenRec {
Kristian Høgsberg92d2a782008-03-08 20:34:24 -0500127
Jesse Barnesdaf7fe62009-09-15 23:23:09 -0700128 void (*destroyScreen)(__GLXscreenConfigs *psc);
Kristian Høgsberg92d2a782008-03-08 20:34:24 -0500129
Kristian Høgsberg31819832010-07-22 21:24:14 -0400130 __GLXcontext *(*createContext)(__GLXscreenConfigs *psc,
131 const __GLcontextModes *mode,
132 GLXContext shareList, int renderType);
Kristian Høgsbergf56b5692008-08-13 11:46:25 -0400133
Jesse Barnesdaf7fe62009-09-15 23:23:09 -0700134 __GLXDRIdrawable *(*createDrawable)(__GLXscreenConfigs *psc,
135 XID drawable,
136 GLXDrawable glxDrawable,
137 const __GLcontextModes *modes);
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200138
Jesse Barnesdaf7fe62009-09-15 23:23:09 -0700139 int64_t (*swapBuffers)(__GLXDRIdrawable *pdraw, int64_t target_msc,
140 int64_t divisor, int64_t remainder);
141 void (*copySubBuffer)(__GLXDRIdrawable *pdraw,
142 int x, int y, int width, int height);
Jesse Barnesdaf7fe62009-09-15 23:23:09 -0700143 int (*getDrawableMSC)(__GLXscreenConfigs *psc, __GLXDRIdrawable *pdraw,
144 int64_t *ust, int64_t *msc, int64_t *sbc);
145 int (*waitForMSC)(__GLXDRIdrawable *pdraw, int64_t target_msc,
146 int64_t divisor, int64_t remainder, int64_t *ust,
147 int64_t *msc, int64_t *sbc);
148 int (*waitForSBC)(__GLXDRIdrawable *pdraw, int64_t target_sbc, int64_t *ust,
149 int64_t *msc, int64_t *sbc);
Kristian Høgsberg089fc372010-07-19 16:39:53 -0400150 int (*setSwapInterval)(__GLXDRIdrawable *pdraw, int interval);
Jesse Barnesefc82e72009-11-10 13:28:01 -0800151 int (*getSwapInterval)(__GLXDRIdrawable *pdraw);
Kristian Høgsberg20b92302008-03-08 21:02:23 -0500152};
153
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200154struct __GLXDRIcontextRec
155{
Kristian Høgsberg31819832010-07-22 21:24:14 -0400156 Bool(*bindContext) (__GLXcontext *context, __GLXDRIdrawable *pdraw,
157 __GLXDRIdrawable *pread);
158 void (*unbindContext) (__GLXcontext *context);
Kristian Høgsberg020c64b2008-03-08 21:57:29 -0500159};
160
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200161struct __GLXDRIdrawableRec
162{
163 void (*destroyDrawable) (__GLXDRIdrawable * drawable);
Kristian Høgsberg91104252008-03-12 02:18:12 -0400164
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200165 XID xDrawable;
166 XID drawable;
167 __GLXscreenConfigs *psc;
168 GLenum textureTarget;
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200169 GLenum textureFormat; /* EXT_texture_from_pixmap support */
Nick Bowlerf8d81c32010-07-14 12:01:49 -0400170 unsigned long eventMask;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000171};
172
173/*
174** Function to create and DRI display data and initialize the display
175** dependent methods.
176*/
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200177extern __GLXDRIdisplay *driswCreateDisplay(Display * dpy);
178extern __GLXDRIdisplay *driCreateDisplay(Display * dpy);
179extern __GLXDRIdisplay *dri2CreateDisplay(Display * dpy);
Francisco Jerez61d26bc2010-02-08 19:27:56 +0100180extern void dri2InvalidateBuffers(Display *dpy, XID drawable);
181
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000182
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000183/*
184** Functions to obtain driver configuration information from a direct
185** rendering client application
186*/
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200187extern const char *glXGetScreenDriver(Display * dpy, int scrNum);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000188
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200189extern const char *glXGetDriverConfig(const char *driverName);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000190
191#endif
192
193/************************************************************************/
194
195#define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
196
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200197typedef struct __GLXpixelStoreModeRec
198{
199 GLboolean swapEndian;
200 GLboolean lsbFirst;
201 GLuint rowLength;
202 GLuint imageHeight;
203 GLuint imageDepth;
204 GLuint skipRows;
205 GLuint skipPixels;
206 GLuint skipImages;
207 GLuint alignment;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000208} __GLXpixelStoreMode;
209
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000210
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200211typedef struct __GLXattributeRec
212{
213 GLuint mask;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000214
Ian Romanickfdb07632005-02-22 22:36:31 +0000215 /**
216 * Pixel storage state. Most of the pixel store mode state is kept
217 * here and used by the client code to manage the packing and
218 * unpacking of data sent to/received from the server.
219 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200220 __GLXpixelStoreMode storePack, storeUnpack;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000221
Ian Romanickfdb07632005-02-22 22:36:31 +0000222 /**
223 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
224 * disabled?
225 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200226 GLboolean NoDrawArraysProtocol;
227
Ian Romanickfdb07632005-02-22 22:36:31 +0000228 /**
229 * Vertex Array storage state. The vertex array component
230 * state is stored here and is used to manage the packing of
231 * DrawArrays data sent to the server.
232 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200233 struct array_state_vector *array_state;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000234} __GLXattribute;
235
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200236typedef struct __GLXattributeMachineRec
237{
238 __GLXattribute *stack[__GL_CLIENT_ATTRIB_STACK_DEPTH];
239 __GLXattribute **stackPointer;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000240} __GLXattributeMachine;
241
Kristian Høgsberg643b2af2010-05-21 10:36:56 -0400242struct glx_context_vtable {
Kristian Høgsbergc796bb02010-07-22 23:45:18 -0400243 void (*destroy)(__GLXcontext *ctx);
Kristian Høgsberg7b7845a2010-07-22 22:24:00 -0400244 void (*wait_gl)(__GLXcontext *ctx);
245 void (*wait_x)(__GLXcontext *ctx);
246 void (*use_x_font)(__GLXcontext *ctx,
247 Font font, int first, int count, int listBase);
Kristian Høgsberg643b2af2010-05-21 10:36:56 -0400248 void (*bind_tex_image)(Display * dpy,
249 GLXDrawable drawable,
250 int buffer, const int *attrib_list);
251 void (*release_tex_image)(Display * dpy, GLXDrawable drawable, int buffer);
252
253};
254
Kristian Høgsbergc796bb02010-07-22 23:45:18 -0400255extern void
256glx_send_destroy_context(Display *dpy, XID xid);
257
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000258/**
259 * GLX state that needs to be kept on the client. One of these records
260 * exist for each context that has been made current by this client.
261 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200262struct __GLXcontextRec
263{
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000264 /**
265 * \name Drawing command buffer.
266 *
267 * Drawing commands are packed into this buffer before being sent as a
268 * single GLX protocol request. The buffer is sent when it overflows or
269 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
270 * in the buffer to be filled. \c limit is described above in the buffer
271 * slop discussion.
272 *
273 * Commands that require large amounts of data to be transfered will
274 * also use this buffer to hold a header that describes the large
275 * command.
276 *
277 * These must be the first 6 fields since they are static initialized
278 * in the dummy context in glxext.c
279 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200280 /*@{ */
281 GLubyte *buf;
282 GLubyte *pc;
283 GLubyte *limit;
284 GLubyte *bufEnd;
285 GLint bufSize;
286 /*@} */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000287
288 /**
289 * The XID of this rendering context. When the context is created a
290 * new XID is allocated. This is set to None when the context is
291 * destroyed but is still current to some thread. In this case the
292 * context will be freed on next MakeCurrent.
293 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200294 XID xid;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000295
296 /**
297 * The XID of the \c shareList context.
298 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200299 XID share_xid;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000300
301 /**
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000302 * Screen number.
303 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200304 GLint screen;
305 __GLXscreenConfigs *psc;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000306
307 /**
308 * \c GL_TRUE if the context was created with ImportContext, which
309 * means the server-side context was created by another X client.
310 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200311 GLboolean imported;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000312
313 /**
314 * The context tag returned by MakeCurrent when this context is made
315 * current. This tag is used to identify the context that a thread has
316 * current so that proper server context management can be done. It is
317 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
318 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
319 * context)).
320 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200321 GLXContextTag currentContextTag;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000322
323 /**
324 * \name Rendering mode
325 *
326 * The rendering mode is kept on the client as well as the server.
327 * When \c glRenderMode is called, the buffer associated with the
328 * previous rendering mode (feedback or select) is filled.
329 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200330 /*@{ */
331 GLenum renderMode;
332 GLfloat *feedbackBuf;
333 GLuint *selectBuf;
334 /*@} */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000335
336 /**
337 * This is \c GL_TRUE if the pixel unpack modes are such that an image
338 * can be unpacked from the clients memory by just copying. It may
339 * still be true that the server will have to do some work. This
340 * just promises that a straight copy will fetch the correct bytes.
341 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200342 GLboolean fastImageUnpack;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000343
344 /**
345 * Fill newImage with the unpacked form of \c oldImage getting it
346 * ready for transport to the server.
347 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200348 void (*fillImage) (__GLXcontext *, GLint, GLint, GLint, GLint, GLenum,
349 GLenum, const GLvoid *, GLubyte *, GLubyte *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000350
351 /**
Ian Romanick29206ae2005-07-29 17:30:18 +0000352 * Client side attribs.
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000353 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200354 __GLXattributeMachine attributes;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000355
356 /**
357 * Client side error code. This is set when client side gl API
358 * routines need to set an error because of a bad enumerant or
359 * running out of memory, etc.
360 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200361 GLenum error;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000362
363 /**
Xiang, Haihaoae2c31e2008-03-18 15:02:57 +0800364 * Whether this context does direct rendering.
365 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200366 Bool isDirect;
Xiang, Haihaoae2c31e2008-03-18 15:02:57 +0800367
368 /**
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000369 * \c dpy of current display for this context. Will be \c NULL if not
370 * current to any display, or if this is the "dummy context".
371 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200372 Display *currentDpy;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000373
374 /**
375 * The current drawable for this context. Will be None if this
376 * context is not current to any drawable. currentReadable is below.
377 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200378 GLXDrawable currentDrawable;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000379
380 /**
381 * \name GL Constant Strings
382 *
383 * Constant strings that describe the server implementation
384 * These pertain to GL attributes, not to be confused with
385 * GLX versioning attributes.
386 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200387 /*@{ */
388 GLubyte *vendor;
389 GLubyte *renderer;
390 GLubyte *version;
391 GLubyte *extensions;
392 /*@} */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000393
394 /**
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000395 * Maximum small render command size. This is the smaller of 64k and
396 * the size of the above buffer.
397 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200398 GLint maxSmallRenderCommandSize;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000399
400 /**
401 * Major opcode for the extension. Copied here so a lookup isn't
402 * needed.
403 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200404 GLint majorOpcode;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000405
Kristian Høgsberg286ce272007-11-06 14:34:15 -0500406 /**
407 * Pointer to the mode used to create this context.
408 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200409 const __GLcontextModes *mode;
Kristian Høgsberg286ce272007-11-06 14:34:15 -0500410
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000411#ifdef GLX_DIRECT_RENDERING
Jeremy Huddleston80b280d2010-04-02 01:35:19 -0700412#ifdef GLX_USE_APPLEGL
413 void *driContext;
414 Bool do_destroy;
415#else
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200416 __GLXDRIcontext *driContext;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000417#endif
Jeremy Huddleston80b280d2010-04-02 01:35:19 -0700418#endif
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000419
420 /**
421 * The current read-drawable for this context. Will be None if this
422 * context is not current to any drawable.
423 *
424 * \since Internal API version 20030606.
425 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200426 GLXDrawable currentReadable;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000427
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200428 /**
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000429 * Pointer to client-state data that is private to libGL. This is only
430 * used for indirect rendering contexts.
431 *
432 * No internal API version change was made for this change. Client-side
433 * drivers should NEVER use this data or even care that it exists.
434 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200435 void *client_state_private;
Ian Romanickfdb07632005-02-22 22:36:31 +0000436
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000437 /**
438 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
439 */
440 int renderType;
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200441
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000442 /**
443 * \name Raw server GL version
444 *
445 * True core GL version supported by the server. This is the raw value
446 * returned by the server, and it may not reflect what is actually
447 * supported (or reported) by the client-side library.
448 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200449 /*@{ */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000450 int server_major; /**< Major version number. */
451 int server_minor; /**< Minor version number. */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200452 /*@} */
Ian Romanickfdb07632005-02-22 22:36:31 +0000453
Thomas Hellstrom96fd3df2009-04-02 11:00:41 +0200454 /**
455 * Thread ID we're currently current in. Zero if none.
456 */
457 unsigned long thread_id;
458
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200459 char gl_extension_bits[__GL_EXT_BYTES];
Kristian Høgsberg643b2af2010-05-21 10:36:56 -0400460
461 const struct glx_context_vtable *vtable;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000462};
463
Kristian Høgsberg31819832010-07-22 21:24:14 -0400464extern Bool
465glx_context_init(__GLXcontext *gc,
466 __GLXscreenConfigs *psc, const __GLcontextModes *fbconfig);
467
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200468#define __glXSetError(gc,code) \
469 if (!(gc)->error) { \
470 (gc)->error = code; \
471 }
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000472
473extern void __glFreeAttributeState(__GLXcontext *);
474
475/************************************************************************/
476
477/**
478 * The size of the largest drawing command known to the implementation
479 * that will use the GLXRender GLX command. In this case it is
480 * \c glPolygonStipple.
481 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200482#define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000483
484/**
485 * To keep the implementation fast, the code uses a "limit" pointer
486 * to determine when the drawing command buffer is too full to hold
487 * another fixed size command. This constant defines the amount of
488 * space that must always be available in the drawing command buffer
489 * at all times for the implementation to work. It is important that
490 * the number be just large enough, but not so large as to reduce the
491 * efficacy of the buffer. The "+32" is just to keep the code working
492 * in case somebody counts wrong.
493 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200494#define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000495
496/**
497 * This implementation uses a smaller threshold for switching
498 * to the RenderLarge protocol than the protcol requires so that
499 * large copies don't occur.
500 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200501#define __GLX_RENDER_CMD_SIZE_LIMIT 4096
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000502
503/**
504 * One of these records exists per screen of the display. It contains
505 * a pointer to the config data for that screen (if the screen supports GL).
506 */
Kristian Høgsberg6ec39db2010-07-23 16:15:31 -0400507struct glx_screen_vtable {
508 __GLXcontext *(*create_context)(__GLXscreenConfigs *psc,
509 const __GLcontextModes *mode,
510 GLXContext shareList, int renderType);
511};
512
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200513struct __GLXscreenConfigsRec
514{
Kristian Høgsberg6ec39db2010-07-23 16:15:31 -0400515 const struct glx_screen_vtable *vtable;
516
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000517 /**
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000518 * GLX extension string reported by the X-server.
519 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200520 const char *serverGLXexts;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000521
522 /**
523 * GLX extension string to be reported to applications. This is the
524 * set of extensions that the application can actually use.
525 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200526 char *effectiveGLXexts;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000527
Kristian Høgsberg03775512010-07-19 21:00:09 -0400528 __GLXdisplayPrivate *display;
529
Jeremy Huddleston80b280d2010-04-02 01:35:19 -0700530#if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000531 /**
532 * Per screen direct rendering interface functions and data.
533 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200534 Display *dpy;
Kristian Høgsbergf9721152010-07-19 14:57:59 -0400535 int scr;
Kristian Høgsbergac3e8382007-05-15 15:17:30 -0400536
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200537 __GLXDRIscreen *driScreen;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000538#endif
539
540 /**
Kristian Høgsberg6c533ea2007-10-16 16:07:47 -0400541 * Linked list of glx visuals and fbconfigs for this screen.
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000542 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200543 __GLcontextModes *visuals, *configs;
Ian Romanickc39bf5e2005-07-24 06:29:14 +0000544
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000545 /**
546 * Per-screen dynamic GLX extension tracking. The \c direct_support
547 * field only contains enough bits for 64 extensions. Should libGL
548 * ever need to track more than 64 GLX extensions, we can safely grow
549 * this field. The \c __GLXscreenConfigs structure is not used outside
550 * libGL.
551 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200552 /*@{ */
553 unsigned char direct_support[8];
554 GLboolean ext_list_first_time;
555 /*@} */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000556
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400557};
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000558
559/**
560 * Per display private data. One of these records exists for each display
561 * that is using the OpenGL (GLX) extension.
562 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200563struct __GLXdisplayPrivateRec
564{
Kristian Høgsbergab434f62010-07-22 21:11:02 -0400565 /* The extension protocol codes */
566 XExtCodes *codes;
567 struct __GLXdisplayPrivateRec *next;
568
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000569 /**
570 * Back pointer to the display
571 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200572 Display *dpy;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000573
574 /**
575 * The \c majorOpcode is common to all connections to the same server.
576 * It is also copied into the context structure.
577 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200578 int majorOpcode;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000579
580 /**
581 * \name Server Version
582 *
583 * Major and minor version returned by the server during initialization.
584 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200585 /*@{ */
586 int majorVersion, minorVersion;
587 /*@} */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000588
589 /**
590 * \name Storage for the servers GLX vendor and versions strings.
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200591 *
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000592 * These are the same for all screens on this display. These fields will
593 * be filled in on demand.
594 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200595 /*@{ */
596 const char *serverGLXvendor;
597 const char *serverGLXversion;
598 /*@} */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000599
600 /**
601 * Configurations of visuals for all screens on this display.
602 * Also, per screen data which now includes the server \c GLX_EXTENSION
603 * string.
604 */
Kristian Høgsbergf9721152010-07-19 14:57:59 -0400605 __GLXscreenConfigs **screenConfigs;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000606
Jeremy Huddleston80b280d2010-04-02 01:35:19 -0700607#if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
Kristian Høgsberge3e81962010-07-19 21:15:50 -0400608 __glxHashTable *drawHash;
609
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000610 /**
611 * Per display direct rendering interface functions and data.
612 */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200613 __GLXDRIdisplay *driswDisplay;
614 __GLXDRIdisplay *driDisplay;
615 __GLXDRIdisplay *dri2Display;
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000616#endif
617};
618
Kristian Høgsbergf9721152010-07-19 14:57:59 -0400619extern int
620glx_screen_init(__GLXscreenConfigs *psc,
621 int screen, __GLXdisplayPrivate * priv);
622
Kristian Høgsbergc1cbdbf2010-07-20 07:43:50 -0400623#if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
Kristian Høgsberg3750ebd2010-07-19 09:37:07 -0400624extern __GLXDRIdrawable *
625dri2GetGlxDrawableFromXDrawableId(Display *dpy, XID id);
Kristian Høgsbergc1cbdbf2010-07-20 07:43:50 -0400626#endif
Kristian Høgsbergaceccda2007-05-10 15:52:22 -0400627
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200628extern GLubyte *__glXFlushRenderBuffer(__GLXcontext *, GLubyte *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000629
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200630extern void __glXSendLargeChunk(__GLXcontext * gc, GLint requestNumber,
631 GLint totalRequests,
632 const GLvoid * data, GLint dataLen);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000633
634extern void __glXSendLargeCommand(__GLXcontext *, const GLvoid *, GLint,
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200635 const GLvoid *, GLint);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000636
637/* Initialize the GLX extension for dpy */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200638extern __GLXdisplayPrivate *__glXInitialize(Display *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000639
Brian Pauldf2c9422008-07-11 15:43:52 -0600640extern void __glXPreferEGL(int state);
641
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000642/************************************************************************/
643
644extern int __glXDebug;
645
646/* This is per-thread storage in an MT environment */
RALOVICH, Kristóf8363dff2009-07-23 17:58:08 +0200647#if defined( PTHREADS )
Ian Romanick02986cb2005-04-18 16:59:53 +0000648
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200649extern void __glXSetCurrentContext(__GLXcontext * c);
Ian Romanick02986cb2005-04-18 16:59:53 +0000650
651# if defined( GLX_USE_TLS )
652
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200653extern __thread void *__glX_tls_Context
654 __attribute__ ((tls_model("initial-exec")));
Ian Romanick02986cb2005-04-18 16:59:53 +0000655
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200656# define __glXGetCurrentContext() __glX_tls_Context
Ian Romanick02986cb2005-04-18 16:59:53 +0000657
658# else
659
660extern __GLXcontext *__glXGetCurrentContext(void);
661
662# endif /* defined( GLX_USE_TLS ) */
663
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000664#else
Ian Romanick02986cb2005-04-18 16:59:53 +0000665
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000666extern __GLXcontext *__glXcurrentContext;
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200667#define __glXGetCurrentContext() __glXcurrentContext
668#define __glXSetCurrentContext(gc) __glXcurrentContext = gc
Ian Romanick02986cb2005-04-18 16:59:53 +0000669
RALOVICH, Kristóf8363dff2009-07-23 17:58:08 +0200670#endif /* defined( PTHREADS ) */
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000671
George Sapountzisdf04ffb2008-04-18 17:28:34 +0300672extern void __glXSetCurrentContextNull(void);
673
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000674
675/*
676** Global lock for all threads in this address space using the GLX
677** extension
678*/
RALOVICH, Kristóf8363dff2009-07-23 17:58:08 +0200679#if defined( PTHREADS )
Ian Romanick02986cb2005-04-18 16:59:53 +0000680extern pthread_mutex_t __glXmutex;
681#define __glXLock() pthread_mutex_lock(&__glXmutex)
682#define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000683#else
684#define __glXLock()
685#define __glXUnlock()
686#endif
687
688/*
689** Setup for a command. Initialize the extension for dpy if necessary.
690*/
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200691extern CARD8 __glXSetupForCommand(Display * dpy);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000692
693/************************************************************************/
694
695/*
696** Data conversion and packing support.
697*/
698
Ian Romanick5f1f2292005-01-07 02:39:09 +0000699extern const GLuint __glXDefaultPixelStore[9];
700
701/* Send an image to the server using RenderLarge. */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200702extern void __glXSendLargeImage(__GLXcontext * gc, GLint compsize, GLint dim,
703 GLint width, GLint height, GLint depth,
704 GLenum format, GLenum type,
705 const GLvoid * src, GLubyte * pc,
706 GLubyte * modes);
Ian Romanick5f1f2292005-01-07 02:39:09 +0000707
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000708/* Return the size, in bytes, of some pixel data */
Ian Romanick5f1f2292005-01-07 02:39:09 +0000709extern GLint __glImageSize(GLint, GLint, GLint, GLenum, GLenum, GLenum);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000710
711/* Return the number of elements per group of a specified format*/
712extern GLint __glElementsPerGroup(GLenum format, GLenum type);
713
714/* Return the number of bytes per element, based on the element type (other
715** than GL_BITMAP).
716*/
717extern GLint __glBytesPerElement(GLenum type);
718
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000719/*
720** Fill the transport buffer with the data from the users buffer,
721** applying some of the pixel store modes (unpack modes) to the data
722** first. As a side effect of this call, the "modes" field is
723** updated to contain the modes needed by the server to decode the
724** sent data.
725*/
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200726extern void __glFillImage(__GLXcontext *, GLint, GLint, GLint, GLint, GLenum,
727 GLenum, const GLvoid *, GLubyte *, GLubyte *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000728
729/* Copy map data with a stride into a packed buffer */
730extern void __glFillMap1f(GLint, GLint, GLint, const GLfloat *, GLubyte *);
731extern void __glFillMap1d(GLint, GLint, GLint, const GLdouble *, GLubyte *);
732extern void __glFillMap2f(GLint, GLint, GLint, GLint, GLint,
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200733 const GLfloat *, GLfloat *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000734extern void __glFillMap2d(GLint, GLint, GLint, GLint, GLint,
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200735 const GLdouble *, GLdouble *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000736
737/*
738** Empty an image out of the reply buffer into the clients memory applying
739** the pack modes to pack back into the clients requested format.
740*/
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200741extern void __glEmptyImage(__GLXcontext *, GLint, GLint, GLint, GLint, GLenum,
742 GLenum, const GLubyte *, GLvoid *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000743
744
745/*
Kristof Raloviche2060342008-08-20 15:18:38 -0600746** Allocate and Initialize Vertex Array client state, and free.
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000747*/
Kristof Raloviche2060342008-08-20 15:18:38 -0600748extern void __glXInitVertexArrayState(__GLXcontext *);
749extern void __glXFreeVertexArrayState(__GLXcontext *);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000750
751/*
752** Inform the Server of the major and minor numbers and of the client
753** libraries extension string.
754*/
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200755extern void __glXClientInfo(Display * dpy, int opcode);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000756
757/************************************************************************/
758
759/*
760** Declarations that should be in Xlib
761*/
762#ifdef __GL_USE_OUR_PROTOTYPES
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200763extern void _XFlush(Display *);
764extern Status _XReply(Display *, xReply *, int, Bool);
765extern void _XRead(Display *, void *, long);
766extern void _XSend(Display *, const void *, long);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000767#endif
768
769
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200770extern void __glXInitializeVisualConfigFromTags(__GLcontextModes * config,
771 int count, const INT32 * bp,
772 Bool tagged_only,
773 Bool fbconfig_style_tags);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000774
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200775extern char *__glXQueryServerString(Display * dpy, int opcode,
776 CARD32 screen, CARD32 name);
777extern char *__glXGetString(Display * dpy, int opcode,
778 CARD32 screen, CARD32 name);
RALOVICH, Kristóf54444242008-10-18 16:53:08 +0200779
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000780extern char *__glXstrdup(const char *str);
781
782
783extern const char __glXGLClientVersion[];
784extern const char __glXGLClientExtensions[];
785
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000786/* Get the unadjusted system time */
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200787extern int __glXGetUST(int64_t * ust);
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000788
Kristian Høgsberg286ce272007-11-06 14:34:15 -0500789extern GLboolean __glXGetMscRateOML(Display * dpy, GLXDrawable drawable,
RALOVICH, Kristóf08962682009-08-12 12:41:22 +0200790 int32_t * numerator,
791 int32_t * denominator);
Ian Romanickfc5b57b2006-08-29 15:38:19 +0000792
Jeremy Huddleston80b280d2010-04-02 01:35:19 -0700793#if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
Kristian Høgsberg7a66e542010-07-21 14:09:49 -0400794extern GLboolean
795__glxGetMscRate(__GLXDRIdrawable *glxDraw,
796 int32_t * numerator, int32_t * denominator);
Robert Bragg7a9329b2010-01-20 03:01:14 +0000797
798/* So that dri2.c:DRI2WireToEvent() can access
799 * glx_info->codes->first_event */
800XExtDisplayInfo *__glXFindDisplay (Display *dpy);
Kristian Høgsberg97ec6072010-02-15 11:12:28 -0500801
Kristian Høgsbergc796bb02010-07-22 23:45:18 -0400802extern void
803GarbageCollectDRIDrawables(__GLXscreenConfigs *psc);
804
Kristian Høgsberg97ec6072010-02-15 11:12:28 -0500805extern __GLXDRIdrawable *
Kristian Høgsbergeeaab202010-07-22 22:36:37 -0400806GetGLXDRIDrawable(Display *dpy, GLXDrawable drawable);
Kristian Høgsberg97ec6072010-02-15 11:12:28 -0500807
Kristian Høgsberg286ce272007-11-06 14:34:15 -0500808#endif
809
Kristian Høgsberg6ec39db2010-07-23 16:15:31 -0400810extern __GLXscreenConfigs *
811indirect_create_screen(int screen, __GLXdisplayPrivate * priv);
812
Adam Jacksoncb3610e2004-10-25 21:09:16 +0000813#endif /* !__GLX_client_h__ */