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"
60 #define GLX_MAJOR_VERSION 1 /* current version numbers */
61 #define GLX_MINOR_VERSION 4
63 #define __GLX_MAX_TEXTURE_UNITS 32
68 /************************************************************************/
70 #ifdef GLX_DIRECT_RENDERING
72 extern void DRI_glXUseXFont(struct glx_context
*ctx
,
73 Font font
, int first
, int count
, int listbase
);
77 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
80 * Display dependent methods. This structure is initialized during the
81 * \c driCreateDisplay call.
83 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
84 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
85 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
87 struct __GLXDRIdisplayRec
90 * Method to destroy the private DRI display data.
92 void (*destroyDisplay
) (__GLXDRIdisplay
* display
);
94 struct glx_screen
*(*createScreen
)(int screen
, struct glx_display
* priv
);
97 struct __GLXDRIscreenRec
{
99 void (*destroyScreen
)(struct glx_screen
*psc
);
101 struct glx_context
*(*createContext
)(struct glx_screen
*psc
,
102 struct glx_config
*config
,
103 struct glx_context
*shareList
,
106 __GLXDRIdrawable
*(*createDrawable
)(struct glx_screen
*psc
,
108 GLXDrawable glxDrawable
,
109 struct glx_config
*config
);
111 int64_t (*swapBuffers
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
112 int64_t divisor
, int64_t remainder
, Bool flush
);
113 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
114 int x
, int y
, int width
, int height
, Bool flush
);
115 int (*getDrawableMSC
)(struct glx_screen
*psc
, __GLXDRIdrawable
*pdraw
,
116 int64_t *ust
, int64_t *msc
, int64_t *sbc
);
117 int (*waitForMSC
)(__GLXDRIdrawable
*pdraw
, int64_t target_msc
,
118 int64_t divisor
, int64_t remainder
, int64_t *ust
,
119 int64_t *msc
, int64_t *sbc
);
120 int (*waitForSBC
)(__GLXDRIdrawable
*pdraw
, int64_t target_sbc
, int64_t *ust
,
121 int64_t *msc
, int64_t *sbc
);
122 int (*setSwapInterval
)(__GLXDRIdrawable
*pdraw
, int interval
);
123 int (*getSwapInterval
)(__GLXDRIdrawable
*pdraw
);
124 int (*getBufferAge
)(__GLXDRIdrawable
*pdraw
);
127 struct __GLXDRIdrawableRec
129 void (*destroyDrawable
) (__GLXDRIdrawable
* drawable
);
133 struct glx_screen
*psc
;
134 GLenum textureTarget
;
135 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
136 unsigned long eventMask
;
141 ** Function to create and DRI display data and initialize the display
142 ** dependent methods.
144 extern __GLXDRIdisplay
*driswCreateDisplay(Display
* dpy
);
145 extern __GLXDRIdisplay
*driCreateDisplay(Display
* dpy
);
146 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
* dpy
);
147 extern void dri2InvalidateBuffers(Display
*dpy
, XID drawable
);
148 extern unsigned dri2GetSwapEventType(Display
*dpy
, XID drawable
);
150 extern __GLXDRIdisplay
*dri3_create_display(Display
* dpy
);
153 ** Functions to obtain driver configuration information from a direct
154 ** rendering client application
156 extern const char *glXGetScreenDriver(Display
* dpy
, int scrNum
);
158 extern const char *glXGetDriverConfig(const char *driverName
);
162 /************************************************************************/
164 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
166 typedef struct __GLXpixelStoreModeRec
168 GLboolean swapEndian
;
177 } __GLXpixelStoreMode
;
180 typedef struct __GLXattributeRec
185 * Pixel storage state. Most of the pixel store mode state is kept
186 * here and used by the client code to manage the packing and
187 * unpacking of data sent to/received from the server.
189 __GLXpixelStoreMode storePack
, storeUnpack
;
192 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
195 GLboolean NoDrawArraysProtocol
;
198 * Vertex Array storage state. The vertex array component
199 * state is stored here and is used to manage the packing of
200 * DrawArrays data sent to the server.
202 struct array_state_vector
*array_state
;
205 typedef struct __GLXattributeMachineRec
207 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
208 __GLXattribute
**stackPointer
;
209 } __GLXattributeMachine
;
211 typedef struct _mesa_glinterop_device_info mesa_glinterop_device_info
;
212 typedef struct _mesa_glinterop_export_in mesa_glinterop_export_in
;
213 typedef struct _mesa_glinterop_export_out mesa_glinterop_export_out
;
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
);
229 int (*interop_query_device_info
)(struct glx_context
*ctx
,
230 mesa_glinterop_device_info
*out
);
231 int (*interop_export_object
)(struct glx_context
*ctx
,
232 const mesa_glinterop_export_in
*in
,
233 mesa_glinterop_export_out
*out
);
237 * GLX state that needs to be kept on the client. One of these records
238 * exist for each context that has been made current by this client.
243 * \name Drawing command buffer.
245 * Drawing commands are packed into this buffer before being sent as a
246 * single GLX protocol request. The buffer is sent when it overflows or
247 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
248 * in the buffer to be filled. \c limit is described above in the buffer
251 * Commands that require large amounts of data to be transfered will
252 * also use this buffer to hold a header that describes the large
255 * These must be the first 6 fields since they are static initialized
256 * in the dummy context in glxext.c
266 const struct glx_context_vtable
*vtable
;
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 * Fill newImage with the unpacked form of \c oldImage getting it
318 * ready for transport to the server.
320 void (*fillImage
) (struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
321 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
324 * Client side attribs.
326 __GLXattributeMachine attributes
;
329 * Client side error code. This is set when client side gl API
330 * routines need to set an error because of a bad enumerant or
331 * running out of memory, etc.
336 * Whether this context does direct rendering.
340 #if defined(GLX_DIRECT_RENDERING) && defined(GLX_USE_APPLEGL)
345 * \c dpy of current display for this context. Will be \c NULL if not
346 * current to any display, or if this is the "dummy context".
351 * The current drawable for this context. Will be None if this
352 * context is not current to any drawable. currentReadable is below.
354 GLXDrawable currentDrawable
;
357 * \name GL Constant Strings
359 * Constant strings that describe the server implementation
360 * These pertain to GL attributes, not to be confused with
361 * GLX versioning attributes.
371 * Maximum small render command size. This is the smaller of 64k and
372 * the size of the above buffer.
374 GLint maxSmallRenderCommandSize
;
377 * Major opcode for the extension. Copied here so a lookup isn't
383 * Pointer to the config used to create this context.
385 struct glx_config
*config
;
388 * The current read-drawable for this context. Will be None if this
389 * context is not current to any drawable.
391 * \since Internal API version 20030606.
393 GLXDrawable currentReadable
;
396 * Pointer to client-state data that is private to libGL. This is only
397 * used for indirect rendering contexts.
399 * No internal API version change was made for this change. Client-side
400 * drivers should NEVER use this data or even care that it exists.
402 void *client_state_private
;
405 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
410 * \name Raw server GL version
412 * True core GL version supported by the server. This is the raw value
413 * returned by the server, and it may not reflect what is actually
414 * supported (or reported) by the client-side library.
417 int server_major
; /**< Major version number. */
418 int server_minor
; /**< Minor version number. */
422 * Number of threads we're currently current in.
424 unsigned long thread_refcount
;
426 char gl_extension_bits
[__GL_EXT_BYTES
];
430 glx_context_init(struct glx_context
*gc
,
431 struct glx_screen
*psc
, struct glx_config
*fbconfig
);
433 #define __glXSetError(gc,code) \
434 if (!(gc)->error) { \
435 (gc)->error = code; \
438 extern void __glFreeAttributeState(struct glx_context
*);
440 /************************************************************************/
443 * The size of the largest drawing command known to the implementation
444 * that will use the GLXRender GLX command. In this case it is
445 * \c glPolygonStipple.
447 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
450 * To keep the implementation fast, the code uses a "limit" pointer
451 * to determine when the drawing command buffer is too full to hold
452 * another fixed size command. This constant defines the amount of
453 * space that must always be available in the drawing command buffer
454 * at all times for the implementation to work. It is important that
455 * the number be just large enough, but not so large as to reduce the
456 * efficacy of the buffer. The "+32" is just to keep the code working
457 * in case somebody counts wrong.
459 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
462 * This implementation uses a smaller threshold for switching
463 * to the RenderLarge protocol than the protcol requires so that
464 * large copies don't occur.
466 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
469 * One of these records exists per screen of the display. It contains
470 * a pointer to the config data for that screen (if the screen supports GL).
472 struct glx_screen_vtable
{
473 struct glx_context
*(*create_context
)(struct glx_screen
*psc
,
474 struct glx_config
*config
,
475 struct glx_context
*shareList
,
478 struct glx_context
*(*create_context_attribs
)(struct glx_screen
*psc
,
479 struct glx_config
*config
,
480 struct glx_context
*shareList
,
482 const uint32_t *attribs
,
484 int (*query_renderer_integer
)(struct glx_screen
*psc
,
486 unsigned int *value
);
487 int (*query_renderer_string
)(struct glx_screen
*psc
,
494 const struct glx_screen_vtable
*vtable
;
497 * GLX extension string reported by the X-server.
499 const char *serverGLXexts
;
502 * GLX extension string to be reported to applications. This is the
503 * set of extensions that the application can actually use.
505 char *effectiveGLXexts
;
507 struct glx_display
*display
;
512 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
514 * Per screen direct rendering interface functions and data.
516 __GLXDRIscreen
*driScreen
;
520 * Linked list of glx visuals and fbconfigs for this screen.
522 struct glx_config
*visuals
, *configs
;
525 * Per-screen dynamic GLX extension tracking. The \c direct_support
526 * field only contains enough bits for 64 extensions. Should libGL
527 * ever need to track more than 64 GLX extensions, we can safely grow
528 * this field. The \c struct glx_screen structure is not used outside
532 unsigned char direct_support
[8];
533 GLboolean ext_list_first_time
;
539 * Per display private data. One of these records exists for each display
540 * that is using the OpenGL (GLX) extension.
544 /* The extension protocol codes */
546 struct glx_display
*next
;
549 * Back pointer to the display
554 * The \c majorOpcode is common to all connections to the same server.
555 * It is also copied into the context structure.
560 * \name Server Version
562 * Major and minor version returned by the server during initialization.
565 int majorVersion
, minorVersion
;
569 * \name Storage for the servers GLX vendor and versions strings.
571 * These are the same for all screens on this display. These fields will
572 * be filled in on demand.
575 const char *serverGLXvendor
;
576 const char *serverGLXversion
;
580 * Configurations of visuals for all screens on this display.
581 * Also, per screen data which now includes the server \c GLX_EXTENSION
584 struct glx_screen
**screens
;
586 __glxHashTable
*glXDrawHash
;
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
;
597 __GLXDRIdisplay
*dri3Display
;
601 struct glx_drawable
{
605 uint32_t lastEventSbc
;
606 int64_t eventSbcWrap
;
610 glx_screen_init(struct glx_screen
*psc
,
611 int screen
, struct glx_display
* priv
);
613 glx_screen_cleanup(struct glx_screen
*psc
);
615 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
616 extern __GLXDRIdrawable
*
617 dri2GetGlxDrawableFromXDrawableId(Display
*dpy
, XID id
);
620 extern GLubyte
*__glXFlushRenderBuffer(struct glx_context
*, GLubyte
*);
622 extern void __glXSendLargeChunk(struct glx_context
* gc
, GLint requestNumber
,
624 const GLvoid
* data
, GLint dataLen
);
626 extern void __glXSendLargeCommand(struct glx_context
*, const GLvoid
*, GLint
,
627 const GLvoid
*, GLint
);
629 /* Initialize the GLX extension for dpy */
630 extern struct glx_display
*__glXInitialize(Display
*);
632 extern void __glXPreferEGL(int state
);
634 /************************************************************************/
636 extern int __glXDebug
;
638 /* This is per-thread storage in an MT environment */
640 extern void __glXSetCurrentContext(struct glx_context
* c
);
642 # if defined( GLX_USE_TLS )
644 extern __thread
void *__glX_tls_Context
645 __attribute__ ((tls_model("initial-exec")));
647 # define __glXGetCurrentContext() __glX_tls_Context
651 extern struct glx_context
*__glXGetCurrentContext(void);
653 # endif /* defined( GLX_USE_TLS ) */
655 extern void __glXSetCurrentContextNull(void);
659 ** Global lock for all threads in this address space using the GLX
662 extern pthread_mutex_t __glXmutex
;
663 #define __glXLock() pthread_mutex_lock(&__glXmutex)
664 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
667 ** Setup for a command. Initialize the extension for dpy if necessary.
669 extern CARD8
__glXSetupForCommand(Display
* dpy
);
671 /************************************************************************/
674 ** Data conversion and packing support.
677 extern const GLuint __glXDefaultPixelStore
[9];
679 /* Send an image to the server using RenderLarge. */
680 extern void __glXSendLargeImage(struct glx_context
* gc
, GLint compsize
, GLint dim
,
681 GLint width
, GLint height
, GLint depth
,
682 GLenum format
, GLenum type
,
683 const GLvoid
* src
, GLubyte
* pc
,
686 /* Return the size, in bytes, of some pixel data */
687 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
689 /* Return the number of elements per group of a specified format*/
690 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
692 /* Return the number of bytes per element, based on the element type (other
695 extern GLint
__glBytesPerElement(GLenum type
);
698 ** Fill the transport buffer with the data from the users buffer,
699 ** applying some of the pixel store modes (unpack modes) to the data
700 ** first. As a side effect of this call, the "modes" field is
701 ** updated to contain the modes needed by the server to decode the
704 extern void __glFillImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
705 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
707 /* Copy map data with a stride into a packed buffer */
708 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
709 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
710 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
711 const GLfloat
*, GLfloat
*);
712 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
713 const GLdouble
*, GLdouble
*);
716 ** Empty an image out of the reply buffer into the clients memory applying
717 ** the pack modes to pack back into the clients requested format.
719 extern void __glEmptyImage(struct glx_context
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
720 GLenum
, const GLubyte
*, GLvoid
*);
724 ** Allocate and Initialize Vertex Array client state, and free.
726 extern void __glXInitVertexArrayState(struct glx_context
*);
727 extern void __glXFreeVertexArrayState(struct glx_context
*);
730 ** Inform the Server of the major and minor numbers and of the client
731 ** libraries extension string.
733 extern void __glXClientInfo(Display
* dpy
, int opcode
);
736 __glX_send_client_info(struct glx_display
*glx_dpy
);
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 const char __glXGLClientVersion
[];
762 extern const char __glXGLClientExtensions
[];
764 /* Get the unadjusted system time */
765 extern int __glXGetUST(int64_t * ust
);
767 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
769 int32_t * denominator
);
771 #if defined(GLX_DIRECT_RENDERING) && !defined(GLX_USE_APPLEGL)
773 __glxGetMscRate(struct glx_screen
*psc
,
774 int32_t * numerator
, int32_t * denominator
);
776 /* So that dri2.c:DRI2WireToEvent() can access
777 * glx_info->codes->first_event */
778 XExtDisplayInfo
*__glXFindDisplay (Display
*dpy
);
781 GarbageCollectDRIDrawables(struct glx_screen
*psc
);
783 extern __GLXDRIdrawable
*
784 GetGLXDRIDrawable(Display
*dpy
, GLXDrawable drawable
);
787 extern struct glx_screen
*GetGLXScreenConfigs(Display
* dpy
, int scrn
);
789 #ifdef GLX_USE_APPLEGL
790 extern struct glx_screen
*
791 applegl_create_screen(int screen
, struct glx_display
* priv
);
793 extern struct glx_context
*
794 applegl_create_context(struct glx_screen
*psc
,
795 struct glx_config
*mode
,
796 struct glx_context
*shareList
, int renderType
);
799 applegl_create_display(struct glx_display
*display
);
802 extern Bool
validate_renderType_against_config(const struct glx_config
*config
,
806 extern struct glx_drawable
*GetGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
807 extern int InitGLXDrawable(Display
*dpy
, struct glx_drawable
*glxDraw
,
808 XID xDrawable
, GLXDrawable drawable
);
809 extern void DestroyGLXDrawable(Display
*dpy
, GLXDrawable drawable
);
811 extern struct glx_context dummyContext
;
813 extern struct glx_screen
*
814 indirect_create_screen(int screen
, struct glx_display
* priv
);
815 extern struct glx_context
*
816 indirect_create_context(struct glx_screen
*psc
,
817 struct glx_config
*mode
,
818 struct glx_context
*shareList
, int renderType
);
819 extern struct glx_context
*
820 indirect_create_context_attribs(struct glx_screen
*base
,
821 struct glx_config
*config_base
,
822 struct glx_context
*shareList
,
823 unsigned num_attribs
,
824 const uint32_t *attribs
,
827 #endif /* !__GLX_client_h__ */