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 "glapi/glapitable.h"
55 #include "glxconfig.h"
57 #if defined( PTHREADS )
61 #include "glxextensions.h"
63 #define ARRAY_SIZE(a) (sizeof (a) / sizeof ((a)[0]))
65 #define GLX_MAJOR_VERSION 1 /* current version numbers */
66 #define GLX_MINOR_VERSION 4
68 #define __GLX_MAX_TEXTURE_UNITS 32
73 /************************************************************************/
75 #ifdef GLX_DIRECT_RENDERING
77 extern void DRI_glXUseXFont(struct glx_context
*ctx
,
78 Font font
, int first
, int count
, int listbase
);
82 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
85 * Display dependent methods. This structure is initialized during the
86 * \c driCreateDisplay call.
88 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
89 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
90 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
91 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
93 #include "glxextensions.h"
95 struct __GLXDRIdisplayRec
98 * Method to destroy the private DRI display data.
100 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
102 struct glx_screen
*(*createScreen
)(int screen
, struct glx_display
* priv
);
105 struct __GLXDRIscreenRec
{
107 void (*destroyScreen
)(struct glx_screen
*psc
);
109 struct glx_context
*(*createContext
)(struct glx_screen
*psc
,
110 struct glx_config
*config
,
111 struct glx_context
*shareList
,
114 __GLXDRIdrawable
*(*createDrawable
)(struct glx_screen
*psc
,
116 GLXDrawable glxDrawable
,
117 struct glx_config
*config
);
119 int64_t (*swapBuffers
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
120 int64_t divisor
, int64_t remainder
);
121 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
122 int x
, int y
, int width
, int height
);
123 int (*getDrawableMSC
)(struct glx_screen
*psc
, __GLXDRIdrawable
*pdraw
,
124 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
125 int (*waitForMSC
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
126 int64_t divisor
, int64_t remainder
, int64_t *ust
,
127 int64_t *msc
, int64_t *sbc
);
128 int (*waitForSBC
)(__GLXDRIdrawable
*pdraw
, int64_t target_sbc
, int64_t *ust
,
129 int64_t *msc
, int64_t *sbc
);
130 int (*setSwapInterval
)(__GLXDRIdrawable
*pdraw
, int interval
);
131 int (*getSwapInterval
)(__GLXDRIdrawable
*pdraw
);
134 struct __GLXDRIcontextRec
136 Bool(*bindContext
) (struct glx_context
*context
, __GLXDRIdrawable
*pdraw
,
137 __GLXDRIdrawable
*pread
);
138 void (*unbindContext
) (struct glx_context
*context
);
141 struct __GLXDRIdrawableRec
143 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
147 struct glx_screen
*psc
;
148 GLenum textureTarget
;
149 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
150 unsigned long eventMask
;
154 ** Function to create and DRI display data and initialize the display
155 ** dependent methods.
157 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
158 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
159 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
160 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
164 ** Functions to obtain driver configuration information from a direct
165 ** rendering client application
167 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
169 extern const char *glXGetDriverConfig(const char *driverName
);
173 /************************************************************************/
175 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
177 typedef struct __GLXpixelStoreModeRec
179 GLboolean swapEndian
;
188 } __GLXpixelStoreMode
;
191 typedef struct __GLXattributeRec
196 * Pixel storage state. Most of the pixel store mode state is kept
197 * here and used by the client code to manage the packing and
198 * unpacking of data sent to/received from the server.
200 __GLXpixelStoreMode storePack
, storeUnpack
;
203 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
206 GLboolean NoDrawArraysProtocol
;
209 * Vertex Array storage state. The vertex array component
210 * state is stored here and is used to manage the packing of
211 * DrawArrays data sent to the server.
213 struct array_state_vector
*array_state
;
216 typedef struct __GLXattributeMachineRec
218 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
219 __GLXattribute
**stackPointer
;
220 } __GLXattributeMachine
;
222 struct glx_context_vtable
{
223 void (*destroy
)(struct glx_context
*ctx
);
224 void (*wait_gl
)(struct glx_context
*ctx
);
225 void (*wait_x
)(struct glx_context
*ctx
);
226 void (*use_x_font
)(struct glx_context
*ctx
,
227 Font font
, int first
, int count
, int listBase
);
228 void (*bind_tex_image
)(Display
* dpy
,
229 GLXDrawable drawable
,
230 int buffer
, const int *attrib_list
);
231 void (*release_tex_image
)(Display
* dpy
, GLXDrawable drawable
, int buffer
);
236 glx_send_destroy_context(Display
*dpy
, XID xid
);
239 * GLX state that needs to be kept on the client. One of these records
240 * exist for each context that has been made current by this client.
245 * \name Drawing command buffer.
247 * Drawing commands are packed into this buffer before being sent as a
248 * single GLX protocol request. The buffer is sent when it overflows or
249 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
250 * in the buffer to be filled. \c limit is described above in the buffer
253 * Commands that require large amounts of data to be transfered will
254 * also use this buffer to hold a header that describes the large
257 * These must be the first 6 fields since they are static initialized
258 * in the dummy context in glxext.c
269 * The XID of this rendering context. When the context is created a
270 * new XID is allocated. This is set to None when the context is
271 * destroyed but is still current to some thread. In this case the
272 * context will be freed on next MakeCurrent.
277 * The XID of the \c shareList context.
285 struct glx_screen
*psc
;
288 * \c GL_TRUE if the context was created with ImportContext, which
289 * means the server-side context was created by another X client.
294 * The context tag returned by MakeCurrent when this context is made
295 * current. This tag is used to identify the context that a thread has
296 * current so that proper server context management can be done. It is
297 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
298 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
301 GLXContextTag currentContextTag
;
304 * \name Rendering mode
306 * The rendering mode is kept on the client as well as the server.
307 * When \c glRenderMode is called, the buffer associated with the
308 * previous rendering mode (feedback or select) is filled.
312 GLfloat
*feedbackBuf
;
317 * This is \c GL_TRUE if the pixel unpack modes are such that an image
318 * can be unpacked from the clients memory by just copying. It may
319 * still be true that the server will have to do some work. This
320 * just promises that a straight copy will fetch the correct bytes.
322 GLboolean fastImageUnpack
;
325 * Fill newImage with the unpacked form of \c oldImage getting it
326 * ready for transport to the server.
328 void (*fillImage
) (struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
329 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
332 * Client side attribs.
334 __GLXattributeMachine attributes
;
337 * Client side error code. This is set when client side gl API
338 * routines need to set an error because of a bad enumerant or
339 * running out of memory, etc.
344 * Whether this context does direct rendering.
349 * \c dpy of current display for this context. Will be \c NULL if not
350 * current to any display, or if this is the "dummy context".
355 * The current drawable for this context. Will be None if this
356 * context is not current to any drawable. currentReadable is below.
358 GLXDrawable currentDrawable
;
361 * \name GL Constant Strings
363 * Constant strings that describe the server implementation
364 * These pertain to GL attributes, not to be confused with
365 * GLX versioning attributes.
375 * Maximum small render command size. This is the smaller of 64k and
376 * the size of the above buffer.
378 GLint maxSmallRenderCommandSize
;
381 * Major opcode for the extension. Copied here so a lookup isn't
387 * Pointer to the config used to create this context.
389 struct glx_config
*config
;
391 #ifdef GLX_DIRECT_RENDERING
392 #ifdef GLX_USE_APPLEGL
396 __GLXDRIcontext
*driContext
;
401 * The current read-drawable for this context. Will be None if this
402 * context is not current to any drawable.
404 * \since Internal API version 20030606.
406 GLXDrawable currentReadable
;
409 * Pointer to client-state data that is private to libGL. This is only
410 * used for indirect rendering contexts.
412 * No internal API version change was made for this change. Client-side
413 * drivers should NEVER use this data or even care that it exists.
415 void *client_state_private
;
418 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
423 * \name Raw server GL version
425 * True core GL version supported by the server. This is the raw value
426 * returned by the server, and it may not reflect what is actually
427 * supported (or reported) by the client-side library.
430 int server_major
; /**< Major version number. */
431 int server_minor
; /**< Minor version number. */
435 * Thread ID we're currently current in. Zero if none.
437 unsigned long thread_id
;
439 char gl_extension_bits
[__GL_EXT_BYTES
];
441 const struct glx_context_vtable
*vtable
;
445 glx_context_init(struct glx_context
*gc
,
446 struct glx_screen
*psc
, struct glx_config
*fbconfig
);
448 #define __glXSetError(gc,code) \
449 if (!(gc)->error) { \
450 (gc)->error = code; \
453 extern void __glFreeAttributeState(struct glx_context
*);
455 /************************************************************************/
458 * The size of the largest drawing command known to the implementation
459 * that will use the GLXRender GLX command. In this case it is
460 * \c glPolygonStipple.
462 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
465 * To keep the implementation fast, the code uses a "limit" pointer
466 * to determine when the drawing command buffer is too full to hold
467 * another fixed size command. This constant defines the amount of
468 * space that must always be available in the drawing command buffer
469 * at all times for the implementation to work. It is important that
470 * the number be just large enough, but not so large as to reduce the
471 * efficacy of the buffer. The "+32" is just to keep the code working
472 * in case somebody counts wrong.
474 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
477 * This implementation uses a smaller threshold for switching
478 * to the RenderLarge protocol than the protcol requires so that
479 * large copies don't occur.
481 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
484 * One of these records exists per screen of the display. It contains
485 * a pointer to the config data for that screen (if the screen supports GL).
487 struct glx_screen_vtable
{
488 struct glx_context
*(*create_context
)(struct glx_screen
*psc
,
489 struct glx_config
*config
,
490 struct glx_context
*shareList
,
496 const struct glx_screen_vtable
*vtable
;
499 * GLX extension string reported by the X-server.
501 const char *serverGLXexts
;
504 * GLX extension string to be reported to applications. This is the
505 * set of extensions that the application can actually use.
507 char *effectiveGLXexts
;
509 struct glx_display
*display
;
511 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
513 * Per screen direct rendering interface functions and data.
518 __GLXDRIscreen
*driScreen
;
522 * Linked list of glx visuals and fbconfigs for this screen.
524 struct glx_config
*visuals
, *configs
;
527 * Per-screen dynamic GLX extension tracking. The \c direct_support
528 * field only contains enough bits for 64 extensions. Should libGL
529 * ever need to track more than 64 GLX extensions, we can safely grow
530 * this field. The \c struct glx_screen structure is not used outside
534 unsigned char direct_support
[8];
535 GLboolean ext_list_first_time
;
541 * Per display private data. One of these records exists for each display
542 * that is using the OpenGL (GLX) extension.
546 /* The extension protocol codes */
548 struct glx_display
*next
;
551 * Back pointer to the display
556 * The \c majorOpcode is common to all connections to the same server.
557 * It is also copied into the context structure.
562 * \name Server Version
564 * Major and minor version returned by the server during initialization.
567 int majorVersion
, minorVersion
;
571 * \name Storage for the servers GLX vendor and versions strings.
573 * These are the same for all screens on this display. These fields will
574 * be filled in on demand.
577 const char *serverGLXvendor
;
578 const char *serverGLXversion
;
582 * Configurations of visuals for all screens on this display.
583 * Also, per screen data which now includes the server \c GLX_EXTENSION
586 struct glx_screen
**screens
;
588 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
589 __glxHashTable
*drawHash
;
592 * Per display direct rendering interface functions and data.
594 __GLXDRIdisplay
*driswDisplay
;
595 __GLXDRIdisplay
*driDisplay
;
596 __GLXDRIdisplay
*dri2Display
;
601 glx_screen_init(struct glx_screen
*psc
,
602 int screen
, struct glx_display
* priv
);
604 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
605 extern __GLXDRIdrawable
*
606 dri2GetGlxDrawableFromXDrawableId(Display
*dpy
, XID id
);
609 extern GLubyte
*__glXFlushRenderBuffer(struct glx_context
*, GLubyte
*);
611 extern void __glXSendLargeChunk(struct glx_context
* gc
, GLint requestNumber
,
613 const GLvoid
* data
, GLint dataLen
);
615 extern void __glXSendLargeCommand(struct glx_context
*, const GLvoid
*, GLint
,
616 const GLvoid
*, GLint
);
618 /* Initialize the GLX extension for dpy */
619 extern struct glx_display
*__glXInitialize(Display
*);
621 extern void __glXPreferEGL(int state
);
623 /************************************************************************/
625 extern int __glXDebug
;
627 /* This is per-thread storage in an MT environment */
628 #if defined( PTHREADS )
630 extern void __glXSetCurrentContext(struct glx_context
* c
);
632 # if defined( GLX_USE_TLS )
634 extern __thread
void *__glX_tls_Context
635 __attribute__ ((tls_model("initial-exec")));
637 # define __glXGetCurrentContext() __glX_tls_Context
641 extern struct glx_context
*__glXGetCurrentContext(void);
643 # endif /* defined( GLX_USE_TLS ) */
647 extern struct glx_context
*__glXcurrentContext
;
648 #define __glXGetCurrentContext() __glXcurrentContext
649 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
651 #endif /* defined( PTHREADS ) */
653 extern void __glXSetCurrentContextNull(void);
657 ** Global lock for all threads in this address space using the GLX
660 #if defined( PTHREADS )
661 extern pthread_mutex_t __glXmutex
;
662 #define __glXLock() pthread_mutex_lock(&__glXmutex)
663 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
666 #define __glXUnlock()
670 ** Setup for a command. Initialize the extension for dpy if necessary.
672 extern CARD8
__glXSetupForCommand(Display
* dpy
);
674 /************************************************************************/
677 ** Data conversion and packing support.
680 extern const GLuint __glXDefaultPixelStore
[9];
682 /* Send an image to the server using RenderLarge. */
683 extern void __glXSendLargeImage(struct glx_context
* gc
, GLint compsize
, GLint dim
,
684 GLint width
, GLint height
, GLint depth
,
685 GLenum format
, GLenum type
,
686 const GLvoid
* src
, GLubyte
* pc
,
689 /* Return the size, in bytes, of some pixel data */
690 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
692 /* Return the number of elements per group of a specified format*/
693 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
695 /* Return the number of bytes per element, based on the element type (other
698 extern GLint
__glBytesPerElement(GLenum type
);
701 ** Fill the transport buffer with the data from the users buffer,
702 ** applying some of the pixel store modes (unpack modes) to the data
703 ** first. As a side effect of this call, the "modes" field is
704 ** updated to contain the modes needed by the server to decode the
707 extern void __glFillImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
708 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
710 /* Copy map data with a stride into a packed buffer */
711 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
712 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
713 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
714 const GLfloat
*, GLfloat
*);
715 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
716 const GLdouble
*, GLdouble
*);
719 ** Empty an image out of the reply buffer into the clients memory applying
720 ** the pack modes to pack back into the clients requested format.
722 extern void __glEmptyImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
723 GLenum
, const GLubyte
*, GLvoid
*);
727 ** Allocate and Initialize Vertex Array client state, and free.
729 extern void __glXInitVertexArrayState(struct glx_context
*);
730 extern void __glXFreeVertexArrayState(struct glx_context
*);
733 ** Inform the Server of the major and minor numbers and of the client
734 ** libraries extension string.
736 extern void __glXClientInfo(Display
* dpy
, int opcode
);
738 /************************************************************************/
741 ** Declarations that should be in Xlib
743 #ifdef __GL_USE_OUR_PROTOTYPES
744 extern void _XFlush(Display
*);
745 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
746 extern void _XRead(Display
*, void *, long);
747 extern void _XSend(Display
*, const void *, long);
751 extern void __glXInitializeVisualConfigFromTags(struct glx_config
* config
,
752 int count
, const INT32
* bp
,
754 Bool fbconfig_style_tags
);
756 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
757 CARD32 screen
, CARD32 name
);
758 extern char *__glXGetString(Display
* dpy
, int opcode
,
759 CARD32 screen
, CARD32 name
);
761 extern char *__glXstrdup(const char *str
);
764 extern const char __glXGLClientVersion
[];
765 extern const char __glXGLClientExtensions
[];
767 /* Get the unadjusted system time */
768 extern int __glXGetUST(int64_t * ust
);
770 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
772 int32_t * denominator
);
774 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
776 __glxGetMscRate(__GLXDRIdrawable
*glxDraw
,
777 int32_t * numerator
, int32_t * denominator
);
779 /* So that dri2.c:DRI2WireToEvent() can access
780 * glx_info->codes->first_event */
781 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
784 GarbageCollectDRIDrawables(struct glx_screen
*psc
);
786 extern __GLXDRIdrawable
*
787 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
);
791 extern struct glx_screen
*
792 indirect_create_screen(int screen
, struct glx_display
* priv
);
794 #endif /* !__GLX_client_h__ */