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)
104 #include <GL/internal/dri_interface.h>
107 * Display dependent methods. This structure is initialized during the
108 * \c driCreateDisplay call.
110 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
111 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
112 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
113 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
115 #include "glxextensions.h"
117 struct __GLXDRIdisplayRec
120 * Method to destroy the private DRI display data.
122 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
124 __GLXDRIscreen
*(*createScreen
) (__GLXscreenConfigs
* psc
, int screen
,
125 __GLXdisplayPrivate
* priv
);
128 struct __GLXDRIscreenRec
{
130 void (*destroyScreen
)(__GLXscreenConfigs
*psc
);
132 __GLXDRIcontext
*(*createContext
)(__GLXscreenConfigs
*psc
,
133 const __GLcontextModes
*mode
,
135 GLXContext shareList
, int renderType
);
137 __GLXDRIdrawable
*(*createDrawable
)(__GLXscreenConfigs
*psc
,
139 GLXDrawable glxDrawable
,
140 const __GLcontextModes
*modes
);
142 int64_t (*swapBuffers
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
143 int64_t divisor
, int64_t remainder
);
144 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
145 int x
, int y
, int width
, int height
);
146 void (*waitX
)(__GLXDRIdrawable
*pdraw
);
147 void (*waitGL
)(__GLXDRIdrawable
*pdraw
);
148 int (*getDrawableMSC
)(__GLXscreenConfigs
*psc
, __GLXDRIdrawable
*pdraw
,
149 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
150 int (*waitForMSC
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
151 int64_t divisor
, int64_t remainder
, int64_t *ust
,
152 int64_t *msc
, int64_t *sbc
);
153 int (*waitForSBC
)(__GLXDRIdrawable
*pdraw
, int64_t target_sbc
, int64_t *ust
,
154 int64_t *msc
, int64_t *sbc
);
155 void (*setSwapInterval
)(__GLXDRIdrawable
*pdraw
, int interval
);
156 int (*getSwapInterval
)(__GLXDRIdrawable
*pdraw
);
159 struct __GLXDRIcontextRec
161 void (*destroyContext
) (__GLXDRIcontext
* context
,
162 __GLXscreenConfigs
* psc
, Display
* dpy
);
163 Bool(*bindContext
) (__GLXDRIcontext
* context
, __GLXDRIdrawable
* pdraw
,
164 __GLXDRIdrawable
* pread
);
166 void (*unbindContext
) (__GLXDRIcontext
* context
);
169 struct __GLXDRIdrawableRec
171 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
175 __GLXscreenConfigs
*psc
;
176 GLenum textureTarget
;
177 __DRIdrawable
*driDrawable
;
178 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
182 ** Function to create and DRI display data and initialize the display
183 ** dependent methods.
185 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
186 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
187 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
188 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
192 ** Functions to obtain driver configuration information from a direct
193 ** rendering client application
195 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
197 extern const char *glXGetDriverConfig(const char *driverName
);
201 /************************************************************************/
203 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
205 typedef struct __GLXpixelStoreModeRec
207 GLboolean swapEndian
;
216 } __GLXpixelStoreMode
;
219 typedef struct __GLXattributeRec
224 * Pixel storage state. Most of the pixel store mode state is kept
225 * here and used by the client code to manage the packing and
226 * unpacking of data sent to/received from the server.
228 __GLXpixelStoreMode storePack
, storeUnpack
;
231 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
234 GLboolean NoDrawArraysProtocol
;
237 * Vertex Array storage state. The vertex array component
238 * state is stored here and is used to manage the packing of
239 * DrawArrays data sent to the server.
241 struct array_state_vector
*array_state
;
244 typedef struct __GLXattributeMachineRec
246 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
247 __GLXattribute
**stackPointer
;
248 } __GLXattributeMachine
;
250 struct glx_context_vtable
{
251 void (*bind_tex_image
)(Display
* dpy
,
252 GLXDrawable drawable
,
253 int buffer
, const int *attrib_list
);
254 void (*release_tex_image
)(Display
* dpy
, GLXDrawable drawable
, int buffer
);
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.
262 struct __GLXcontextRec
265 * \name Drawing command buffer.
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
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
277 * These must be the first 6 fields since they are static initialized
278 * in the dummy context in glxext.c
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.
297 * The XID of the \c shareList context.
305 __GLXscreenConfigs
*psc
;
308 * \c GL_TRUE if the context was created with ImportContext, which
309 * means the server-side context was created by another X client.
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
321 GLXContextTag currentContextTag
;
324 * \name Rendering mode
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.
332 GLfloat
*feedbackBuf
;
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.
342 GLboolean fastImageUnpack
;
345 * Fill newImage with the unpacked form of \c oldImage getting it
346 * ready for transport to the server.
348 void (*fillImage
) (__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
349 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
352 * Client side attribs.
354 __GLXattributeMachine attributes
;
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.
364 * Whether this context does direct rendering.
369 * \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".
375 * The current drawable for this context. Will be None if this
376 * context is not current to any drawable. currentReadable is below.
378 GLXDrawable currentDrawable
;
381 * \name GL Constant Strings
383 * Constant strings that describe the server implementation
384 * These pertain to GL attributes, not to be confused with
385 * GLX versioning attributes.
395 * Record the dpy this context was created on for later freeing
400 * Maximum small render command size. This is the smaller of 64k and
401 * the size of the above buffer.
403 GLint maxSmallRenderCommandSize
;
406 * Major opcode for the extension. Copied here so a lookup isn't
412 * Pointer to the mode used to create this context.
414 const __GLcontextModes
*mode
;
416 #ifdef GLX_DIRECT_RENDERING
417 #ifdef GLX_USE_APPLEGL
421 __GLXDRIcontext
*driContext
;
422 __DRIcontext
*__driContext
;
427 * The current read-drawable for this context. Will be None if this
428 * context is not current to any drawable.
430 * \since Internal API version 20030606.
432 GLXDrawable currentReadable
;
435 * Pointer to client-state data that is private to libGL. This is only
436 * used for indirect rendering contexts.
438 * No internal API version change was made for this change. Client-side
439 * drivers should NEVER use this data or even care that it exists.
441 void *client_state_private
;
444 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
449 * \name Raw server GL version
451 * True core GL version supported by the server. This is the raw value
452 * returned by the server, and it may not reflect what is actually
453 * supported (or reported) by the client-side library.
456 int server_major
; /**< Major version number. */
457 int server_minor
; /**< Minor version number. */
461 * Thread ID we're currently current in. Zero if none.
463 unsigned long thread_id
;
465 char gl_extension_bits
[__GL_EXT_BYTES
];
467 const struct glx_context_vtable
*vtable
;
470 #define __glXSetError(gc,code) \
471 if (!(gc)->error) { \
472 (gc)->error = code; \
475 extern void __glFreeAttributeState(__GLXcontext
*);
477 /************************************************************************/
480 * The size of the largest drawing command known to the implementation
481 * that will use the GLXRender GLX command. In this case it is
482 * \c glPolygonStipple.
484 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
487 * To keep the implementation fast, the code uses a "limit" pointer
488 * to determine when the drawing command buffer is too full to hold
489 * another fixed size command. This constant defines the amount of
490 * space that must always be available in the drawing command buffer
491 * at all times for the implementation to work. It is important that
492 * the number be just large enough, but not so large as to reduce the
493 * efficacy of the buffer. The "+32" is just to keep the code working
494 * in case somebody counts wrong.
496 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
499 * This implementation uses a smaller threshold for switching
500 * to the RenderLarge protocol than the protcol requires so that
501 * large copies don't occur.
503 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
506 * One of these records exists per screen of the display. It contains
507 * a pointer to the config data for that screen (if the screen supports GL).
509 struct __GLXscreenConfigsRec
512 * GLX extension string reported by the X-server.
514 const char *serverGLXexts
;
517 * GLX extension string to be reported to applications. This is the
518 * set of extensions that the application can actually use.
520 char *effectiveGLXexts
;
523 * Context vtable to use for direct contexts on this screen
525 const struct glx_context_vtable
*direct_context_vtable
;
527 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
529 * Per screen direct rendering interface functions and data.
531 __DRIscreen
*__driScreen
;
532 const __DRIcoreExtension
*core
;
533 const __DRIlegacyExtension
*legacy
;
534 const __DRIswrastExtension
*swrast
;
535 const __DRIdri2Extension
*dri2
;
536 __glxHashTable
*drawHash
;
541 __GLXDRIscreen
*driScreen
;
543 const __DRIconfig
**driver_configs
;
545 #ifdef __DRI_COPY_SUB_BUFFER
546 const __DRIcopySubBufferExtension
*driCopySubBuffer
;
549 #ifdef __DRI_SWAP_CONTROL
550 const __DRIswapControlExtension
*swapControl
;
553 #ifdef __DRI_ALLOCATE
554 const __DRIallocateExtension
*allocate
;
557 #ifdef __DRI_FRAME_TRACKING
558 const __DRIframeTrackingExtension
*frameTracking
;
561 #ifdef __DRI_MEDIA_STREAM_COUNTER
562 const __DRImediaStreamCounterExtension
*msc
;
565 #ifdef __DRI_TEX_BUFFER
566 const __DRItexBufferExtension
*texBuffer
;
570 const __DRI2flushExtension
*f
;
573 #ifdef __DRI2_CONFIG_QUERY
574 const __DRI2configQueryExtension
*config
;
580 * Linked list of glx visuals and fbconfigs for this screen.
582 __GLcontextModes
*visuals
, *configs
;
585 * Per-screen dynamic GLX extension tracking. The \c direct_support
586 * field only contains enough bits for 64 extensions. Should libGL
587 * ever need to track more than 64 GLX extensions, we can safely grow
588 * this field. The \c __GLXscreenConfigs structure is not used outside
592 unsigned char direct_support
[8];
593 GLboolean ext_list_first_time
;
599 * Per display private data. One of these records exists for each display
600 * that is using the OpenGL (GLX) extension.
602 struct __GLXdisplayPrivateRec
605 * Back pointer to the display
610 * The \c majorOpcode is common to all connections to the same server.
611 * It is also copied into the context structure.
616 * \name Server Version
618 * Major and minor version returned by the server during initialization.
621 int majorVersion
, minorVersion
;
625 * \name Storage for the servers GLX vendor and versions strings.
627 * These are the same for all screens on this display. These fields will
628 * be filled in on demand.
631 const char *serverGLXvendor
;
632 const char *serverGLXversion
;
636 * Configurations of visuals for all screens on this display.
637 * Also, per screen data which now includes the server \c GLX_EXTENSION
640 __GLXscreenConfigs
*screenConfigs
;
642 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
644 * Per display direct rendering interface functions and data.
646 __GLXDRIdisplay
*driswDisplay
;
647 __GLXDRIdisplay
*driDisplay
;
648 __GLXDRIdisplay
*dri2Display
;
653 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
655 extern void __glXSendLargeChunk(__GLXcontext
* gc
, GLint requestNumber
,
657 const GLvoid
* data
, GLint dataLen
);
659 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
660 const GLvoid
*, GLint
);
662 /* Initialize the GLX extension for dpy */
663 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
665 extern void __glXPreferEGL(int state
);
667 /************************************************************************/
669 extern int __glXDebug
;
671 /* This is per-thread storage in an MT environment */
672 #if defined( PTHREADS )
674 extern void __glXSetCurrentContext(__GLXcontext
* c
);
676 # if defined( GLX_USE_TLS )
678 extern __thread
void *__glX_tls_Context
679 __attribute__ ((tls_model("initial-exec")));
681 # define __glXGetCurrentContext() __glX_tls_Context
685 extern __GLXcontext
*__glXGetCurrentContext(void);
687 # endif /* defined( GLX_USE_TLS ) */
691 extern __GLXcontext
*__glXcurrentContext
;
692 #define __glXGetCurrentContext() __glXcurrentContext
693 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
695 #endif /* defined( PTHREADS ) */
697 extern void __glXSetCurrentContextNull(void);
699 extern void __glXFreeContext(__GLXcontext
*);
703 ** Global lock for all threads in this address space using the GLX
706 #if defined( PTHREADS )
707 extern pthread_mutex_t __glXmutex
;
708 #define __glXLock() pthread_mutex_lock(&__glXmutex)
709 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
712 #define __glXUnlock()
716 ** Setup for a command. Initialize the extension for dpy if necessary.
718 extern CARD8
__glXSetupForCommand(Display
* dpy
);
720 /************************************************************************/
723 ** Data conversion and packing support.
726 extern const GLuint __glXDefaultPixelStore
[9];
728 /* Send an image to the server using RenderLarge. */
729 extern void __glXSendLargeImage(__GLXcontext
* gc
, GLint compsize
, GLint dim
,
730 GLint width
, GLint height
, GLint depth
,
731 GLenum format
, GLenum type
,
732 const GLvoid
* src
, GLubyte
* pc
,
735 /* Return the size, in bytes, of some pixel data */
736 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
738 /* Return the number of elements per group of a specified format*/
739 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
741 /* Return the number of bytes per element, based on the element type (other
744 extern GLint
__glBytesPerElement(GLenum type
);
747 ** Fill the transport buffer with the data from the users buffer,
748 ** applying some of the pixel store modes (unpack modes) to the data
749 ** first. As a side effect of this call, the "modes" field is
750 ** updated to contain the modes needed by the server to decode the
753 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
754 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
756 /* Copy map data with a stride into a packed buffer */
757 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
758 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
759 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
760 const GLfloat
*, GLfloat
*);
761 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
762 const GLdouble
*, GLdouble
*);
765 ** Empty an image out of the reply buffer into the clients memory applying
766 ** the pack modes to pack back into the clients requested format.
768 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
769 GLenum
, const GLubyte
*, GLvoid
*);
773 ** Allocate and Initialize Vertex Array client state, and free.
775 extern void __glXInitVertexArrayState(__GLXcontext
*);
776 extern void __glXFreeVertexArrayState(__GLXcontext
*);
779 ** Inform the Server of the major and minor numbers and of the client
780 ** libraries extension string.
782 extern void __glXClientInfo(Display
* dpy
, int opcode
);
784 /************************************************************************/
787 ** Declarations that should be in Xlib
789 #ifdef __GL_USE_OUR_PROTOTYPES
790 extern void _XFlush(Display
*);
791 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
792 extern void _XRead(Display
*, void *, long);
793 extern void _XSend(Display
*, const void *, long);
797 extern void __glXInitializeVisualConfigFromTags(__GLcontextModes
* config
,
798 int count
, const INT32
* bp
,
800 Bool fbconfig_style_tags
);
802 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
803 CARD32 screen
, CARD32 name
);
804 extern char *__glXGetString(Display
* dpy
, int opcode
,
805 CARD32 screen
, CARD32 name
);
807 extern char *__glXstrdup(const char *str
);
810 extern const char __glXGLClientVersion
[];
811 extern const char __glXGLClientExtensions
[];
813 /* Get the unadjusted system time */
814 extern int __glXGetUST(int64_t * ust
);
816 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
818 int32_t * denominator
);
820 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
822 __driGetMscRateOML(__DRIdrawable
* draw
,
823 int32_t * numerator
, int32_t * denominator
, void *private);
825 /* So that dri2.c:DRI2WireToEvent() can access
826 * glx_info->codes->first_event */
827 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
829 extern __GLXDRIdrawable
*
830 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
, int *const scrn_num
);
834 #endif /* !__GLX_client_h__ */