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
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 extern void DRI_glXUseXFont(Font font
, int first
, int count
, int listbase
);
104 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
106 #include <GL/internal/dri_interface.h>
109 * Display dependent methods. This structure is initialized during the
110 * \c driCreateDisplay call.
112 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
113 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
114 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
115 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
117 #include "glxextensions.h"
119 struct __GLXDRIdisplayRec
122 * Method to destroy the private DRI display data.
124 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
126 __GLXDRIscreen
*(*createScreen
) (__GLXscreenConfigs
* psc
, int screen
,
127 __GLXdisplayPrivate
* priv
);
130 struct __GLXDRIscreenRec
{
132 void (*destroyScreen
)(__GLXscreenConfigs
*psc
);
134 __GLXDRIcontext
*(*createContext
)(__GLXscreenConfigs
*psc
,
135 const __GLcontextModes
*mode
,
137 GLXContext shareList
, int renderType
);
139 __GLXDRIdrawable
*(*createDrawable
)(__GLXscreenConfigs
*psc
,
141 GLXDrawable glxDrawable
,
142 const __GLcontextModes
*modes
);
144 int64_t (*swapBuffers
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
145 int64_t divisor
, int64_t remainder
);
146 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
147 int x
, int y
, int width
, int height
);
148 void (*waitX
)(__GLXDRIdrawable
*pdraw
);
149 void (*waitGL
)(__GLXDRIdrawable
*pdraw
);
150 int (*getDrawableMSC
)(__GLXscreenConfigs
*psc
, __GLXDRIdrawable
*pdraw
,
151 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
152 int (*waitForMSC
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
153 int64_t divisor
, int64_t remainder
, int64_t *ust
,
154 int64_t *msc
, int64_t *sbc
);
155 int (*waitForSBC
)(__GLXDRIdrawable
*pdraw
, int64_t target_sbc
, int64_t *ust
,
156 int64_t *msc
, int64_t *sbc
);
157 void (*setSwapInterval
)(__GLXDRIdrawable
*pdraw
, int interval
);
158 int (*getSwapInterval
)(__GLXDRIdrawable
*pdraw
);
161 struct __GLXDRIcontextRec
163 void (*destroyContext
) (__GLXDRIcontext
* context
,
164 __GLXscreenConfigs
* psc
, Display
* dpy
);
165 Bool(*bindContext
) (__GLXDRIcontext
* context
, __GLXDRIdrawable
* pdraw
,
166 __GLXDRIdrawable
* pread
);
168 void (*unbindContext
) (__GLXDRIcontext
* context
);
171 struct __GLXDRIdrawableRec
173 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
177 __GLXscreenConfigs
*psc
;
178 GLenum textureTarget
;
179 __DRIdrawable
*driDrawable
;
180 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
184 ** Function to create and DRI display data and initialize the display
185 ** dependent methods.
187 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
188 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
189 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
190 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
194 ** Functions to obtain driver configuration information from a direct
195 ** rendering client application
197 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
199 extern const char *glXGetDriverConfig(const char *driverName
);
203 /************************************************************************/
205 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
207 typedef struct __GLXpixelStoreModeRec
209 GLboolean swapEndian
;
218 } __GLXpixelStoreMode
;
221 typedef struct __GLXattributeRec
226 * Pixel storage state. Most of the pixel store mode state is kept
227 * here and used by the client code to manage the packing and
228 * unpacking of data sent to/received from the server.
230 __GLXpixelStoreMode storePack
, storeUnpack
;
233 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
236 GLboolean NoDrawArraysProtocol
;
239 * Vertex Array storage state. The vertex array component
240 * state is stored here and is used to manage the packing of
241 * DrawArrays data sent to the server.
243 struct array_state_vector
*array_state
;
246 typedef struct __GLXattributeMachineRec
248 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
249 __GLXattribute
**stackPointer
;
250 } __GLXattributeMachine
;
252 struct glx_context_vtable
{
253 void (*bind_tex_image
)(Display
* dpy
,
254 GLXDrawable drawable
,
255 int buffer
, const int *attrib_list
);
256 void (*release_tex_image
)(Display
* dpy
, GLXDrawable drawable
, int buffer
);
261 * GLX state that needs to be kept on the client. One of these records
262 * exist for each context that has been made current by this client.
264 struct __GLXcontextRec
267 * \name Drawing command buffer.
269 * Drawing commands are packed into this buffer before being sent as a
270 * single GLX protocol request. The buffer is sent when it overflows or
271 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
272 * in the buffer to be filled. \c limit is described above in the buffer
275 * Commands that require large amounts of data to be transfered will
276 * also use this buffer to hold a header that describes the large
279 * These must be the first 6 fields since they are static initialized
280 * in the dummy context in glxext.c
291 * The XID of this rendering context. When the context is created a
292 * new XID is allocated. This is set to None when the context is
293 * destroyed but is still current to some thread. In this case the
294 * context will be freed on next MakeCurrent.
299 * The XID of the \c shareList context.
307 __GLXscreenConfigs
*psc
;
310 * \c GL_TRUE if the context was created with ImportContext, which
311 * means the server-side context was created by another X client.
316 * The context tag returned by MakeCurrent when this context is made
317 * current. This tag is used to identify the context that a thread has
318 * current so that proper server context management can be done. It is
319 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
320 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
323 GLXContextTag currentContextTag
;
326 * \name Rendering mode
328 * The rendering mode is kept on the client as well as the server.
329 * When \c glRenderMode is called, the buffer associated with the
330 * previous rendering mode (feedback or select) is filled.
334 GLfloat
*feedbackBuf
;
339 * This is \c GL_TRUE if the pixel unpack modes are such that an image
340 * can be unpacked from the clients memory by just copying. It may
341 * still be true that the server will have to do some work. This
342 * just promises that a straight copy will fetch the correct bytes.
344 GLboolean fastImageUnpack
;
347 * Fill newImage with the unpacked form of \c oldImage getting it
348 * ready for transport to the server.
350 void (*fillImage
) (__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
351 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
354 * Client side attribs.
356 __GLXattributeMachine attributes
;
359 * Client side error code. This is set when client side gl API
360 * routines need to set an error because of a bad enumerant or
361 * running out of memory, etc.
366 * Whether this context does direct rendering.
371 * \c dpy of current display for this context. Will be \c NULL if not
372 * current to any display, or if this is the "dummy context".
377 * The current drawable for this context. Will be None if this
378 * context is not current to any drawable. currentReadable is below.
380 GLXDrawable currentDrawable
;
383 * \name GL Constant Strings
385 * Constant strings that describe the server implementation
386 * These pertain to GL attributes, not to be confused with
387 * GLX versioning attributes.
397 * Record the dpy this context was created on for later freeing
402 * Maximum small render command size. This is the smaller of 64k and
403 * the size of the above buffer.
405 GLint maxSmallRenderCommandSize
;
408 * Major opcode for the extension. Copied here so a lookup isn't
414 * Pointer to the mode used to create this context.
416 const __GLcontextModes
*mode
;
418 #ifdef GLX_DIRECT_RENDERING
419 #ifdef GLX_USE_APPLEGL
423 __GLXDRIcontext
*driContext
;
424 __DRIcontext
*__driContext
;
429 * The current read-drawable for this context. Will be None if this
430 * context is not current to any drawable.
432 * \since Internal API version 20030606.
434 GLXDrawable currentReadable
;
437 * Pointer to client-state data that is private to libGL. This is only
438 * used for indirect rendering contexts.
440 * No internal API version change was made for this change. Client-side
441 * drivers should NEVER use this data or even care that it exists.
443 void *client_state_private
;
446 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
451 * \name Raw server GL version
453 * True core GL version supported by the server. This is the raw value
454 * returned by the server, and it may not reflect what is actually
455 * supported (or reported) by the client-side library.
458 int server_major
; /**< Major version number. */
459 int server_minor
; /**< Minor version number. */
463 * Thread ID we're currently current in. Zero if none.
465 unsigned long thread_id
;
467 char gl_extension_bits
[__GL_EXT_BYTES
];
469 const struct glx_context_vtable
*vtable
;
472 #define __glXSetError(gc,code) \
473 if (!(gc)->error) { \
474 (gc)->error = code; \
477 extern void __glFreeAttributeState(__GLXcontext
*);
479 /************************************************************************/
482 * The size of the largest drawing command known to the implementation
483 * that will use the GLXRender GLX command. In this case it is
484 * \c glPolygonStipple.
486 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
489 * To keep the implementation fast, the code uses a "limit" pointer
490 * to determine when the drawing command buffer is too full to hold
491 * another fixed size command. This constant defines the amount of
492 * space that must always be available in the drawing command buffer
493 * at all times for the implementation to work. It is important that
494 * the number be just large enough, but not so large as to reduce the
495 * efficacy of the buffer. The "+32" is just to keep the code working
496 * in case somebody counts wrong.
498 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
501 * This implementation uses a smaller threshold for switching
502 * to the RenderLarge protocol than the protcol requires so that
503 * large copies don't occur.
505 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
508 * One of these records exists per screen of the display. It contains
509 * a pointer to the config data for that screen (if the screen supports GL).
511 struct __GLXscreenConfigsRec
514 * GLX extension string reported by the X-server.
516 const char *serverGLXexts
;
519 * GLX extension string to be reported to applications. This is the
520 * set of extensions that the application can actually use.
522 char *effectiveGLXexts
;
525 * Context vtable to use for direct contexts on this screen
527 const struct glx_context_vtable
*direct_context_vtable
;
529 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
531 * Per screen direct rendering interface functions and data.
533 __DRIscreen
*__driScreen
;
534 const __DRIcoreExtension
*core
;
535 const __DRIlegacyExtension
*legacy
;
536 const __DRIswrastExtension
*swrast
;
537 const __DRIdri2Extension
*dri2
;
538 __glxHashTable
*drawHash
;
543 __GLXDRIscreen
*driScreen
;
545 const __DRIconfig
**driver_configs
;
547 #ifdef __DRI_COPY_SUB_BUFFER
548 const __DRIcopySubBufferExtension
*driCopySubBuffer
;
551 #ifdef __DRI_SWAP_CONTROL
552 const __DRIswapControlExtension
*swapControl
;
555 #ifdef __DRI_ALLOCATE
556 const __DRIallocateExtension
*allocate
;
559 #ifdef __DRI_FRAME_TRACKING
560 const __DRIframeTrackingExtension
*frameTracking
;
563 #ifdef __DRI_MEDIA_STREAM_COUNTER
564 const __DRImediaStreamCounterExtension
*msc
;
567 #ifdef __DRI_TEX_BUFFER
568 const __DRItexBufferExtension
*texBuffer
;
572 const __DRI2flushExtension
*f
;
575 #ifdef __DRI2_CONFIG_QUERY
576 const __DRI2configQueryExtension
*config
;
582 * Linked list of glx visuals and fbconfigs for this screen.
584 __GLcontextModes
*visuals
, *configs
;
587 * Per-screen dynamic GLX extension tracking. The \c direct_support
588 * field only contains enough bits for 64 extensions. Should libGL
589 * ever need to track more than 64 GLX extensions, we can safely grow
590 * this field. The \c __GLXscreenConfigs structure is not used outside
594 unsigned char direct_support
[8];
595 GLboolean ext_list_first_time
;
601 * Per display private data. One of these records exists for each display
602 * that is using the OpenGL (GLX) extension.
604 struct __GLXdisplayPrivateRec
607 * Back pointer to the display
612 * The \c majorOpcode is common to all connections to the same server.
613 * It is also copied into the context structure.
618 * \name Server Version
620 * Major and minor version returned by the server during initialization.
623 int majorVersion
, minorVersion
;
627 * \name Storage for the servers GLX vendor and versions strings.
629 * These are the same for all screens on this display. These fields will
630 * be filled in on demand.
633 const char *serverGLXvendor
;
634 const char *serverGLXversion
;
638 * Configurations of visuals for all screens on this display.
639 * Also, per screen data which now includes the server \c GLX_EXTENSION
642 __GLXscreenConfigs
*screenConfigs
;
644 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
646 * Per display direct rendering interface functions and data.
648 __GLXDRIdisplay
*driswDisplay
;
649 __GLXDRIdisplay
*driDisplay
;
650 __GLXDRIdisplay
*dri2Display
;
655 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
657 extern void __glXSendLargeChunk(__GLXcontext
* gc
, GLint requestNumber
,
659 const GLvoid
* data
, GLint dataLen
);
661 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
662 const GLvoid
*, GLint
);
664 /* Initialize the GLX extension for dpy */
665 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
667 extern void __glXPreferEGL(int state
);
669 /************************************************************************/
671 extern int __glXDebug
;
673 /* This is per-thread storage in an MT environment */
674 #if defined( PTHREADS )
676 extern void __glXSetCurrentContext(__GLXcontext
* c
);
678 # if defined( GLX_USE_TLS )
680 extern __thread
void *__glX_tls_Context
681 __attribute__ ((tls_model("initial-exec")));
683 # define __glXGetCurrentContext() __glX_tls_Context
687 extern __GLXcontext
*__glXGetCurrentContext(void);
689 # endif /* defined( GLX_USE_TLS ) */
693 extern __GLXcontext
*__glXcurrentContext
;
694 #define __glXGetCurrentContext() __glXcurrentContext
695 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
697 #endif /* defined( PTHREADS ) */
699 extern void __glXSetCurrentContextNull(void);
701 extern void __glXFreeContext(__GLXcontext
*);
705 ** Global lock for all threads in this address space using the GLX
708 #if defined( PTHREADS )
709 extern pthread_mutex_t __glXmutex
;
710 #define __glXLock() pthread_mutex_lock(&__glXmutex)
711 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
714 #define __glXUnlock()
718 ** Setup for a command. Initialize the extension for dpy if necessary.
720 extern CARD8
__glXSetupForCommand(Display
* dpy
);
722 /************************************************************************/
725 ** Data conversion and packing support.
728 extern const GLuint __glXDefaultPixelStore
[9];
730 /* Send an image to the server using RenderLarge. */
731 extern void __glXSendLargeImage(__GLXcontext
* gc
, GLint compsize
, GLint dim
,
732 GLint width
, GLint height
, GLint depth
,
733 GLenum format
, GLenum type
,
734 const GLvoid
* src
, GLubyte
* pc
,
737 /* Return the size, in bytes, of some pixel data */
738 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
740 /* Return the number of elements per group of a specified format*/
741 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
743 /* Return the number of bytes per element, based on the element type (other
746 extern GLint
__glBytesPerElement(GLenum type
);
749 ** Fill the transport buffer with the data from the users buffer,
750 ** applying some of the pixel store modes (unpack modes) to the data
751 ** first. As a side effect of this call, the "modes" field is
752 ** updated to contain the modes needed by the server to decode the
755 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
756 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
758 /* Copy map data with a stride into a packed buffer */
759 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
760 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
761 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
762 const GLfloat
*, GLfloat
*);
763 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
764 const GLdouble
*, GLdouble
*);
767 ** Empty an image out of the reply buffer into the clients memory applying
768 ** the pack modes to pack back into the clients requested format.
770 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
771 GLenum
, const GLubyte
*, GLvoid
*);
775 ** Allocate and Initialize Vertex Array client state, and free.
777 extern void __glXInitVertexArrayState(__GLXcontext
*);
778 extern void __glXFreeVertexArrayState(__GLXcontext
*);
781 ** Inform the Server of the major and minor numbers and of the client
782 ** libraries extension string.
784 extern void __glXClientInfo(Display
* dpy
, int opcode
);
786 /************************************************************************/
789 ** Declarations that should be in Xlib
791 #ifdef __GL_USE_OUR_PROTOTYPES
792 extern void _XFlush(Display
*);
793 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
794 extern void _XRead(Display
*, void *, long);
795 extern void _XSend(Display
*, const void *, long);
799 extern void __glXInitializeVisualConfigFromTags(__GLcontextModes
* config
,
800 int count
, const INT32
* bp
,
802 Bool fbconfig_style_tags
);
804 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
805 CARD32 screen
, CARD32 name
);
806 extern char *__glXGetString(Display
* dpy
, int opcode
,
807 CARD32 screen
, CARD32 name
);
809 extern char *__glXstrdup(const char *str
);
812 extern const char __glXGLClientVersion
[];
813 extern const char __glXGLClientExtensions
[];
815 /* Get the unadjusted system time */
816 extern int __glXGetUST(int64_t * ust
);
818 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
820 int32_t * denominator
);
822 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
824 __driGetMscRateOML(__DRIdrawable
* draw
,
825 int32_t * numerator
, int32_t * denominator
, void *private);
827 /* So that dri2.c:DRI2WireToEvent() can access
828 * glx_info->codes->first_event */
829 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
831 extern __GLXDRIdrawable
*
832 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
, int *const scrn_num
);
836 #endif /* !__GLX_client_h__ */