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/Xfuncproto.h>
43 #include <X11/extensions/extutil.h>
44 #define GLX_GLXEXT_PROTOTYPES
46 #include <GL/glxext.h>
53 #include "GL/glxproto.h"
54 #include "glxconfig.h"
56 #if defined( HAVE_PTHREAD )
60 #include "glxextensions.h"
62 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
64 #define GLX_MAJOR_VERSION 1 /* current version numbers */
65 #define GLX_MINOR_VERSION 4
67 #define __GLX_MAX_TEXTURE_UNITS 32
72 /************************************************************************/
74 #ifdef GLX_DIRECT_RENDERING
76 extern void DRI_glXUseXFont(struct glx_context
*ctx
,
77 Font font
, int first
, int count
, int listbase
);
81 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
84 * Display dependent methods. This structure is initialized during the
85 * \c driCreateDisplay call.
87 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
88 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
89 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
91 struct __GLXDRIdisplayRec
94 * Method to destroy the private DRI display data.
96 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
98 struct glx_screen
*(*createScreen
)(int screen
, struct glx_display
* priv
);
101 struct __GLXDRIscreenRec
{
103 void (*destroyScreen
)(struct glx_screen
*psc
);
105 struct glx_context
*(*createContext
)(struct glx_screen
*psc
,
106 struct glx_config
*config
,
107 struct glx_context
*shareList
,
110 __GLXDRIdrawable
*(*createDrawable
)(struct glx_screen
*psc
,
112 GLXDrawable glxDrawable
,
113 struct glx_config
*config
);
115 int64_t (*swapBuffers
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
116 int64_t divisor
, int64_t remainder
, Bool flush
);
117 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
118 int x
, int y
, int width
, int height
, Bool flush
);
119 int (*getDrawableMSC
)(struct glx_screen
*psc
, __GLXDRIdrawable
*pdraw
,
120 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
121 int (*waitForMSC
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
122 int64_t divisor
, int64_t remainder
, int64_t *ust
,
123 int64_t *msc
, int64_t *sbc
);
124 int (*waitForSBC
)(__GLXDRIdrawable
*pdraw
, int64_t target_sbc
, int64_t *ust
,
125 int64_t *msc
, int64_t *sbc
);
126 int (*setSwapInterval
)(__GLXDRIdrawable
*pdraw
, int interval
);
127 int (*getSwapInterval
)(__GLXDRIdrawable
*pdraw
);
130 struct __GLXDRIdrawableRec
132 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
136 struct glx_screen
*psc
;
137 GLenum textureTarget
;
138 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
139 unsigned long eventMask
;
144 ** Function to create and DRI display data and initialize the display
145 ** dependent methods.
147 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
148 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
149 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
150 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
151 extern unsigned dri2GetSwapEventType(Display
*dpy
, XID drawable
);
153 extern __GLXDRIdisplay
*dri3_create_display(Display
* dpy
);
156 ** Functions to obtain driver configuration information from a direct
157 ** rendering client application
159 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
161 extern const char *glXGetDriverConfig(const char *driverName
);
165 /************************************************************************/
167 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
169 typedef struct __GLXpixelStoreModeRec
171 GLboolean swapEndian
;
180 } __GLXpixelStoreMode
;
183 typedef struct __GLXattributeRec
188 * Pixel storage state. Most of the pixel store mode state is kept
189 * here and used by the client code to manage the packing and
190 * unpacking of data sent to/received from the server.
192 __GLXpixelStoreMode storePack
, storeUnpack
;
195 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
198 GLboolean NoDrawArraysProtocol
;
201 * Vertex Array storage state. The vertex array component
202 * state is stored here and is used to manage the packing of
203 * DrawArrays data sent to the server.
205 struct array_state_vector
*array_state
;
208 typedef struct __GLXattributeMachineRec
210 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
211 __GLXattribute
**stackPointer
;
212 } __GLXattributeMachine
;
214 struct glx_context_vtable
{
215 void (*destroy
)(struct glx_context
*ctx
);
216 int (*bind
)(struct glx_context
*context
, struct glx_context
*old
,
217 GLXDrawable draw
, GLXDrawable read
);
218 void (*unbind
)(struct glx_context
*context
, struct glx_context
*new_ctx
);
219 void (*wait_gl
)(struct glx_context
*ctx
);
220 void (*wait_x
)(struct glx_context
*ctx
);
221 void (*use_x_font
)(struct glx_context
*ctx
,
222 Font font
, int first
, int count
, int listBase
);
223 void (*bind_tex_image
)(Display
* dpy
,
224 GLXDrawable drawable
,
225 int buffer
, const int *attrib_list
);
226 void (*release_tex_image
)(Display
* dpy
, GLXDrawable drawable
, int buffer
);
227 void * (*get_proc_address
)(const char *symbol
);
231 * GLX state that needs to be kept on the client. One of these records
232 * exist for each context that has been made current by this client.
237 * \name Drawing command buffer.
239 * Drawing commands are packed into this buffer before being sent as a
240 * single GLX protocol request. The buffer is sent when it overflows or
241 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
242 * in the buffer to be filled. \c limit is described above in the buffer
245 * Commands that require large amounts of data to be transfered will
246 * also use this buffer to hold a header that describes the large
249 * These must be the first 6 fields since they are static initialized
250 * in the dummy context in glxext.c
260 const struct glx_context_vtable
*vtable
;
263 * The XID of this rendering context. When the context is created a
264 * new XID is allocated. This is set to None when the context is
265 * destroyed but is still current to some thread. In this case the
266 * context will be freed on next MakeCurrent.
271 * The XID of the \c shareList context.
279 struct glx_screen
*psc
;
282 * \c GL_TRUE if the context was created with ImportContext, which
283 * means the server-side context was created by another X client.
288 * The context tag returned by MakeCurrent when this context is made
289 * current. This tag is used to identify the context that a thread has
290 * current so that proper server context management can be done. It is
291 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
292 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
295 GLXContextTag currentContextTag
;
298 * \name Rendering mode
300 * The rendering mode is kept on the client as well as the server.
301 * When \c glRenderMode is called, the buffer associated with the
302 * previous rendering mode (feedback or select) is filled.
306 GLfloat
*feedbackBuf
;
311 * Fill newImage with the unpacked form of \c oldImage getting it
312 * ready for transport to the server.
314 void (*fillImage
) (struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
315 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
318 * Client side attribs.
320 __GLXattributeMachine attributes
;
323 * Client side error code. This is set when client side gl API
324 * routines need to set an error because of a bad enumerant or
325 * running out of memory, etc.
330 * Whether this context does direct rendering.
334 #if defined(GLX_DIRECT_RENDERING) && defined(GLX_USE_APPLEGL)
339 * \c dpy of current display for this context. Will be \c NULL if not
340 * current to any display, or if this is the "dummy context".
345 * The current drawable for this context. Will be None if this
346 * context is not current to any drawable. currentReadable is below.
348 GLXDrawable currentDrawable
;
351 * \name GL Constant Strings
353 * Constant strings that describe the server implementation
354 * These pertain to GL attributes, not to be confused with
355 * GLX versioning attributes.
365 * Maximum small render command size. This is the smaller of 64k and
366 * the size of the above buffer.
368 GLint maxSmallRenderCommandSize
;
371 * Major opcode for the extension. Copied here so a lookup isn't
377 * Pointer to the config used to create this context.
379 struct glx_config
*config
;
382 * The current read-drawable for this context. Will be None if this
383 * context is not current to any drawable.
385 * \since Internal API version 20030606.
387 GLXDrawable currentReadable
;
390 * Pointer to client-state data that is private to libGL. This is only
391 * used for indirect rendering contexts.
393 * No internal API version change was made for this change. Client-side
394 * drivers should NEVER use this data or even care that it exists.
396 void *client_state_private
;
399 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
404 * \name Raw server GL version
406 * True core GL version supported by the server. This is the raw value
407 * returned by the server, and it may not reflect what is actually
408 * supported (or reported) by the client-side library.
411 int server_major
; /**< Major version number. */
412 int server_minor
; /**< Minor version number. */
416 * Number of threads we're currently current in.
418 unsigned long thread_refcount
;
420 char gl_extension_bits
[__GL_EXT_BYTES
];
424 glx_context_init(struct glx_context
*gc
,
425 struct glx_screen
*psc
, struct glx_config
*fbconfig
);
427 #define __glXSetError(gc,code) \
428 if (!(gc)->error) { \
429 (gc)->error = code; \
432 extern void __glFreeAttributeState(struct glx_context
*);
434 /************************************************************************/
437 * The size of the largest drawing command known to the implementation
438 * that will use the GLXRender GLX command. In this case it is
439 * \c glPolygonStipple.
441 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
444 * To keep the implementation fast, the code uses a "limit" pointer
445 * to determine when the drawing command buffer is too full to hold
446 * another fixed size command. This constant defines the amount of
447 * space that must always be available in the drawing command buffer
448 * at all times for the implementation to work. It is important that
449 * the number be just large enough, but not so large as to reduce the
450 * efficacy of the buffer. The "+32" is just to keep the code working
451 * in case somebody counts wrong.
453 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
456 * This implementation uses a smaller threshold for switching
457 * to the RenderLarge protocol than the protcol requires so that
458 * large copies don't occur.
460 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
463 * One of these records exists per screen of the display. It contains
464 * a pointer to the config data for that screen (if the screen supports GL).
466 struct glx_screen_vtable
{
467 struct glx_context
*(*create_context
)(struct glx_screen
*psc
,
468 struct glx_config
*config
,
469 struct glx_context
*shareList
,
472 struct glx_context
*(*create_context_attribs
)(struct glx_screen
*psc
,
473 struct glx_config
*config
,
474 struct glx_context
*shareList
,
476 const uint32_t *attribs
,
478 int (*query_renderer_integer
)(struct glx_screen
*psc
,
481 int (*query_renderer_string
)(struct glx_screen
*psc
,
488 const struct glx_screen_vtable
*vtable
;
491 * GLX extension string reported by the X-server.
493 const char *serverGLXexts
;
496 * GLX extension string to be reported to applications. This is the
497 * set of extensions that the application can actually use.
499 char *effectiveGLXexts
;
501 struct glx_display
*display
;
506 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
508 * Per screen direct rendering interface functions and data.
510 __GLXDRIscreen
*driScreen
;
514 * Linked list of glx visuals and fbconfigs for this screen.
516 struct glx_config
*visuals
, *configs
;
519 * Per-screen dynamic GLX extension tracking. The \c direct_support
520 * field only contains enough bits for 64 extensions. Should libGL
521 * ever need to track more than 64 GLX extensions, we can safely grow
522 * this field. The \c struct glx_screen structure is not used outside
526 unsigned char direct_support
[8];
527 GLboolean ext_list_first_time
;
533 * Per display private data. One of these records exists for each display
534 * that is using the OpenGL (GLX) extension.
538 /* The extension protocol codes */
540 struct glx_display
*next
;
543 * Back pointer to the display
548 * The \c majorOpcode is common to all connections to the same server.
549 * It is also copied into the context structure.
554 * \name Server Version
556 * Major and minor version returned by the server during initialization.
559 int majorVersion
, minorVersion
;
563 * \name Storage for the servers GLX vendor and versions strings.
565 * These are the same for all screens on this display. These fields will
566 * be filled in on demand.
569 const char *serverGLXvendor
;
570 const char *serverGLXversion
;
574 * Configurations of visuals for all screens on this display.
575 * Also, per screen data which now includes the server \c GLX_EXTENSION
578 struct glx_screen
**screens
;
580 __glxHashTable
*glXDrawHash
;
582 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
583 __glxHashTable
*drawHash
;
586 * Per display direct rendering interface functions and data.
588 __GLXDRIdisplay
*driswDisplay
;
589 __GLXDRIdisplay
*driDisplay
;
590 __GLXDRIdisplay
*dri2Display
;
591 __GLXDRIdisplay
*dri3Display
;
595 struct glx_drawable
{
599 uint32_t lastEventSbc
;
600 int64_t eventSbcWrap
;
604 glx_screen_init(struct glx_screen
*psc
,
605 int screen
, struct glx_display
* priv
);
607 glx_screen_cleanup(struct glx_screen
*psc
);
609 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
610 extern __GLXDRIdrawable
*
611 dri2GetGlxDrawableFromXDrawableId(Display
*dpy
, XID id
);
614 extern GLubyte
*__glXFlushRenderBuffer(struct glx_context
*, GLubyte
*);
616 extern void __glXSendLargeChunk(struct glx_context
* gc
, GLint requestNumber
,
618 const GLvoid
* data
, GLint dataLen
);
620 extern void __glXSendLargeCommand(struct glx_context
*, const GLvoid
*, GLint
,
621 const GLvoid
*, GLint
);
623 /* Initialize the GLX extension for dpy */
624 extern struct glx_display
*__glXInitialize(Display
*);
626 extern void __glXPreferEGL(int state
);
628 /************************************************************************/
630 extern int __glXDebug
;
632 /* This is per-thread storage in an MT environment */
633 #if defined( HAVE_PTHREAD )
635 extern void __glXSetCurrentContext(struct glx_context
* c
);
637 # if defined( GLX_USE_TLS )
639 extern __thread
void *__glX_tls_Context
640 __attribute__ ((tls_model("initial-exec")));
642 # define __glXGetCurrentContext() __glX_tls_Context
646 extern struct glx_context
*__glXGetCurrentContext(void);
648 # endif /* defined( GLX_USE_TLS ) */
652 extern struct glx_context
*__glXcurrentContext
;
653 #define __glXGetCurrentContext() __glXcurrentContext
654 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
656 #endif /* defined( HAVE_PTHREAD ) */
658 extern void __glXSetCurrentContextNull(void);
662 ** Global lock for all threads in this address space using the GLX
665 #if defined( HAVE_PTHREAD )
666 extern pthread_mutex_t __glXmutex
;
667 #define __glXLock() pthread_mutex_lock(&__glXmutex)
668 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
671 #define __glXUnlock()
675 ** Setup for a command. Initialize the extension for dpy if necessary.
677 extern CARD8
__glXSetupForCommand(Display
* dpy
);
679 /************************************************************************/
682 ** Data conversion and packing support.
685 extern const GLuint __glXDefaultPixelStore
[9];
687 /* Send an image to the server using RenderLarge. */
688 extern void __glXSendLargeImage(struct glx_context
* gc
, GLint compsize
, GLint dim
,
689 GLint width
, GLint height
, GLint depth
,
690 GLenum format
, GLenum type
,
691 const GLvoid
* src
, GLubyte
* pc
,
694 /* Return the size, in bytes, of some pixel data */
695 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
697 /* Return the number of elements per group of a specified format*/
698 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
700 /* Return the number of bytes per element, based on the element type (other
703 extern GLint
__glBytesPerElement(GLenum type
);
706 ** Fill the transport buffer with the data from the users buffer,
707 ** applying some of the pixel store modes (unpack modes) to the data
708 ** first. As a side effect of this call, the "modes" field is
709 ** updated to contain the modes needed by the server to decode the
712 extern void __glFillImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
713 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
715 /* Copy map data with a stride into a packed buffer */
716 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
717 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
718 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
719 const GLfloat
*, GLfloat
*);
720 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
721 const GLdouble
*, GLdouble
*);
724 ** Empty an image out of the reply buffer into the clients memory applying
725 ** the pack modes to pack back into the clients requested format.
727 extern void __glEmptyImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
728 GLenum
, const GLubyte
*, GLvoid
*);
732 ** Allocate and Initialize Vertex Array client state, and free.
734 extern void __glXInitVertexArrayState(struct glx_context
*);
735 extern void __glXFreeVertexArrayState(struct glx_context
*);
738 ** Inform the Server of the major and minor numbers and of the client
739 ** libraries extension string.
741 extern void __glXClientInfo(Display
* dpy
, int opcode
);
744 __glX_send_client_info(struct glx_display
*glx_dpy
);
746 /************************************************************************/
749 ** Declarations that should be in Xlib
751 #ifdef __GL_USE_OUR_PROTOTYPES
752 extern void _XFlush(Display
*);
753 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
754 extern void _XRead(Display
*, void *, long);
755 extern void _XSend(Display
*, const void *, long);
759 extern void __glXInitializeVisualConfigFromTags(struct glx_config
* config
,
760 int count
, const INT32
* bp
,
762 Bool fbconfig_style_tags
);
764 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
765 CARD32 screen
, CARD32 name
);
766 extern char *__glXGetString(Display
* dpy
, int opcode
,
767 CARD32 screen
, CARD32 name
);
769 extern char *__glXstrdup(const char *str
);
772 extern const char __glXGLClientVersion
[];
773 extern const char __glXGLClientExtensions
[];
775 /* Get the unadjusted system time */
776 extern int __glXGetUST(int64_t * ust
);
778 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
780 int32_t * denominator
);
782 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
784 __glxGetMscRate(__GLXDRIdrawable
*glxDraw
,
785 int32_t * numerator
, int32_t * denominator
);
787 /* So that dri2.c:DRI2WireToEvent() can access
788 * glx_info->codes->first_event */
789 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
792 GarbageCollectDRIDrawables(struct glx_screen
*psc
);
794 extern __GLXDRIdrawable
*
795 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
);
798 extern struct glx_screen
*GetGLXScreenConfigs(Display
* dpy
, int scrn
);
800 #ifdef GLX_USE_APPLEGL
801 extern struct glx_screen
*
802 applegl_create_screen(int screen
, struct glx_display
* priv
);
804 extern struct glx_context
*
805 applegl_create_context(struct glx_screen
*psc
,
806 struct glx_config
*mode
,
807 struct glx_context
*shareList
, int renderType
);
810 applegl_create_display(struct glx_display
*display
);
813 extern Bool
validate_renderType_against_config(const struct glx_config
*config
,
817 extern struct glx_drawable
*GetGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
818 extern int InitGLXDrawable(Display
*dpy
, struct glx_drawable
*glxDraw
,
819 XID xDrawable
, GLXDrawable drawable
);
820 extern void DestroyGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
822 extern struct glx_context dummyContext
;
824 extern struct glx_screen
*
825 indirect_create_screen(int screen
, struct glx_display
* priv
);
826 extern struct glx_context
*
827 indirect_create_context(struct glx_screen
*psc
,
828 struct glx_config
*mode
,
829 struct glx_context
*shareList
, int renderType
);
830 extern struct glx_context
*
831 indirect_create_context_attribs(struct glx_screen
*base
,
832 struct glx_config
*config_base
,
833 struct glx_context
*shareList
,
834 unsigned num_attribs
,
835 const uint32_t *attribs
,
838 #endif /* !__GLX_client_h__ */