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>
52 #include "GL/glxproto.h"
53 #include "glxconfig.h"
55 #include "util/macros.h"
57 #include "glxextensions.h"
59 #if defined(USE_LIBGLVND_GLX)
60 #define _GLX_PUBLIC _X_HIDDEN
62 #define _GLX_PUBLIC _X_EXPORT
70 #define GLX_MAJOR_VERSION 1 /* current version numbers */
71 #define GLX_MINOR_VERSION 4
73 #define __GLX_MAX_TEXTURE_UNITS 32
78 /************************************************************************/
80 #ifdef GLX_DIRECT_RENDERING
82 extern void DRI_glXUseXFont(struct glx_context
*ctx
,
83 Font font
, int first
, int count
, int listbase
);
87 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
90 * Display dependent methods. This structure is initialized during the
91 * \c driCreateDisplay call.
93 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
94 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
95 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
97 struct __GLXDRIdisplayRec
100 * Method to destroy the private DRI display data.
102 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
104 struct glx_screen
*(*createScreen
)(int screen
, struct glx_display
* priv
);
107 struct __GLXDRIscreenRec
{
109 void (*destroyScreen
)(struct glx_screen
*psc
);
111 struct glx_context
*(*createContext
)(struct glx_screen
*psc
,
112 struct glx_config
*config
,
113 struct glx_context
*shareList
,
116 __GLXDRIdrawable
*(*createDrawable
)(struct glx_screen
*psc
,
118 GLXDrawable glxDrawable
,
119 struct glx_config
*config
);
121 int64_t (*swapBuffers
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
122 int64_t divisor
, int64_t remainder
, Bool flush
);
123 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
124 int x
, int y
, int width
, int height
, Bool flush
);
125 int (*getDrawableMSC
)(struct glx_screen
*psc
, __GLXDRIdrawable
*pdraw
,
126 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
127 int (*waitForMSC
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
128 int64_t divisor
, int64_t remainder
, int64_t *ust
,
129 int64_t *msc
, int64_t *sbc
);
130 int (*waitForSBC
)(__GLXDRIdrawable
*pdraw
, int64_t target_sbc
, int64_t *ust
,
131 int64_t *msc
, int64_t *sbc
);
132 int (*setSwapInterval
)(__GLXDRIdrawable
*pdraw
, int interval
);
133 int (*getSwapInterval
)(__GLXDRIdrawable
*pdraw
);
134 int (*getBufferAge
)(__GLXDRIdrawable
*pdraw
);
137 struct __GLXDRIdrawableRec
139 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
143 struct glx_screen
*psc
;
144 GLenum textureTarget
;
145 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
146 unsigned long eventMask
;
151 ** Function to create and DRI display data and initialize the display
152 ** dependent methods.
154 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
155 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
156 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
157 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
158 extern unsigned dri2GetSwapEventType(Display
*dpy
, XID drawable
);
160 extern __GLXDRIdisplay
*dri3_create_display(Display
* dpy
);
163 ** Functions to obtain driver configuration information from a direct
164 ** rendering client application
166 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
168 extern const char *glXGetDriverConfig(const char *driverName
);
172 /************************************************************************/
174 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
176 typedef struct __GLXpixelStoreModeRec
178 GLboolean swapEndian
;
187 } __GLXpixelStoreMode
;
190 typedef struct __GLXattributeRec
195 * Pixel storage state. Most of the pixel store mode state is kept
196 * here and used by the client code to manage the packing and
197 * unpacking of data sent to/received from the server.
199 __GLXpixelStoreMode storePack
, storeUnpack
;
202 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
205 GLboolean NoDrawArraysProtocol
;
208 * Vertex Array storage state. The vertex array component
209 * state is stored here and is used to manage the packing of
210 * DrawArrays data sent to the server.
212 struct array_state_vector
*array_state
;
215 typedef struct __GLXattributeMachineRec
217 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
218 __GLXattribute
**stackPointer
;
219 } __GLXattributeMachine
;
221 struct mesa_glinterop_device_info
;
222 struct mesa_glinterop_export_in
;
223 struct mesa_glinterop_export_out
;
225 struct glx_context_vtable
{
226 void (*destroy
)(struct glx_context
*ctx
);
227 int (*bind
)(struct glx_context
*context
, struct glx_context
*old
,
228 GLXDrawable draw
, GLXDrawable read
);
229 void (*unbind
)(struct glx_context
*context
, struct glx_context
*new_ctx
);
230 void (*wait_gl
)(struct glx_context
*ctx
);
231 void (*wait_x
)(struct glx_context
*ctx
);
232 void (*use_x_font
)(struct glx_context
*ctx
,
233 Font font
, int first
, int count
, int listBase
);
234 void (*bind_tex_image
)(Display
* dpy
,
235 GLXDrawable drawable
,
236 int buffer
, const int *attrib_list
);
237 void (*release_tex_image
)(Display
* dpy
, GLXDrawable drawable
, int buffer
);
238 void * (*get_proc_address
)(const char *symbol
);
239 int (*interop_query_device_info
)(struct glx_context
*ctx
,
240 struct mesa_glinterop_device_info
*out
);
241 int (*interop_export_object
)(struct glx_context
*ctx
,
242 struct mesa_glinterop_export_in
*in
,
243 struct mesa_glinterop_export_out
*out
);
247 * GLX state that needs to be kept on the client. One of these records
248 * exist for each context that has been made current by this client.
253 * \name Drawing command buffer.
255 * Drawing commands are packed into this buffer before being sent as a
256 * single GLX protocol request. The buffer is sent when it overflows or
257 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
258 * in the buffer to be filled. \c limit is described above in the buffer
261 * Commands that require large amounts of data to be transfered will
262 * also use this buffer to hold a header that describes the large
265 * These must be the first 6 fields since they are static initialized
266 * in the dummy context in glxext.c
276 const struct glx_context_vtable
*vtable
;
279 * The XID of this rendering context. When the context is created a
280 * new XID is allocated. This is set to None when the context is
281 * destroyed but is still current to some thread. In this case the
282 * context will be freed on next MakeCurrent.
287 * The XID of the \c shareList context.
295 struct glx_screen
*psc
;
298 * \c GL_TRUE if the context was created with ImportContext, which
299 * means the server-side context was created by another X client.
304 * The context tag returned by MakeCurrent when this context is made
305 * current. This tag is used to identify the context that a thread has
306 * current so that proper server context management can be done. It is
307 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
308 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
311 GLXContextTag currentContextTag
;
314 * \name Rendering mode
316 * The rendering mode is kept on the client as well as the server.
317 * When \c glRenderMode is called, the buffer associated with the
318 * previous rendering mode (feedback or select) is filled.
322 GLfloat
*feedbackBuf
;
327 * Fill newImage with the unpacked form of \c oldImage getting it
328 * ready for transport to the server.
330 void (*fillImage
) (struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
331 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
334 * Client side attribs.
336 __GLXattributeMachine attributes
;
339 * Client side error code. This is set when client side gl API
340 * routines need to set an error because of a bad enumerant or
341 * running out of memory, etc.
346 * Whether this context does direct rendering.
350 #if defined(GLX_DIRECT_RENDERING) && defined(GLX_USE_APPLEGL)
355 * \c dpy of current display for this context. Will be \c NULL if not
356 * current to any display, or if this is the "dummy context".
361 * The current drawable for this context. Will be None if this
362 * context is not current to any drawable. currentReadable is below.
364 GLXDrawable currentDrawable
;
367 * \name GL Constant Strings
369 * Constant strings that describe the server implementation
370 * These pertain to GL attributes, not to be confused with
371 * GLX versioning attributes.
381 * Maximum small render command size. This is the smaller of 64k and
382 * the size of the above buffer.
384 GLint maxSmallRenderCommandSize
;
387 * Major opcode for the extension. Copied here so a lookup isn't
393 * Pointer to the config used to create this context.
395 struct glx_config
*config
;
398 * The current read-drawable for this context. Will be None if this
399 * context is not current to any drawable.
401 * \since Internal API version 20030606.
403 GLXDrawable currentReadable
;
406 * Pointer to client-state data that is private to libGL. This is only
407 * used for indirect rendering contexts.
409 * No internal API version change was made for this change. Client-side
410 * drivers should NEVER use this data or even care that it exists.
412 void *client_state_private
;
415 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
420 * \name Raw server GL version
422 * True core GL version supported by the server. This is the raw value
423 * returned by the server, and it may not reflect what is actually
424 * supported (or reported) by the client-side library.
427 int server_major
; /**< Major version number. */
428 int server_minor
; /**< Minor version number. */
432 * Number of threads we're currently current in.
434 unsigned long thread_refcount
;
436 char gl_extension_bits
[__GL_EXT_BYTES
];
440 glx_context_init(struct glx_context
*gc
,
441 struct glx_screen
*psc
, struct glx_config
*fbconfig
);
443 #define __glXSetError(gc,code) \
444 if (!(gc)->error) { \
445 (gc)->error = code; \
448 extern void __glFreeAttributeState(struct glx_context
*);
450 /************************************************************************/
453 * The size of the largest drawing command known to the implementation
454 * that will use the GLXRender GLX command. In this case it is
455 * \c glPolygonStipple.
457 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
460 * To keep the implementation fast, the code uses a "limit" pointer
461 * to determine when the drawing command buffer is too full to hold
462 * another fixed size command. This constant defines the amount of
463 * space that must always be available in the drawing command buffer
464 * at all times for the implementation to work. It is important that
465 * the number be just large enough, but not so large as to reduce the
466 * efficacy of the buffer. The "+32" is just to keep the code working
467 * in case somebody counts wrong.
469 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
472 * This implementation uses a smaller threshold for switching
473 * to the RenderLarge protocol than the protcol requires so that
474 * large copies don't occur.
476 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
479 * One of these records exists per screen of the display. It contains
480 * a pointer to the config data for that screen (if the screen supports GL).
482 struct glx_screen_vtable
{
483 struct glx_context
*(*create_context
)(struct glx_screen
*psc
,
484 struct glx_config
*config
,
485 struct glx_context
*shareList
,
488 struct glx_context
*(*create_context_attribs
)(struct glx_screen
*psc
,
489 struct glx_config
*config
,
490 struct glx_context
*shareList
,
492 const uint32_t *attribs
,
494 int (*query_renderer_integer
)(struct glx_screen
*psc
,
496 unsigned int *value
);
497 int (*query_renderer_string
)(struct glx_screen
*psc
,
504 const struct glx_screen_vtable
*vtable
;
507 * GLX extension string reported by the X-server.
509 const char *serverGLXexts
;
512 * GLX extension string to be reported to applications. This is the
513 * set of extensions that the application can actually use.
515 char *effectiveGLXexts
;
517 struct glx_display
*display
;
522 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
524 * Per screen direct rendering interface functions and data.
526 __GLXDRIscreen
*driScreen
;
530 * Linked list of glx visuals and fbconfigs for this screen.
532 struct glx_config
*visuals
, *configs
;
535 * Per-screen dynamic GLX extension tracking. The \c direct_support
536 * field only contains enough bits for 64 extensions. Should libGL
537 * ever need to track more than 64 GLX extensions, we can safely grow
538 * this field. The \c struct glx_screen structure is not used outside
542 unsigned char direct_support
[8];
543 GLboolean ext_list_first_time
;
549 * Per display private data. One of these records exists for each display
550 * that is using the OpenGL (GLX) extension.
554 /* The extension protocol codes */
556 struct glx_display
*next
;
559 * Back pointer to the display
564 * The \c majorOpcode is common to all connections to the same server.
565 * It is also copied into the context structure.
570 * \name Server Version
572 * Major and minor version returned by the server during initialization.
575 int majorVersion
, minorVersion
;
579 * \name Storage for the servers GLX vendor and versions strings.
581 * These are the same for all screens on this display. These fields will
582 * be filled in on demand.
585 const char *serverGLXvendor
;
586 const char *serverGLXversion
;
590 * Configurations of visuals for all screens on this display.
591 * Also, per screen data which now includes the server \c GLX_EXTENSION
594 struct glx_screen
**screens
;
596 __glxHashTable
*glXDrawHash
;
598 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
599 __glxHashTable
*drawHash
;
602 * Per display direct rendering interface functions and data.
604 __GLXDRIdisplay
*driswDisplay
;
605 __GLXDRIdisplay
*driDisplay
;
606 __GLXDRIdisplay
*dri2Display
;
607 __GLXDRIdisplay
*dri3Display
;
611 struct glx_drawable
{
615 uint32_t lastEventSbc
;
616 int64_t eventSbcWrap
;
620 glx_screen_init(struct glx_screen
*psc
,
621 int screen
, struct glx_display
* priv
);
623 glx_screen_cleanup(struct glx_screen
*psc
);
625 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
626 extern __GLXDRIdrawable
*
627 dri2GetGlxDrawableFromXDrawableId(Display
*dpy
, XID id
);
630 extern GLubyte
*__glXFlushRenderBuffer(struct glx_context
*, GLubyte
*);
632 extern void __glXSendLargeChunk(struct glx_context
* gc
, GLint requestNumber
,
634 const GLvoid
* data
, GLint dataLen
);
636 extern void __glXSendLargeCommand(struct glx_context
*, const GLvoid
*, GLint
,
637 const GLvoid
*, GLint
);
639 /* Initialize the GLX extension for dpy */
640 extern struct glx_display
*__glXInitialize(Display
*);
642 extern void __glXPreferEGL(int state
);
644 /************************************************************************/
646 extern int __glXDebug
;
648 /* This is per-thread storage in an MT environment */
650 extern void __glXSetCurrentContext(struct glx_context
* c
);
652 # if defined( GLX_USE_TLS )
654 extern __thread
void *__glX_tls_Context
655 __attribute__ ((tls_model("initial-exec")));
657 # define __glXGetCurrentContext() __glX_tls_Context
661 extern struct glx_context
*__glXGetCurrentContext(void);
663 # endif /* defined( GLX_USE_TLS ) */
665 extern void __glXSetCurrentContextNull(void);
669 ** Global lock for all threads in this address space using the GLX
672 extern pthread_mutex_t __glXmutex
;
673 #define __glXLock() pthread_mutex_lock(&__glXmutex)
674 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
677 ** Setup for a command. Initialize the extension for dpy if necessary.
679 extern CARD8
__glXSetupForCommand(Display
* dpy
);
681 /************************************************************************/
684 ** Data conversion and packing support.
687 extern const GLuint __glXDefaultPixelStore
[9];
689 /* Send an image to the server using RenderLarge. */
690 extern void __glXSendLargeImage(struct glx_context
* gc
, GLint compsize
, GLint dim
,
691 GLint width
, GLint height
, GLint depth
,
692 GLenum format
, GLenum type
,
693 const GLvoid
* src
, GLubyte
* pc
,
696 /* Return the size, in bytes, of some pixel data */
697 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
699 /* Return the number of elements per group of a specified format*/
700 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
702 /* Return the number of bytes per element, based on the element type (other
705 extern GLint
__glBytesPerElement(GLenum type
);
708 ** Fill the transport buffer with the data from the users buffer,
709 ** applying some of the pixel store modes (unpack modes) to the data
710 ** first. As a side effect of this call, the "modes" field is
711 ** updated to contain the modes needed by the server to decode the
714 extern void __glFillImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
715 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
717 /* Copy map data with a stride into a packed buffer */
718 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
719 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
720 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
721 const GLfloat
*, GLfloat
*);
722 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
723 const GLdouble
*, GLdouble
*);
726 ** Empty an image out of the reply buffer into the clients memory applying
727 ** the pack modes to pack back into the clients requested format.
729 extern void __glEmptyImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
730 GLenum
, const GLubyte
*, GLvoid
*);
734 ** Allocate and Initialize Vertex Array client state, and free.
736 extern void __glXInitVertexArrayState(struct glx_context
*);
737 extern void __glXFreeVertexArrayState(struct glx_context
*);
740 ** Inform the Server of the major and minor numbers and of the client
741 ** libraries extension string.
743 extern void __glXClientInfo(Display
* dpy
, int opcode
);
746 __glX_send_client_info(struct glx_display
*glx_dpy
);
748 /************************************************************************/
751 ** Declarations that should be in Xlib
753 #ifdef __GL_USE_OUR_PROTOTYPES
754 extern void _XFlush(Display
*);
755 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
756 extern void _XRead(Display
*, void *, long);
757 extern void _XSend(Display
*, const void *, long);
761 extern void __glXInitializeVisualConfigFromTags(struct glx_config
* config
,
762 int count
, const INT32
* bp
,
764 Bool fbconfig_style_tags
);
766 extern char *__glXQueryServerString(Display
* dpy
, int opcode
,
767 CARD32 screen
, CARD32 name
);
768 extern char *__glXGetString(Display
* dpy
, int opcode
,
769 CARD32 screen
, CARD32 name
);
771 extern const char __glXGLClientVersion
[];
772 extern const char __glXGLClientExtensions
[];
774 /* Get the unadjusted system time */
775 extern int __glXGetUST(int64_t * ust
);
777 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
779 int32_t * denominator
);
781 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
783 __glxGetMscRate(struct glx_screen
*psc
,
784 int32_t * numerator
, int32_t * denominator
);
786 /* So that dri2.c:DRI2WireToEvent() can access
787 * glx_info->codes->first_event */
788 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
791 GarbageCollectDRIDrawables(struct glx_screen
*psc
);
793 extern __GLXDRIdrawable
*
794 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
);
797 extern struct glx_screen
*GetGLXScreenConfigs(Display
* dpy
, int scrn
);
799 #ifdef GLX_USE_APPLEGL
800 extern struct glx_screen
*
801 applegl_create_screen(int screen
, struct glx_display
* priv
);
803 extern struct glx_context
*
804 applegl_create_context(struct glx_screen
*psc
,
805 struct glx_config
*mode
,
806 struct glx_context
*shareList
, int renderType
);
809 applegl_create_display(struct glx_display
*display
);
812 extern Bool
validate_renderType_against_config(const struct glx_config
*config
,
816 extern struct glx_drawable
*GetGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
817 extern int InitGLXDrawable(Display
*dpy
, struct glx_drawable
*glxDraw
,
818 XID xDrawable
, GLXDrawable drawable
);
819 extern void DestroyGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
821 extern struct glx_context dummyContext
;
823 extern struct glx_screen
*
824 indirect_create_screen(int screen
, struct glx_display
* priv
);
825 extern struct glx_context
*
826 indirect_create_context(struct glx_screen
*psc
,
827 struct glx_config
*mode
,
828 struct glx_context
*shareList
, int renderType
);
829 extern struct glx_context
*
830 indirect_create_context_attribs(struct glx_screen
*base
,
831 struct glx_config
*config_base
,
832 struct glx_context
*shareList
,
833 unsigned num_attribs
,
834 const uint32_t *attribs
,
841 #endif /* !__GLX_client_h__ */