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 #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
);
185 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
188 extern void DRI_glXUseXFont(Font font
, int first
, int count
, int listbase
);
191 ** Functions to obtain driver configuration information from a direct
192 ** rendering client application
194 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
196 extern const char *glXGetDriverConfig(const char *driverName
);
200 /************************************************************************/
202 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
204 typedef struct __GLXpixelStoreModeRec
206 GLboolean swapEndian
;
215 } __GLXpixelStoreMode
;
218 typedef struct __GLXattributeRec
223 * Pixel storage state. Most of the pixel store mode state is kept
224 * here and used by the client code to manage the packing and
225 * unpacking of data sent to/received from the server.
227 __GLXpixelStoreMode storePack
, storeUnpack
;
230 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
233 GLboolean NoDrawArraysProtocol
;
236 * Vertex Array storage state. The vertex array component
237 * state is stored here and is used to manage the packing of
238 * DrawArrays data sent to the server.
240 struct array_state_vector
*array_state
;
243 typedef struct __GLXattributeMachineRec
245 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
246 __GLXattribute
**stackPointer
;
247 } __GLXattributeMachine
;
250 * GLX state that needs to be kept on the client. One of these records
251 * exist for each context that has been made current by this client.
253 struct __GLXcontextRec
256 * \name Drawing command buffer.
258 * Drawing commands are packed into this buffer before being sent as a
259 * single GLX protocol request. The buffer is sent when it overflows or
260 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
261 * in the buffer to be filled. \c limit is described above in the buffer
264 * Commands that require large amounts of data to be transfered will
265 * also use this buffer to hold a header that describes the large
268 * These must be the first 6 fields since they are static initialized
269 * in the dummy context in glxext.c
280 * The XID of this rendering context. When the context is created a
281 * new XID is allocated. This is set to None when the context is
282 * destroyed but is still current to some thread. In this case the
283 * context will be freed on next MakeCurrent.
288 * The XID of the \c shareList context.
296 __GLXscreenConfigs
*psc
;
299 * \c GL_TRUE if the context was created with ImportContext, which
300 * means the server-side context was created by another X client.
305 * The context tag returned by MakeCurrent when this context is made
306 * current. This tag is used to identify the context that a thread has
307 * current so that proper server context management can be done. It is
308 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
309 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
312 GLXContextTag currentContextTag
;
315 * \name Rendering mode
317 * The rendering mode is kept on the client as well as the server.
318 * When \c glRenderMode is called, the buffer associated with the
319 * previous rendering mode (feedback or select) is filled.
323 GLfloat
*feedbackBuf
;
328 * This is \c GL_TRUE if the pixel unpack modes are such that an image
329 * can be unpacked from the clients memory by just copying. It may
330 * still be true that the server will have to do some work. This
331 * just promises that a straight copy will fetch the correct bytes.
333 GLboolean fastImageUnpack
;
336 * Fill newImage with the unpacked form of \c oldImage getting it
337 * ready for transport to the server.
339 void (*fillImage
) (__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
340 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
343 * Client side attribs.
345 __GLXattributeMachine attributes
;
348 * Client side error code. This is set when client side gl API
349 * routines need to set an error because of a bad enumerant or
350 * running out of memory, etc.
355 * Whether this context does direct rendering.
360 * \c dpy of current display for this context. Will be \c NULL if not
361 * current to any display, or if this is the "dummy context".
366 * The current drawable for this context. Will be None if this
367 * context is not current to any drawable. currentReadable is below.
369 GLXDrawable currentDrawable
;
372 * \name GL Constant Strings
374 * Constant strings that describe the server implementation
375 * These pertain to GL attributes, not to be confused with
376 * GLX versioning attributes.
386 * Record the dpy this context was created on for later freeing
391 * Maximum small render command size. This is the smaller of 64k and
392 * the size of the above buffer.
394 GLint maxSmallRenderCommandSize
;
397 * Major opcode for the extension. Copied here so a lookup isn't
403 * Pointer to the mode used to create this context.
405 const __GLcontextModes
*mode
;
407 #ifdef GLX_DIRECT_RENDERING
408 __GLXDRIcontext
*driContext
;
409 __DRIcontext
*__driContext
;
413 * The current read-drawable for this context. Will be None if this
414 * context is not current to any drawable.
416 * \since Internal API version 20030606.
418 GLXDrawable currentReadable
;
421 * Pointer to client-state data that is private to libGL. This is only
422 * used for indirect rendering contexts.
424 * No internal API version change was made for this change. Client-side
425 * drivers should NEVER use this data or even care that it exists.
427 void *client_state_private
;
430 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
435 * \name Raw server GL version
437 * True core GL version supported by the server. This is the raw value
438 * returned by the server, and it may not reflect what is actually
439 * supported (or reported) by the client-side library.
442 int server_major
; /**< Major version number. */
443 int server_minor
; /**< Minor version number. */
447 * Thread ID we're currently current in. Zero if none.
449 unsigned long thread_id
;
451 char gl_extension_bits
[__GL_EXT_BYTES
];
454 #define __glXSetError(gc,code) \
455 if (!(gc)->error) { \
456 (gc)->error = code; \
459 extern void __glFreeAttributeState(__GLXcontext
*);
461 /************************************************************************/
464 * The size of the largest drawing command known to the implementation
465 * that will use the GLXRender GLX command. In this case it is
466 * \c glPolygonStipple.
468 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
471 * To keep the implementation fast, the code uses a "limit" pointer
472 * to determine when the drawing command buffer is too full to hold
473 * another fixed size command. This constant defines the amount of
474 * space that must always be available in the drawing command buffer
475 * at all times for the implementation to work. It is important that
476 * the number be just large enough, but not so large as to reduce the
477 * efficacy of the buffer. The "+32" is just to keep the code working
478 * in case somebody counts wrong.
480 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
483 * This implementation uses a smaller threshold for switching
484 * to the RenderLarge protocol than the protcol requires so that
485 * large copies don't occur.
487 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
490 * One of these records exists per screen of the display. It contains
491 * a pointer to the config data for that screen (if the screen supports GL).
493 struct __GLXscreenConfigsRec
496 * GLX extension string reported by the X-server.
498 const char *serverGLXexts
;
501 * GLX extension string to be reported to applications. This is the
502 * set of extensions that the application can actually use.
504 char *effectiveGLXexts
;
506 #ifdef GLX_DIRECT_RENDERING
508 * Per screen direct rendering interface functions and data.
510 __DRIscreen
*__driScreen
;
511 const __DRIcoreExtension
*core
;
512 const __DRIlegacyExtension
*legacy
;
513 const __DRIswrastExtension
*swrast
;
514 const __DRIdri2Extension
*dri2
;
515 __glxHashTable
*drawHash
;
520 __GLXDRIscreen
*driScreen
;
522 const __DRIconfig
**driver_configs
;
524 #ifdef __DRI_COPY_SUB_BUFFER
525 const __DRIcopySubBufferExtension
*driCopySubBuffer
;
528 #ifdef __DRI_SWAP_CONTROL
529 const __DRIswapControlExtension
*swapControl
;
532 #ifdef __DRI_ALLOCATE
533 const __DRIallocateExtension
*allocate
;
536 #ifdef __DRI_FRAME_TRACKING
537 const __DRIframeTrackingExtension
*frameTracking
;
540 #ifdef __DRI_MEDIA_STREAM_COUNTER
541 const __DRImediaStreamCounterExtension
*msc
;
544 #ifdef __DRI_TEX_BUFFER
545 const __DRItexBufferExtension
*texBuffer
;
549 const __DRI2flushExtension
*f
;
555 * Linked list of glx visuals and fbconfigs for this screen.
557 __GLcontextModes
*visuals
, *configs
;
560 * Per-screen dynamic GLX extension tracking. The \c direct_support
561 * field only contains enough bits for 64 extensions. Should libGL
562 * ever need to track more than 64 GLX extensions, we can safely grow
563 * this field. The \c __GLXscreenConfigs structure is not used outside
567 unsigned char direct_support
[8];
568 GLboolean ext_list_first_time
;
574 * Per display private data. One of these records exists for each display
575 * that is using the OpenGL (GLX) extension.
577 struct __GLXdisplayPrivateRec
580 * Back pointer to the display
585 * The \c majorOpcode is common to all connections to the same server.
586 * It is also copied into the context structure.
591 * \name Server Version
593 * Major and minor version returned by the server during initialization.
596 int majorVersion
, minorVersion
;
600 * \name Storage for the servers GLX vendor and versions strings.
602 * These are the same for all screens on this display. These fields will
603 * be filled in on demand.
606 const char *serverGLXvendor
;
607 const char *serverGLXversion
;
611 * Configurations of visuals for all screens on this display.
612 * Also, per screen data which now includes the server \c GLX_EXTENSION
615 __GLXscreenConfigs
*screenConfigs
;
617 #ifdef GLX_DIRECT_RENDERING
619 * Per display direct rendering interface functions and data.
621 __GLXDRIdisplay
*driswDisplay
;
622 __GLXDRIdisplay
*driDisplay
;
623 __GLXDRIdisplay
*dri2Display
;
628 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
630 extern void __glXSendLargeChunk(__GLXcontext
* gc
, GLint requestNumber
,
632 const GLvoid
* data
, GLint dataLen
);
634 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
635 const GLvoid
*, GLint
);
637 /* Initialize the GLX extension for dpy */
638 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
640 extern void __glXPreferEGL(int state
);
642 /************************************************************************/
644 extern int __glXDebug
;
646 /* This is per-thread storage in an MT environment */
647 #if defined( PTHREADS )
649 extern void __glXSetCurrentContext(__GLXcontext
* c
);
651 # if defined( GLX_USE_TLS )
653 extern __thread
void *__glX_tls_Context
654 __attribute__ ((tls_model("initial-exec")));
656 # define __glXGetCurrentContext() __glX_tls_Context
660 extern __GLXcontext
*__glXGetCurrentContext(void);
662 # endif /* defined( GLX_USE_TLS ) */
666 extern __GLXcontext
*__glXcurrentContext
;
667 #define __glXGetCurrentContext() __glXcurrentContext
668 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
670 #endif /* defined( PTHREADS ) */
672 extern void __glXSetCurrentContextNull(void);
674 extern void __glXFreeContext(__GLXcontext
*);
678 ** Global lock for all threads in this address space using the GLX
681 #if defined( PTHREADS )
682 extern pthread_mutex_t __glXmutex
;
683 #define __glXLock() pthread_mutex_lock(&__glXmutex)
684 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
687 #define __glXUnlock()
691 ** Setup for a command. Initialize the extension for dpy if necessary.
693 extern CARD8
__glXSetupForCommand(Display
* dpy
);
695 /************************************************************************/
698 ** Data conversion and packing support.
701 extern const GLuint __glXDefaultPixelStore
[9];
703 /* Send an image to the server using RenderLarge. */
704 extern void __glXSendLargeImage(__GLXcontext
* gc
, GLint compsize
, GLint dim
,
705 GLint width
, GLint height
, GLint depth
,
706 GLenum format
, GLenum type
,
707 const GLvoid
* src
, GLubyte
* pc
,
710 /* Return the size, in bytes, of some pixel data */
711 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
713 /* Return the number of elements per group of a specified format*/
714 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
716 /* Return the number of bytes per element, based on the element type (other
719 extern GLint
__glBytesPerElement(GLenum type
);
722 ** Fill the transport buffer with the data from the users buffer,
723 ** applying some of the pixel store modes (unpack modes) to the data
724 ** first. As a side effect of this call, the "modes" field is
725 ** updated to contain the modes needed by the server to decode the
728 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
729 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
731 /* Copy map data with a stride into a packed buffer */
732 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
733 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
734 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
735 const GLfloat
*, GLfloat
*);
736 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
737 const GLdouble
*, GLdouble
*);
740 ** Empty an image out of the reply buffer into the clients memory applying
741 ** the pack modes to pack back into the clients requested format.
743 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
744 GLenum
, const GLubyte
*, GLvoid
*);
748 ** Allocate and Initialize Vertex Array client state, and free.
750 extern void __glXInitVertexArrayState(__GLXcontext
*);
751 extern void __glXFreeVertexArrayState(__GLXcontext
*);
754 ** Inform the Server of the major and minor numbers and of the client
755 ** libraries extension string.
757 extern void __glXClientInfo(Display
* dpy
, int opcode
);
759 /************************************************************************/
762 ** Declarations that should be in Xlib
764 #ifdef __GL_USE_OUR_PROTOTYPES
765 extern void _XFlush(Display
*);
766 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
767 extern void _XRead(Display
*, void *, long);
768 extern void _XSend(Display
*, const void *, long);
772 extern void __glXInitializeVisualConfigFromTags(__GLcontextModes
* config
,
773 int count
, const INT32
* bp
,
775 Bool fbconfig_style_tags
);
777 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
778 CARD32 screen
, CARD32 name
);
779 extern char *__glXGetString(Display
* dpy
, int opcode
,
780 CARD32 screen
, CARD32 name
);
782 extern char *__glXstrdup(const char *str
);
785 extern const char __glXGLClientVersion
[];
786 extern const char __glXGLClientExtensions
[];
788 /* Get the unadjusted system time */
789 extern int __glXGetUST(int64_t * ust
);
791 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
793 int32_t * denominator
);
795 #ifdef GLX_DIRECT_RENDERING
797 __driGetMscRateOML(__DRIdrawable
* draw
,
798 int32_t * numerator
, int32_t * denominator
, void *private);
800 /* So that dri2.c:DRI2WireToEvent() can access
801 * glx_info->codes->first_event */
802 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
804 extern __GLXDRIdrawable
*
805 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
, int *const scrn_num
);
809 #endif /* !__GLX_client_h__ */