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_
40 #include <X11/Xproto.h>
41 #include <X11/Xlibint.h>
42 #include <X11/extensions/extutil.h>
43 #define GLX_GLXEXT_PROTOTYPES
45 #include <GL/glxext.h>
52 #include "GL/glxint.h"
53 #include "GL/glxproto.h"
54 #include "GL/internal/glcore.h"
55 #include "glapi/glapitable.h"
57 #if defined( PTHREADS )
61 #include "glxextensions.h"
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.
67 * We also need to define a USED attribute, so the optimizer doesn't
68 * inline a static function that we later use in an alias. - ajax
71 # define PUBLIC __attribute__((visibility("default")))
72 # define USED __attribute__((used))
80 #define GLX_MAJOR_VERSION 1 /* current version numbers */
81 #define GLX_MINOR_VERSION 4
83 #define __GLX_MAX_TEXTURE_UNITS 32
85 typedef struct __GLXscreenConfigsRec __GLXscreenConfigs
;
86 typedef struct __GLXcontextRec __GLXcontext
;
87 typedef struct __GLXdrawableRec __GLXdrawable
;
88 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate
;
89 typedef struct _glapi_table __GLapi
;
91 /************************************************************************/
93 #ifdef GLX_DIRECT_RENDERING
95 #define containerOf(ptr, type, member) \
96 (type *)( (char *)ptr - offsetof(type,member) )
98 extern void DRI_glXUseXFont(Font font
, int first
, int count
, int listbase
);
102 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
105 * Display dependent methods. This structure is initialized during the
106 * \c driCreateDisplay call.
108 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
109 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
110 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
111 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
113 #include "glxextensions.h"
115 struct __GLXDRIdisplayRec
118 * Method to destroy the private DRI display data.
120 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
122 __GLXscreenConfigs
*(*createScreen
)(int screen
, __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 int (*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 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
175 unsigned long eventMask
;
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
);
185 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
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
;
247 struct glx_context_vtable
{
248 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
);
256 * GLX state that needs to be kept on the client. One of these records
257 * exist for each context that has been made current by this client.
259 struct __GLXcontextRec
262 * \name Drawing command buffer.
264 * Drawing commands are packed into this buffer before being sent as a
265 * single GLX protocol request. The buffer is sent when it overflows or
266 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
267 * in the buffer to be filled. \c limit is described above in the buffer
270 * Commands that require large amounts of data to be transfered will
271 * also use this buffer to hold a header that describes the large
274 * These must be the first 6 fields since they are static initialized
275 * in the dummy context in glxext.c
286 * The XID of this rendering context. When the context is created a
287 * new XID is allocated. This is set to None when the context is
288 * destroyed but is still current to some thread. In this case the
289 * context will be freed on next MakeCurrent.
294 * The XID of the \c shareList context.
302 __GLXscreenConfigs
*psc
;
305 * \c GL_TRUE if the context was created with ImportContext, which
306 * means the server-side context was created by another X client.
311 * The context tag returned by MakeCurrent when this context is made
312 * current. This tag is used to identify the context that a thread has
313 * current so that proper server context management can be done. It is
314 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
315 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
318 GLXContextTag currentContextTag
;
321 * \name Rendering mode
323 * The rendering mode is kept on the client as well as the server.
324 * When \c glRenderMode is called, the buffer associated with the
325 * previous rendering mode (feedback or select) is filled.
329 GLfloat
*feedbackBuf
;
334 * This is \c GL_TRUE if the pixel unpack modes are such that an image
335 * can be unpacked from the clients memory by just copying. It may
336 * still be true that the server will have to do some work. This
337 * just promises that a straight copy will fetch the correct bytes.
339 GLboolean fastImageUnpack
;
342 * Fill newImage with the unpacked form of \c oldImage getting it
343 * ready for transport to the server.
345 void (*fillImage
) (__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
346 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
349 * Client side attribs.
351 __GLXattributeMachine attributes
;
354 * Client side error code. This is set when client side gl API
355 * routines need to set an error because of a bad enumerant or
356 * running out of memory, etc.
361 * Whether this context does direct rendering.
366 * \c dpy of current display for this context. Will be \c NULL if not
367 * current to any display, or if this is the "dummy context".
372 * The current drawable for this context. Will be None if this
373 * context is not current to any drawable. currentReadable is below.
375 GLXDrawable currentDrawable
;
378 * \name GL Constant Strings
380 * Constant strings that describe the server implementation
381 * These pertain to GL attributes, not to be confused with
382 * GLX versioning attributes.
392 * Record the dpy this context was created on for later freeing
397 * Maximum small render command size. This is the smaller of 64k and
398 * the size of the above buffer.
400 GLint maxSmallRenderCommandSize
;
403 * Major opcode for the extension. Copied here so a lookup isn't
409 * Pointer to the mode used to create this context.
411 const __GLcontextModes
*mode
;
413 #ifdef GLX_DIRECT_RENDERING
414 #ifdef GLX_USE_APPLEGL
418 __GLXDRIcontext
*driContext
;
423 * The current read-drawable for this context. Will be None if this
424 * context is not current to any drawable.
426 * \since Internal API version 20030606.
428 GLXDrawable currentReadable
;
431 * Pointer to client-state data that is private to libGL. This is only
432 * used for indirect rendering contexts.
434 * No internal API version change was made for this change. Client-side
435 * drivers should NEVER use this data or even care that it exists.
437 void *client_state_private
;
440 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
445 * \name Raw server GL version
447 * True core GL version supported by the server. This is the raw value
448 * returned by the server, and it may not reflect what is actually
449 * supported (or reported) by the client-side library.
452 int server_major
; /**< Major version number. */
453 int server_minor
; /**< Minor version number. */
457 * Thread ID we're currently current in. Zero if none.
459 unsigned long thread_id
;
461 char gl_extension_bits
[__GL_EXT_BYTES
];
463 const struct glx_context_vtable
*vtable
;
466 #define __glXSetError(gc,code) \
467 if (!(gc)->error) { \
468 (gc)->error = code; \
471 extern void __glFreeAttributeState(__GLXcontext
*);
473 /************************************************************************/
476 * The size of the largest drawing command known to the implementation
477 * that will use the GLXRender GLX command. In this case it is
478 * \c glPolygonStipple.
480 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
483 * To keep the implementation fast, the code uses a "limit" pointer
484 * to determine when the drawing command buffer is too full to hold
485 * another fixed size command. This constant defines the amount of
486 * space that must always be available in the drawing command buffer
487 * at all times for the implementation to work. It is important that
488 * the number be just large enough, but not so large as to reduce the
489 * efficacy of the buffer. The "+32" is just to keep the code working
490 * in case somebody counts wrong.
492 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
495 * This implementation uses a smaller threshold for switching
496 * to the RenderLarge protocol than the protcol requires so that
497 * large copies don't occur.
499 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
502 * One of these records exists per screen of the display. It contains
503 * a pointer to the config data for that screen (if the screen supports GL).
505 struct __GLXscreenConfigsRec
508 * GLX extension string reported by the X-server.
510 const char *serverGLXexts
;
513 * GLX extension string to be reported to applications. This is the
514 * set of extensions that the application can actually use.
516 char *effectiveGLXexts
;
519 * Context vtable to use for direct contexts on this screen
521 const struct glx_context_vtable
*direct_context_vtable
;
523 __GLXdisplayPrivate
*display
;
525 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
527 * Per screen direct rendering interface functions and data.
532 __GLXDRIscreen
*driScreen
;
536 * Linked list of glx visuals and fbconfigs for this screen.
538 __GLcontextModes
*visuals
, *configs
;
541 * Per-screen dynamic GLX extension tracking. The \c direct_support
542 * field only contains enough bits for 64 extensions. Should libGL
543 * ever need to track more than 64 GLX extensions, we can safely grow
544 * this field. The \c __GLXscreenConfigs structure is not used outside
548 unsigned char direct_support
[8];
549 GLboolean ext_list_first_time
;
555 * Per display private data. One of these records exists for each display
556 * that is using the OpenGL (GLX) extension.
558 struct __GLXdisplayPrivateRec
561 * Back pointer to the display
566 * The \c majorOpcode is common to all connections to the same server.
567 * It is also copied into the context structure.
572 * \name Server Version
574 * Major and minor version returned by the server during initialization.
577 int majorVersion
, minorVersion
;
581 * \name Storage for the servers GLX vendor and versions strings.
583 * These are the same for all screens on this display. These fields will
584 * be filled in on demand.
587 const char *serverGLXvendor
;
588 const char *serverGLXversion
;
592 * Configurations of visuals for all screens on this display.
593 * Also, per screen data which now includes the server \c GLX_EXTENSION
596 __GLXscreenConfigs
**screenConfigs
;
598 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
599 __glxHashTable
*drawHash
;
602 * Per display direct rendering interface functions and data.
604 __GLXDRIdisplay
*driswDisplay
;
605 __GLXDRIdisplay
*driDisplay
;
606 __GLXDRIdisplay
*dri2Display
;
611 glx_screen_init(__GLXscreenConfigs
*psc
,
612 int screen
, __GLXdisplayPrivate
* priv
);
614 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
615 extern __GLXDRIdrawable
*
616 dri2GetGlxDrawableFromXDrawableId(Display
*dpy
, XID id
);
619 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
621 extern void __glXSendLargeChunk(__GLXcontext
* gc
, GLint requestNumber
,
623 const GLvoid
* data
, GLint dataLen
);
625 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
626 const GLvoid
*, GLint
);
628 /* Initialize the GLX extension for dpy */
629 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
631 extern void __glXPreferEGL(int state
);
633 /************************************************************************/
635 extern int __glXDebug
;
637 /* This is per-thread storage in an MT environment */
638 #if defined( PTHREADS )
640 extern void __glXSetCurrentContext(__GLXcontext
* c
);
642 # if defined( GLX_USE_TLS )
644 extern __thread
void *__glX_tls_Context
645 __attribute__ ((tls_model("initial-exec")));
647 # define __glXGetCurrentContext() __glX_tls_Context
651 extern __GLXcontext
*__glXGetCurrentContext(void);
653 # endif /* defined( GLX_USE_TLS ) */
657 extern __GLXcontext
*__glXcurrentContext
;
658 #define __glXGetCurrentContext() __glXcurrentContext
659 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
661 #endif /* defined( PTHREADS ) */
663 extern void __glXSetCurrentContextNull(void);
665 extern void __glXFreeContext(__GLXcontext
*);
669 ** Global lock for all threads in this address space using the GLX
672 #if defined( PTHREADS )
673 extern pthread_mutex_t __glXmutex
;
674 #define __glXLock() pthread_mutex_lock(&__glXmutex)
675 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
678 #define __glXUnlock()
682 ** Setup for a command. Initialize the extension for dpy if necessary.
684 extern CARD8
__glXSetupForCommand(Display
* dpy
);
686 /************************************************************************/
689 ** Data conversion and packing support.
692 extern const GLuint __glXDefaultPixelStore
[9];
694 /* Send an image to the server using RenderLarge. */
695 extern void __glXSendLargeImage(__GLXcontext
* gc
, GLint compsize
, GLint dim
,
696 GLint width
, GLint height
, GLint depth
,
697 GLenum format
, GLenum type
,
698 const GLvoid
* src
, GLubyte
* pc
,
701 /* Return the size, in bytes, of some pixel data */
702 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
704 /* Return the number of elements per group of a specified format*/
705 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
707 /* Return the number of bytes per element, based on the element type (other
710 extern GLint
__glBytesPerElement(GLenum type
);
713 ** Fill the transport buffer with the data from the users buffer,
714 ** applying some of the pixel store modes (unpack modes) to the data
715 ** first. As a side effect of this call, the "modes" field is
716 ** updated to contain the modes needed by the server to decode the
719 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
720 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
722 /* Copy map data with a stride into a packed buffer */
723 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
724 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
725 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
726 const GLfloat
*, GLfloat
*);
727 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
728 const GLdouble
*, GLdouble
*);
731 ** Empty an image out of the reply buffer into the clients memory applying
732 ** the pack modes to pack back into the clients requested format.
734 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
735 GLenum
, const GLubyte
*, GLvoid
*);
739 ** Allocate and Initialize Vertex Array client state, and free.
741 extern void __glXInitVertexArrayState(__GLXcontext
*);
742 extern void __glXFreeVertexArrayState(__GLXcontext
*);
745 ** Inform the Server of the major and minor numbers and of the client
746 ** libraries extension string.
748 extern void __glXClientInfo(Display
* dpy
, int opcode
);
750 /************************************************************************/
753 ** Declarations that should be in Xlib
755 #ifdef __GL_USE_OUR_PROTOTYPES
756 extern void _XFlush(Display
*);
757 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
758 extern void _XRead(Display
*, void *, long);
759 extern void _XSend(Display
*, const void *, long);
763 extern void __glXInitializeVisualConfigFromTags(__GLcontextModes
* config
,
764 int count
, const INT32
* bp
,
766 Bool fbconfig_style_tags
);
768 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
769 CARD32 screen
, CARD32 name
);
770 extern char *__glXGetString(Display
* dpy
, int opcode
,
771 CARD32 screen
, CARD32 name
);
773 extern char *__glXstrdup(const char *str
);
776 extern const char __glXGLClientVersion
[];
777 extern const char __glXGLClientExtensions
[];
779 /* Get the unadjusted system time */
780 extern int __glXGetUST(int64_t * ust
);
782 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
784 int32_t * denominator
);
786 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
788 __glxGetMscRate(__GLXDRIdrawable
*glxDraw
,
789 int32_t * numerator
, int32_t * denominator
);
791 /* So that dri2.c:DRI2WireToEvent() can access
792 * glx_info->codes->first_event */
793 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
795 extern __GLXDRIdrawable
*
796 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
, int *const scrn_num
);
800 #endif /* !__GLX_client_h__ */