2 * SGI FREE SOFTWARE LICENSE B (Version 2.0, Sept. 18, 2008)
3 * Copyright (C) 1991-2000 Silicon Graphics, Inc. All Rights Reserved.
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:
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.
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
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.
33 * Direct rendering support added by Precision Insight, Inc.
35 * \author Kevin E. Martin <kevin@precisioninsight.com>
38 #ifndef _GLX_client_h_
39 #define _GLX_client_h_
42 #include <X11/Xproto.h>
43 #include <X11/Xlibint.h>
44 #include <X11/extensions/extutil.h>
45 #define GLX_GLXEXT_PROTOTYPES
47 #include <GL/glxext.h>
54 #include "GL/glxint.h"
55 #include "GL/glxproto.h"
56 #include "GL/internal/glcore.h"
57 #include "glapi/glapitable.h"
59 #if defined( PTHREADS )
63 #include "glxextensions.h"
66 /* If we build the library with gcc's -fvisibility=hidden flag, we'll
67 * use the PUBLIC macro to mark functions that are to be exported.
69 * We also need to define a USED attribute, so the optimizer doesn't
70 * inline a static function that we later use in an alias. - ajax
72 #if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
73 # define PUBLIC __attribute__((visibility("default")))
74 # define USED __attribute__((used))
82 #define GLX_MAJOR_VERSION 1 /* current version numbers */
83 #define GLX_MINOR_VERSION 4
85 #define __GLX_MAX_TEXTURE_UNITS 32
87 typedef struct __GLXscreenConfigsRec __GLXscreenConfigs;
88 typedef struct __GLXcontextRec __GLXcontext;
89 typedef struct __GLXdrawableRec __GLXdrawable;
90 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate;
91 typedef struct _glapi_table __GLapi;
93 /************************************************************************/
95 #ifdef GLX_DIRECT_RENDERING
97 #define containerOf(ptr, type, member) \
98 (type *)( (char *)ptr - offsetof(type,member) )
100 #include <GL/internal/dri_interface.h>
104 * Display dependent methods. This structure is initialized during the
105 * \c driCreateDisplay call.
107 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay;
108 typedef struct __GLXDRIscreenRec __GLXDRIscreen;
109 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable;
110 typedef struct __GLXDRIcontextRec __GLXDRIcontext;
112 #include "glxextensions.h"
114 struct __GLXDRIdisplayRec
117 * Method to destroy the private DRI display data.
119 void (*destroyDisplay) (__GLXDRIdisplay * display);
121 __GLXDRIscreen *(*createScreen) (__GLXscreenConfigs * psc, int screen,
122 __GLXdisplayPrivate * priv);
125 struct __GLXDRIscreenRec {
127 void (*destroyScreen)(__GLXscreenConfigs *psc);
129 __GLXDRIcontext *(*createContext)(__GLXscreenConfigs *psc,
130 const __GLcontextModes *mode,
132 GLXContext shareList, int renderType);
134 __GLXDRIdrawable *(*createDrawable)(__GLXscreenConfigs *psc,
136 GLXDrawable glxDrawable,
137 const __GLcontextModes *modes);
139 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);
143 void (*waitX)(__GLXDRIdrawable *pdraw);
144 void (*waitGL)(__GLXDRIdrawable *pdraw);
145 int (*getDrawableMSC)(__GLXscreenConfigs *psc, __GLXDRIdrawable *pdraw,
146 int64_t *ust, int64_t *msc, int64_t *sbc);
147 int (*waitForMSC)(__GLXDRIdrawable *pdraw, int64_t target_msc,
148 int64_t divisor, int64_t remainder, int64_t *ust,
149 int64_t *msc, int64_t *sbc);
150 int (*waitForSBC)(__GLXDRIdrawable *pdraw, int64_t target_sbc, int64_t *ust,
151 int64_t *msc, int64_t *sbc);
152 void (*setSwapInterval)(__GLXDRIdrawable *pdraw, int interval);
153 int (*getSwapInterval)(__GLXDRIdrawable *pdraw);
156 struct __GLXDRIcontextRec
158 void (*destroyContext) (__GLXDRIcontext * context,
159 __GLXscreenConfigs * psc, Display * dpy);
160 Bool(*bindContext) (__GLXDRIcontext * context, __GLXDRIdrawable * pdraw,
161 __GLXDRIdrawable * pread);
163 void (*unbindContext) (__GLXDRIcontext * context);
166 struct __GLXDRIdrawableRec
168 void (*destroyDrawable) (__GLXDRIdrawable * drawable);
172 __GLXscreenConfigs *psc;
173 GLenum textureTarget;
174 __DRIdrawable *driDrawable;
175 GLenum textureFormat; /* EXT_texture_from_pixmap support */
179 ** Function to create and DRI display data and initialize the display
180 ** dependent methods.
182 extern __GLXDRIdisplay *driswCreateDisplay(Display * dpy);
183 extern __GLXDRIdisplay *driCreateDisplay(Display * dpy);
184 extern __GLXDRIdisplay *dri2CreateDisplay(Display * dpy);
186 extern void DRI_glXUseXFont(Font font, int first, int count, int listbase);
189 ** Functions to obtain driver configuration information from a direct
190 ** rendering client application
192 extern const char *glXGetScreenDriver(Display * dpy, int scrNum);
194 extern const char *glXGetDriverConfig(const char *driverName);
198 /************************************************************************/
200 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
202 typedef struct __GLXpixelStoreModeRec
204 GLboolean swapEndian;
213 } __GLXpixelStoreMode;
216 typedef struct __GLXattributeRec
221 * Pixel storage state. Most of the pixel store mode state is kept
222 * here and used by the client code to manage the packing and
223 * unpacking of data sent to/received from the server.
225 __GLXpixelStoreMode storePack, storeUnpack;
228 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
231 GLboolean NoDrawArraysProtocol;
234 * Vertex Array storage state. The vertex array component
235 * state is stored here and is used to manage the packing of
236 * DrawArrays data sent to the server.
238 struct array_state_vector *array_state;
241 typedef struct __GLXattributeMachineRec
243 __GLXattribute *stack[__GL_CLIENT_ATTRIB_STACK_DEPTH];
244 __GLXattribute **stackPointer;
245 } __GLXattributeMachine;
248 * GLX state that needs to be kept on the client. One of these records
249 * exist for each context that has been made current by this client.
251 struct __GLXcontextRec
254 * \name Drawing command buffer.
256 * Drawing commands are packed into this buffer before being sent as a
257 * single GLX protocol request. The buffer is sent when it overflows or
258 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
259 * in the buffer to be filled. \c limit is described above in the buffer
262 * Commands that require large amounts of data to be transfered will
263 * also use this buffer to hold a header that describes the large
266 * These must be the first 6 fields since they are static initialized
267 * in the dummy context in glxext.c
278 * The XID of this rendering context. When the context is created a
279 * new XID is allocated. This is set to None when the context is
280 * destroyed but is still current to some thread. In this case the
281 * context will be freed on next MakeCurrent.
286 * The XID of the \c shareList context.
294 __GLXscreenConfigs *psc;
297 * \c GL_TRUE if the context was created with ImportContext, which
298 * means the server-side context was created by another X client.
303 * The context tag returned by MakeCurrent when this context is made
304 * current. This tag is used to identify the context that a thread has
305 * current so that proper server context management can be done. It is
306 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
307 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
310 GLXContextTag currentContextTag;
313 * \name Rendering mode
315 * The rendering mode is kept on the client as well as the server.
316 * When \c glRenderMode is called, the buffer associated with the
317 * previous rendering mode (feedback or select) is filled.
321 GLfloat *feedbackBuf;
326 * This is \c GL_TRUE if the pixel unpack modes are such that an image
327 * can be unpacked from the clients memory by just copying. It may
328 * still be true that the server will have to do some work. This
329 * just promises that a straight copy will fetch the correct bytes.
331 GLboolean fastImageUnpack;
334 * Fill newImage with the unpacked form of \c oldImage getting it
335 * ready for transport to the server.
337 void (*fillImage) (__GLXcontext *, GLint, GLint, GLint, GLint, GLenum,
338 GLenum, const GLvoid *, GLubyte *, GLubyte *);
341 * Client side attribs.
343 __GLXattributeMachine attributes;
346 * Client side error code. This is set when client side gl API
347 * routines need to set an error because of a bad enumerant or
348 * running out of memory, etc.
353 * Whether this context does direct rendering.
358 * \c dpy of current display for this context. Will be \c NULL if not
359 * current to any display, or if this is the "dummy context".
364 * The current drawable for this context. Will be None if this
365 * context is not current to any drawable. currentReadable is below.
367 GLXDrawable currentDrawable;
370 * \name GL Constant Strings
372 * Constant strings that describe the server implementation
373 * These pertain to GL attributes, not to be confused with
374 * GLX versioning attributes.
384 * Record the dpy this context was created on for later freeing
389 * Maximum small render command size. This is the smaller of 64k and
390 * the size of the above buffer.
392 GLint maxSmallRenderCommandSize;
395 * Major opcode for the extension. Copied here so a lookup isn't
401 * Pointer to the mode used to create this context.
403 const __GLcontextModes *mode;
405 #ifdef GLX_DIRECT_RENDERING
406 __GLXDRIcontext *driContext;
407 __DRIcontext *__driContext;
411 * The current read-drawable for this context. Will be None if this
412 * context is not current to any drawable.
414 * \since Internal API version 20030606.
416 GLXDrawable currentReadable;
419 * Pointer to client-state data that is private to libGL. This is only
420 * used for indirect rendering contexts.
422 * No internal API version change was made for this change. Client-side
423 * drivers should NEVER use this data or even care that it exists.
425 void *client_state_private;
428 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
433 * \name Raw server GL version
435 * True core GL version supported by the server. This is the raw value
436 * returned by the server, and it may not reflect what is actually
437 * supported (or reported) by the client-side library.
440 int server_major; /**< Major version number. */
441 int server_minor; /**< Minor version number. */
445 * Thread ID we're currently current in. Zero if none.
447 unsigned long thread_id;
449 char gl_extension_bits[__GL_EXT_BYTES];
452 #define __glXSetError(gc,code) \
453 if (!(gc)->error) { \
454 (gc)->error = code; \
457 extern void __glFreeAttributeState(__GLXcontext *);
459 /************************************************************************/
462 * The size of the largest drawing command known to the implementation
463 * that will use the GLXRender GLX command. In this case it is
464 * \c glPolygonStipple.
466 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
469 * To keep the implementation fast, the code uses a "limit" pointer
470 * to determine when the drawing command buffer is too full to hold
471 * another fixed size command. This constant defines the amount of
472 * space that must always be available in the drawing command buffer
473 * at all times for the implementation to work. It is important that
474 * the number be just large enough, but not so large as to reduce the
475 * efficacy of the buffer. The "+32" is just to keep the code working
476 * in case somebody counts wrong.
478 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
481 * This implementation uses a smaller threshold for switching
482 * to the RenderLarge protocol than the protcol requires so that
483 * large copies don't occur.
485 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
488 * One of these records exists per screen of the display. It contains
489 * a pointer to the config data for that screen (if the screen supports GL).
491 struct __GLXscreenConfigsRec
494 * GLX extension string reported by the X-server.
496 const char *serverGLXexts;
499 * GLX extension string to be reported to applications. This is the
500 * set of extensions that the application can actually use.
502 char *effectiveGLXexts;
504 #ifdef GLX_DIRECT_RENDERING
506 * Per screen direct rendering interface functions and data.
508 __DRIscreen *__driScreen;
509 const __DRIcoreExtension *core;
510 const __DRIlegacyExtension *legacy;
511 const __DRIswrastExtension *swrast;
512 const __DRIdri2Extension *dri2;
513 __glxHashTable *drawHash;
518 __GLXDRIscreen *driScreen;
520 const __DRIconfig **driver_configs;
522 #ifdef __DRI_COPY_SUB_BUFFER
523 const __DRIcopySubBufferExtension *driCopySubBuffer;
526 #ifdef __DRI_SWAP_CONTROL
527 const __DRIswapControlExtension *swapControl;
530 #ifdef __DRI_ALLOCATE
531 const __DRIallocateExtension *allocate;
534 #ifdef __DRI_FRAME_TRACKING
535 const __DRIframeTrackingExtension *frameTracking;
538 #ifdef __DRI_MEDIA_STREAM_COUNTER
539 const __DRImediaStreamCounterExtension *msc;
542 #ifdef __DRI_TEX_BUFFER
543 const __DRItexBufferExtension *texBuffer;
547 const __DRI2flushExtension *f;
553 * Linked list of glx visuals and fbconfigs for this screen.
555 __GLcontextModes *visuals, *configs;
558 * Per-screen dynamic GLX extension tracking. The \c direct_support
559 * field only contains enough bits for 64 extensions. Should libGL
560 * ever need to track more than 64 GLX extensions, we can safely grow
561 * this field. The \c __GLXscreenConfigs structure is not used outside
565 unsigned char direct_support[8];
566 GLboolean ext_list_first_time;
572 * Per display private data. One of these records exists for each display
573 * that is using the OpenGL (GLX) extension.
575 struct __GLXdisplayPrivateRec
578 * Back pointer to the display
583 * The \c majorOpcode is common to all connections to the same server.
584 * It is also copied into the context structure.
589 * \name Server Version
591 * Major and minor version returned by the server during initialization.
594 int majorVersion, minorVersion;
598 * \name Storage for the servers GLX vendor and versions strings.
600 * These are the same for all screens on this display. These fields will
601 * be filled in on demand.
604 const char *serverGLXvendor;
605 const char *serverGLXversion;
609 * Configurations of visuals for all screens on this display.
610 * Also, per screen data which now includes the server \c GLX_EXTENSION
613 __GLXscreenConfigs *screenConfigs;
615 #ifdef GLX_DIRECT_RENDERING
617 * Per display direct rendering interface functions and data.
619 __GLXDRIdisplay *driswDisplay;
620 __GLXDRIdisplay *driDisplay;
621 __GLXDRIdisplay *dri2Display;
626 extern GLubyte *__glXFlushRenderBuffer(__GLXcontext *, GLubyte *);
628 extern void __glXSendLargeChunk(__GLXcontext * gc, GLint requestNumber,
630 const GLvoid * data, GLint dataLen);
632 extern void __glXSendLargeCommand(__GLXcontext *, const GLvoid *, GLint,
633 const GLvoid *, GLint);
635 /* Initialize the GLX extension for dpy */
636 extern __GLXdisplayPrivate *__glXInitialize(Display *);
638 extern void __glXPreferEGL(int state);
640 /************************************************************************/
642 extern int __glXDebug;
644 /* This is per-thread storage in an MT environment */
645 #if defined( PTHREADS )
647 extern void __glXSetCurrentContext(__GLXcontext * c);
649 # if defined( GLX_USE_TLS )
651 extern __thread void *__glX_tls_Context
652 __attribute__ ((tls_model("initial-exec")));
654 # define __glXGetCurrentContext() __glX_tls_Context
658 extern __GLXcontext *__glXGetCurrentContext(void);
660 # endif /* defined( GLX_USE_TLS ) */
664 extern __GLXcontext *__glXcurrentContext;
665 #define __glXGetCurrentContext() __glXcurrentContext
666 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
668 #endif /* defined( PTHREADS ) */
670 extern void __glXSetCurrentContextNull(void);
672 extern void __glXFreeContext(__GLXcontext *);
676 ** Global lock for all threads in this address space using the GLX
679 #if defined( PTHREADS )
680 extern pthread_mutex_t __glXmutex;
681 #define __glXLock() pthread_mutex_lock(&__glXmutex)
682 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
685 #define __glXUnlock()
689 ** Setup for a command. Initialize the extension for dpy if necessary.
691 extern CARD8 __glXSetupForCommand(Display * dpy);
693 /************************************************************************/
696 ** Data conversion and packing support.
699 extern const GLuint __glXDefaultPixelStore[9];
701 /* Send an image to the server using RenderLarge. */
702 extern 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,
708 /* Return the size, in bytes, of some pixel data */
709 extern GLint __glImageSize(GLint, GLint, GLint, GLenum, GLenum, GLenum);
711 /* Return the number of elements per group of a specified format*/
712 extern GLint __glElementsPerGroup(GLenum format, GLenum type);
714 /* Return the number of bytes per element, based on the element type (other
717 extern GLint __glBytesPerElement(GLenum type);
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
726 extern void __glFillImage(__GLXcontext *, GLint, GLint, GLint, GLint, GLenum,
727 GLenum, const GLvoid *, GLubyte *, GLubyte *);
729 /* Copy map data with a stride into a packed buffer */
730 extern void __glFillMap1f(GLint, GLint, GLint, const GLfloat *, GLubyte *);
731 extern void __glFillMap1d(GLint, GLint, GLint, const GLdouble *, GLubyte *);
732 extern void __glFillMap2f(GLint, GLint, GLint, GLint, GLint,
733 const GLfloat *, GLfloat *);
734 extern void __glFillMap2d(GLint, GLint, GLint, GLint, GLint,
735 const GLdouble *, GLdouble *);
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.
741 extern void __glEmptyImage(__GLXcontext *, GLint, GLint, GLint, GLint, GLenum,
742 GLenum, const GLubyte *, GLvoid *);
746 ** Allocate and Initialize Vertex Array client state, and free.
748 extern void __glXInitVertexArrayState(__GLXcontext *);
749 extern void __glXFreeVertexArrayState(__GLXcontext *);
752 ** Inform the Server of the major and minor numbers and of the client
753 ** libraries extension string.
755 extern void __glXClientInfo(Display * dpy, int opcode);
757 /************************************************************************/
760 ** Declarations that should be in Xlib
762 #ifdef __GL_USE_OUR_PROTOTYPES
763 extern void _XFlush(Display *);
764 extern Status _XReply(Display *, xReply *, int, Bool);
765 extern void _XRead(Display *, void *, long);
766 extern void _XSend(Display *, const void *, long);
770 extern void __glXInitializeVisualConfigFromTags(__GLcontextModes * config,
771 int count, const INT32 * bp,
773 Bool fbconfig_style_tags);
775 extern char *__glXQueryServerString(Display * dpy, int opcode,
776 CARD32 screen, CARD32 name);
777 extern char *__glXGetString(Display * dpy, int opcode,
778 CARD32 screen, CARD32 name);
780 extern char *__glXstrdup(const char *str);
783 extern const char __glXGLClientVersion[];
784 extern const char __glXGLClientExtensions[];
786 /* Get the unadjusted system time */
787 extern int __glXGetUST(int64_t * ust);
789 extern GLboolean __glXGetMscRateOML(Display * dpy, GLXDrawable drawable,
791 int32_t * denominator);
793 #ifdef GLX_DIRECT_RENDERING
795 __driGetMscRateOML(__DRIdrawable * draw,
796 int32_t * numerator, int32_t * denominator, void *private);
798 /* So that dri2.c:DRI2WireToEvent() can access
799 * glx_info->codes->first_event */
800 XExtDisplayInfo *__glXFindDisplay (Display *dpy);
802 extern __GLXDRIdrawable *
803 GetGLXDRIDrawable(Display *dpy, GLXDrawable drawable, int *const scrn_num);
807 #endif /* !__GLX_client_h__ */