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
);
128 int (*getBufferAge
)(__GLXDRIdrawable
*pdraw
);
131 struct __GLXDRIdrawableRec
133 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
137 struct glx_screen
*psc
;
138 GLenum textureTarget
;
139 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
140 unsigned long eventMask
;
145 ** Function to create and DRI display data and initialize the display
146 ** dependent methods.
148 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
149 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
150 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
151 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
152 extern unsigned dri2GetSwapEventType(Display
*dpy
, XID drawable
);
154 extern __GLXDRIdisplay
*dri3_create_display(Display
* dpy
);
157 ** Functions to obtain driver configuration information from a direct
158 ** rendering client application
160 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
162 extern const char *glXGetDriverConfig(const char *driverName
);
166 /************************************************************************/
168 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
170 typedef struct __GLXpixelStoreModeRec
172 GLboolean swapEndian
;
181 } __GLXpixelStoreMode
;
184 typedef struct __GLXattributeRec
189 * Pixel storage state. Most of the pixel store mode state is kept
190 * here and used by the client code to manage the packing and
191 * unpacking of data sent to/received from the server.
193 __GLXpixelStoreMode storePack
, storeUnpack
;
196 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
199 GLboolean NoDrawArraysProtocol
;
202 * Vertex Array storage state. The vertex array component
203 * state is stored here and is used to manage the packing of
204 * DrawArrays data sent to the server.
206 struct array_state_vector
*array_state
;
209 typedef struct __GLXattributeMachineRec
211 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
212 __GLXattribute
**stackPointer
;
213 } __GLXattributeMachine
;
215 struct glx_context_vtable
{
216 void (*destroy
)(struct glx_context
*ctx
);
217 int (*bind
)(struct glx_context
*context
, struct glx_context
*old
,
218 GLXDrawable draw
, GLXDrawable read
);
219 void (*unbind
)(struct glx_context
*context
, struct glx_context
*new_ctx
);
220 void (*wait_gl
)(struct glx_context
*ctx
);
221 void (*wait_x
)(struct glx_context
*ctx
);
222 void (*use_x_font
)(struct glx_context
*ctx
,
223 Font font
, int first
, int count
, int listBase
);
224 void (*bind_tex_image
)(Display
* dpy
,
225 GLXDrawable drawable
,
226 int buffer
, const int *attrib_list
);
227 void (*release_tex_image
)(Display
* dpy
, GLXDrawable drawable
, int buffer
);
228 void * (*get_proc_address
)(const char *symbol
);
232 * GLX state that needs to be kept on the client. One of these records
233 * exist for each context that has been made current by this client.
238 * \name Drawing command buffer.
240 * Drawing commands are packed into this buffer before being sent as a
241 * single GLX protocol request. The buffer is sent when it overflows or
242 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
243 * in the buffer to be filled. \c limit is described above in the buffer
246 * Commands that require large amounts of data to be transfered will
247 * also use this buffer to hold a header that describes the large
250 * These must be the first 6 fields since they are static initialized
251 * in the dummy context in glxext.c
261 const struct glx_context_vtable
*vtable
;
264 * The XID of this rendering context. When the context is created a
265 * new XID is allocated. This is set to None when the context is
266 * destroyed but is still current to some thread. In this case the
267 * context will be freed on next MakeCurrent.
272 * The XID of the \c shareList context.
280 struct glx_screen
*psc
;
283 * \c GL_TRUE if the context was created with ImportContext, which
284 * means the server-side context was created by another X client.
289 * The context tag returned by MakeCurrent when this context is made
290 * current. This tag is used to identify the context that a thread has
291 * current so that proper server context management can be done. It is
292 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
293 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
296 GLXContextTag currentContextTag
;
299 * \name Rendering mode
301 * The rendering mode is kept on the client as well as the server.
302 * When \c glRenderMode is called, the buffer associated with the
303 * previous rendering mode (feedback or select) is filled.
307 GLfloat
*feedbackBuf
;
312 * Fill newImage with the unpacked form of \c oldImage getting it
313 * ready for transport to the server.
315 void (*fillImage
) (struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
316 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
319 * Client side attribs.
321 __GLXattributeMachine attributes
;
324 * Client side error code. This is set when client side gl API
325 * routines need to set an error because of a bad enumerant or
326 * running out of memory, etc.
331 * Whether this context does direct rendering.
335 #if defined(GLX_DIRECT_RENDERING) && defined(GLX_USE_APPLEGL)
340 * \c dpy of current display for this context. Will be \c NULL if not
341 * current to any display, or if this is the "dummy context".
346 * The current drawable for this context. Will be None if this
347 * context is not current to any drawable. currentReadable is below.
349 GLXDrawable currentDrawable
;
352 * \name GL Constant Strings
354 * Constant strings that describe the server implementation
355 * These pertain to GL attributes, not to be confused with
356 * GLX versioning attributes.
366 * Maximum small render command size. This is the smaller of 64k and
367 * the size of the above buffer.
369 GLint maxSmallRenderCommandSize
;
372 * Major opcode for the extension. Copied here so a lookup isn't
378 * Pointer to the config used to create this context.
380 struct glx_config
*config
;
383 * The current read-drawable for this context. Will be None if this
384 * context is not current to any drawable.
386 * \since Internal API version 20030606.
388 GLXDrawable currentReadable
;
391 * Pointer to client-state data that is private to libGL. This is only
392 * used for indirect rendering contexts.
394 * No internal API version change was made for this change. Client-side
395 * drivers should NEVER use this data or even care that it exists.
397 void *client_state_private
;
400 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
405 * \name Raw server GL version
407 * True core GL version supported by the server. This is the raw value
408 * returned by the server, and it may not reflect what is actually
409 * supported (or reported) by the client-side library.
412 int server_major
; /**< Major version number. */
413 int server_minor
; /**< Minor version number. */
417 * Number of threads we're currently current in.
419 unsigned long thread_refcount
;
421 char gl_extension_bits
[__GL_EXT_BYTES
];
425 glx_context_init(struct glx_context
*gc
,
426 struct glx_screen
*psc
, struct glx_config
*fbconfig
);
428 #define __glXSetError(gc,code) \
429 if (!(gc)->error) { \
430 (gc)->error = code; \
433 extern void __glFreeAttributeState(struct glx_context
*);
435 /************************************************************************/
438 * The size of the largest drawing command known to the implementation
439 * that will use the GLXRender GLX command. In this case it is
440 * \c glPolygonStipple.
442 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
445 * To keep the implementation fast, the code uses a "limit" pointer
446 * to determine when the drawing command buffer is too full to hold
447 * another fixed size command. This constant defines the amount of
448 * space that must always be available in the drawing command buffer
449 * at all times for the implementation to work. It is important that
450 * the number be just large enough, but not so large as to reduce the
451 * efficacy of the buffer. The "+32" is just to keep the code working
452 * in case somebody counts wrong.
454 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
457 * This implementation uses a smaller threshold for switching
458 * to the RenderLarge protocol than the protcol requires so that
459 * large copies don't occur.
461 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
464 * One of these records exists per screen of the display. It contains
465 * a pointer to the config data for that screen (if the screen supports GL).
467 struct glx_screen_vtable
{
468 struct glx_context
*(*create_context
)(struct glx_screen
*psc
,
469 struct glx_config
*config
,
470 struct glx_context
*shareList
,
473 struct glx_context
*(*create_context_attribs
)(struct glx_screen
*psc
,
474 struct glx_config
*config
,
475 struct glx_context
*shareList
,
477 const uint32_t *attribs
,
479 int (*query_renderer_integer
)(struct glx_screen
*psc
,
481 unsigned int *value
);
482 int (*query_renderer_string
)(struct glx_screen
*psc
,
489 const struct glx_screen_vtable
*vtable
;
492 * GLX extension string reported by the X-server.
494 const char *serverGLXexts
;
497 * GLX extension string to be reported to applications. This is the
498 * set of extensions that the application can actually use.
500 char *effectiveGLXexts
;
502 struct glx_display
*display
;
507 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
509 * Per screen direct rendering interface functions and data.
511 __GLXDRIscreen
*driScreen
;
515 * Linked list of glx visuals and fbconfigs for this screen.
517 struct glx_config
*visuals
, *configs
;
520 * Per-screen dynamic GLX extension tracking. The \c direct_support
521 * field only contains enough bits for 64 extensions. Should libGL
522 * ever need to track more than 64 GLX extensions, we can safely grow
523 * this field. The \c struct glx_screen structure is not used outside
527 unsigned char direct_support
[8];
528 GLboolean ext_list_first_time
;
534 * Per display private data. One of these records exists for each display
535 * that is using the OpenGL (GLX) extension.
539 /* The extension protocol codes */
541 struct glx_display
*next
;
544 * Back pointer to the display
549 * The \c majorOpcode is common to all connections to the same server.
550 * It is also copied into the context structure.
555 * \name Server Version
557 * Major and minor version returned by the server during initialization.
560 int majorVersion
, minorVersion
;
564 * \name Storage for the servers GLX vendor and versions strings.
566 * These are the same for all screens on this display. These fields will
567 * be filled in on demand.
570 const char *serverGLXvendor
;
571 const char *serverGLXversion
;
575 * Configurations of visuals for all screens on this display.
576 * Also, per screen data which now includes the server \c GLX_EXTENSION
579 struct glx_screen
**screens
;
581 __glxHashTable
*glXDrawHash
;
583 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
584 __glxHashTable
*drawHash
;
587 * Per display direct rendering interface functions and data.
589 __GLXDRIdisplay
*driswDisplay
;
590 __GLXDRIdisplay
*driDisplay
;
591 __GLXDRIdisplay
*dri2Display
;
592 __GLXDRIdisplay
*dri3Display
;
596 struct glx_drawable
{
600 uint32_t lastEventSbc
;
601 int64_t eventSbcWrap
;
605 glx_screen_init(struct glx_screen
*psc
,
606 int screen
, struct glx_display
* priv
);
608 glx_screen_cleanup(struct glx_screen
*psc
);
610 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
611 extern __GLXDRIdrawable
*
612 dri2GetGlxDrawableFromXDrawableId(Display
*dpy
, XID id
);
615 extern GLubyte
*__glXFlushRenderBuffer(struct glx_context
*, GLubyte
*);
617 extern void __glXSendLargeChunk(struct glx_context
* gc
, GLint requestNumber
,
619 const GLvoid
* data
, GLint dataLen
);
621 extern void __glXSendLargeCommand(struct glx_context
*, const GLvoid
*, GLint
,
622 const GLvoid
*, GLint
);
624 /* Initialize the GLX extension for dpy */
625 extern struct glx_display
*__glXInitialize(Display
*);
627 extern void __glXPreferEGL(int state
);
629 /************************************************************************/
631 extern int __glXDebug
;
633 /* This is per-thread storage in an MT environment */
634 #if defined( HAVE_PTHREAD )
636 extern void __glXSetCurrentContext(struct glx_context
* c
);
638 # if defined( GLX_USE_TLS )
640 extern __thread
void *__glX_tls_Context
641 __attribute__ ((tls_model("initial-exec")));
643 # define __glXGetCurrentContext() __glX_tls_Context
647 extern struct glx_context
*__glXGetCurrentContext(void);
649 # endif /* defined( GLX_USE_TLS ) */
653 extern struct glx_context
*__glXcurrentContext
;
654 #define __glXGetCurrentContext() __glXcurrentContext
655 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
657 #endif /* defined( HAVE_PTHREAD ) */
659 extern void __glXSetCurrentContextNull(void);
663 ** Global lock for all threads in this address space using the GLX
666 #if defined( HAVE_PTHREAD )
667 extern pthread_mutex_t __glXmutex
;
668 #define __glXLock() pthread_mutex_lock(&__glXmutex)
669 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
672 #define __glXUnlock()
676 ** Setup for a command. Initialize the extension for dpy if necessary.
678 extern CARD8
__glXSetupForCommand(Display
* dpy
);
680 /************************************************************************/
683 ** Data conversion and packing support.
686 extern const GLuint __glXDefaultPixelStore
[9];
688 /* Send an image to the server using RenderLarge. */
689 extern void __glXSendLargeImage(struct glx_context
* gc
, GLint compsize
, GLint dim
,
690 GLint width
, GLint height
, GLint depth
,
691 GLenum format
, GLenum type
,
692 const GLvoid
* src
, GLubyte
* pc
,
695 /* Return the size, in bytes, of some pixel data */
696 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
698 /* Return the number of elements per group of a specified format*/
699 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
701 /* Return the number of bytes per element, based on the element type (other
704 extern GLint
__glBytesPerElement(GLenum type
);
707 ** Fill the transport buffer with the data from the users buffer,
708 ** applying some of the pixel store modes (unpack modes) to the data
709 ** first. As a side effect of this call, the "modes" field is
710 ** updated to contain the modes needed by the server to decode the
713 extern void __glFillImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
714 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
716 /* Copy map data with a stride into a packed buffer */
717 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
718 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
719 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
720 const GLfloat
*, GLfloat
*);
721 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
722 const GLdouble
*, GLdouble
*);
725 ** Empty an image out of the reply buffer into the clients memory applying
726 ** the pack modes to pack back into the clients requested format.
728 extern void __glEmptyImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
729 GLenum
, const GLubyte
*, GLvoid
*);
733 ** Allocate and Initialize Vertex Array client state, and free.
735 extern void __glXInitVertexArrayState(struct glx_context
*);
736 extern void __glXFreeVertexArrayState(struct glx_context
*);
739 ** Inform the Server of the major and minor numbers and of the client
740 ** libraries extension string.
742 extern void __glXClientInfo(Display
* dpy
, int opcode
);
745 __glX_send_client_info(struct glx_display
*glx_dpy
);
747 /************************************************************************/
750 ** Declarations that should be in Xlib
752 #ifdef __GL_USE_OUR_PROTOTYPES
753 extern void _XFlush(Display
*);
754 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
755 extern void _XRead(Display
*, void *, long);
756 extern void _XSend(Display
*, const void *, long);
760 extern void __glXInitializeVisualConfigFromTags(struct glx_config
* config
,
761 int count
, const INT32
* bp
,
763 Bool fbconfig_style_tags
);
765 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
766 CARD32 screen
, CARD32 name
);
767 extern char *__glXGetString(Display
* dpy
, int opcode
,
768 CARD32 screen
, CARD32 name
);
770 extern char *__glXstrdup(const char *str
);
773 extern const char __glXGLClientVersion
[];
774 extern const char __glXGLClientExtensions
[];
776 /* Get the unadjusted system time */
777 extern int __glXGetUST(int64_t * ust
);
779 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
781 int32_t * denominator
);
783 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
785 __glxGetMscRate(struct glx_screen
*psc
,
786 int32_t * numerator
, int32_t * denominator
);
788 /* So that dri2.c:DRI2WireToEvent() can access
789 * glx_info->codes->first_event */
790 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
793 GarbageCollectDRIDrawables(struct glx_screen
*psc
);
795 extern __GLXDRIdrawable
*
796 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
);
799 extern struct glx_screen
*GetGLXScreenConfigs(Display
* dpy
, int scrn
);
801 #ifdef GLX_USE_APPLEGL
802 extern struct glx_screen
*
803 applegl_create_screen(int screen
, struct glx_display
* priv
);
805 extern struct glx_context
*
806 applegl_create_context(struct glx_screen
*psc
,
807 struct glx_config
*mode
,
808 struct glx_context
*shareList
, int renderType
);
811 applegl_create_display(struct glx_display
*display
);
814 extern Bool
validate_renderType_against_config(const struct glx_config
*config
,
818 extern struct glx_drawable
*GetGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
819 extern int InitGLXDrawable(Display
*dpy
, struct glx_drawable
*glxDraw
,
820 XID xDrawable
, GLXDrawable drawable
);
821 extern void DestroyGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
823 extern struct glx_context dummyContext
;
825 extern struct glx_screen
*
826 indirect_create_screen(int screen
, struct glx_display
* priv
);
827 extern struct glx_context
*
828 indirect_create_context(struct glx_screen
*psc
,
829 struct glx_config
*mode
,
830 struct glx_context
*shareList
, int renderType
);
831 extern struct glx_context
*
832 indirect_create_context_attribs(struct glx_screen
*base
,
833 struct glx_config
*config_base
,
834 struct glx_context
*shareList
,
835 unsigned num_attribs
,
836 const uint32_t *attribs
,
839 #endif /* !__GLX_client_h__ */