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_
42 #include <X11/Xproto.h>
43 #include <X11/Xlibint.h>
44 #define GLX_GLXEXT_PROTOTYPES
46 #include <GL/glxext.h>
53 #include "GL/glxint.h"
54 #include "GL/glxproto.h"
55 #include "GL/internal/glcore.h"
56 #include "glapi/glapitable.h"
58 #if defined( USE_XTHREADS )
59 # include <X11/Xthreads.h>
60 #elif defined( PTHREADS )
64 #include "glxextensions.h"
67 /* If we build the library with gcc's -fvisibility=hidden flag, we'll
68 * use the PUBLIC macro to mark functions that are to be exported.
70 * We also need to define a USED attribute, so the optimizer doesn't
71 * inline a static function that we later use in an alias. - ajax
73 #if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
74 # define PUBLIC __attribute__((visibility("default")))
75 # define USED __attribute__((used))
83 #define GLX_MAJOR_VERSION 1 /* current version numbers */
84 #define GLX_MINOR_VERSION 4
86 #define __GLX_MAX_TEXTURE_UNITS 32
88 typedef struct __GLXscreenConfigsRec __GLXscreenConfigs
;
89 typedef struct __GLXcontextRec __GLXcontext
;
90 typedef struct __GLXdrawableRec __GLXdrawable
;
91 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate
;
92 typedef struct _glapi_table __GLapi
;
94 /************************************************************************/
96 #ifdef GLX_DIRECT_RENDERING
98 #define containerOf(ptr, type, member) \
99 (type *)( (char *)ptr - offsetof(type,member) )
101 #include <GL/internal/dri_interface.h>
105 * Display dependent methods. This structure is initialized during the
106 * \c driCreateDisplay call.
108 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
109 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
110 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
111 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
113 #include "glxextensions.h"
115 struct __GLXDRIdisplayRec
{
117 * Method to destroy the private DRI display data.
119 void (*destroyDisplay
)(__GLXDRIdisplay
*display
);
121 __GLXDRIscreen
*(*createScreen
)(__GLXscreenConfigs
*psc
, int screen
,
122 __GLXdisplayPrivate
*priv
);
125 struct __GLXDRIscreenRec
{
127 void (*destroyScreen
)(__GLXscreenConfigs
*psc
);
129 __GLXDRIcontext
*(*createContext
)(__GLXscreenConfigs
*psc
,
130 const __GLcontextModes
*mode
,
132 GLXContext shareList
, int renderType
);
134 __GLXDRIdrawable
*(*createDrawable
)(__GLXscreenConfigs
*psc
,
136 GLXDrawable glxDrawable
,
137 const __GLcontextModes
*modes
);
139 void (*swapBuffers
)(__GLXDRIdrawable
*pdraw
);
140 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
141 int x
, int y
, int width
, int height
);
142 void (*waitX
)(__GLXDRIdrawable
*pdraw
);
143 void (*waitGL
)(__GLXDRIdrawable
*pdraw
);
146 struct __GLXDRIcontextRec
{
147 void (*destroyContext
)(__GLXDRIcontext
*context
, __GLXscreenConfigs
*psc
,
149 Bool (*bindContext
)(__GLXDRIcontext
*context
,
150 __GLXDRIdrawable
*pdraw
,
151 __GLXDRIdrawable
*pread
);
153 void (*unbindContext
)(__GLXDRIcontext
*context
);
156 struct __GLXDRIdrawableRec
{
157 void (*destroyDrawable
)(__GLXDRIdrawable
*drawable
);
161 __GLXscreenConfigs
*psc
;
162 GLenum textureTarget
;
163 __DRIdrawable
*driDrawable
;
164 GLenum textureFormat
; /* EXT_texture_from_pixmap support */
168 ** Function to create and DRI display data and initialize the display
169 ** dependent methods.
171 extern __GLXDRIdisplay
*driswCreateDisplay(Display
*dpy
);
172 extern __GLXDRIdisplay
*driCreateDisplay(Display
*dpy
);
173 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
*dpy
);
175 extern void DRI_glXUseXFont( Font font
, int first
, int count
, int listbase
);
178 ** Functions to obtain driver configuration information from a direct
179 ** rendering client application
181 extern const char *glXGetScreenDriver (Display
*dpy
, int scrNum
);
183 extern const char *glXGetDriverConfig (const char *driverName
);
187 /************************************************************************/
189 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
191 typedef struct __GLXpixelStoreModeRec
{
192 GLboolean swapEndian
;
201 } __GLXpixelStoreMode
;
204 typedef struct __GLXattributeRec
{
208 * Pixel storage state. Most of the pixel store mode state is kept
209 * here and used by the client code to manage the packing and
210 * unpacking of data sent to/received from the server.
212 __GLXpixelStoreMode storePack
, storeUnpack
;
215 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
218 GLboolean NoDrawArraysProtocol
;
221 * Vertex Array storage state. The vertex array component
222 * state is stored here and is used to manage the packing of
223 * DrawArrays data sent to the server.
225 struct array_state_vector
* array_state
;
228 typedef struct __GLXattributeMachineRec
{
229 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
230 __GLXattribute
**stackPointer
;
231 } __GLXattributeMachine
;
234 * GLX state that needs to be kept on the client. One of these records
235 * exist for each context that has been made current by this client.
237 struct __GLXcontextRec
{
239 * \name Drawing command buffer.
241 * Drawing commands are packed into this buffer before being sent as a
242 * single GLX protocol request. The buffer is sent when it overflows or
243 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
244 * in the buffer to be filled. \c limit is described above in the buffer
247 * Commands that require large amounts of data to be transfered will
248 * also use this buffer to hold a header that describes the large
251 * These must be the first 6 fields since they are static initialized
252 * in the dummy context in glxext.c
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 __GLXscreenConfigs
*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 * This is \c GL_TRUE if the pixel unpack modes are such that an image
312 * can be unpacked from the clients memory by just copying. It may
313 * still be true that the server will have to do some work. This
314 * just promises that a straight copy will fetch the correct bytes.
316 GLboolean fastImageUnpack
;
319 * Fill newImage with the unpacked form of \c oldImage getting it
320 * ready for transport to the server.
322 void (*fillImage
)(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
323 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
326 * Client side attribs.
328 __GLXattributeMachine attributes
;
331 * Client side error code. This is set when client side gl API
332 * routines need to set an error because of a bad enumerant or
333 * running out of memory, etc.
338 * Whether this context does direct rendering.
343 * \c dpy of current display for this context. Will be \c NULL if not
344 * current to any display, or if this is the "dummy context".
349 * The current drawable for this context. Will be None if this
350 * context is not current to any drawable. currentReadable is below.
352 GLXDrawable currentDrawable
;
355 * \name GL Constant Strings
357 * Constant strings that describe the server implementation
358 * These pertain to GL attributes, not to be confused with
359 * GLX versioning attributes.
369 * Record the dpy this context was created on for later freeing
374 * Maximum small render command size. This is the smaller of 64k and
375 * the size of the above buffer.
377 GLint maxSmallRenderCommandSize
;
380 * Major opcode for the extension. Copied here so a lookup isn't
386 * Pointer to the mode used to create this context.
388 const __GLcontextModes
* mode
;
390 #ifdef GLX_DIRECT_RENDERING
391 __GLXDRIcontext
*driContext
;
392 __DRIcontext
*__driContext
;
396 * The current read-drawable for this context. Will be None if this
397 * context is not current to any drawable.
399 * \since Internal API version 20030606.
401 GLXDrawable currentReadable
;
404 * Pointer to client-state data that is private to libGL. This is only
405 * used for indirect rendering contexts.
407 * No internal API version change was made for this change. Client-side
408 * drivers should NEVER use this data or even care that it exists.
410 void * client_state_private
;
413 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
418 * \name Raw server GL version
420 * True core GL version supported by the server. This is the raw value
421 * returned by the server, and it may not reflect what is actually
422 * supported (or reported) by the client-side library.
425 int server_major
; /**< Major version number. */
426 int server_minor
; /**< Minor version number. */
430 * Thread ID we're currently current in. Zero if none.
432 unsigned long thread_id
;
434 char gl_extension_bits
[ __GL_EXT_BYTES
];
437 #define __glXSetError(gc,code) \
438 if (!(gc)->error) { \
439 (gc)->error = code; \
442 extern void __glFreeAttributeState(__GLXcontext
*);
444 /************************************************************************/
447 * The size of the largest drawing command known to the implementation
448 * that will use the GLXRender GLX command. In this case it is
449 * \c glPolygonStipple.
451 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
454 * To keep the implementation fast, the code uses a "limit" pointer
455 * to determine when the drawing command buffer is too full to hold
456 * another fixed size command. This constant defines the amount of
457 * space that must always be available in the drawing command buffer
458 * at all times for the implementation to work. It is important that
459 * the number be just large enough, but not so large as to reduce the
460 * efficacy of the buffer. The "+32" is just to keep the code working
461 * in case somebody counts wrong.
463 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
466 * This implementation uses a smaller threshold for switching
467 * to the RenderLarge protocol than the protcol requires so that
468 * large copies don't occur.
470 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
473 * One of these records exists per screen of the display. It contains
474 * a pointer to the config data for that screen (if the screen supports GL).
476 struct __GLXscreenConfigsRec
{
478 * GLX extension string reported by the X-server.
480 const char *serverGLXexts
;
483 * GLX extension string to be reported to applications. This is the
484 * set of extensions that the application can actually use.
486 char *effectiveGLXexts
;
488 #ifdef GLX_DIRECT_RENDERING
490 * Per screen direct rendering interface functions and data.
492 __DRIscreen
*__driScreen
;
493 const __DRIcoreExtension
*core
;
494 const __DRIlegacyExtension
*legacy
;
495 const __DRIswrastExtension
*swrast
;
496 const __DRIdri2Extension
*dri2
;
497 __glxHashTable
*drawHash
;
502 __GLXDRIscreen
*driScreen
;
504 const __DRIconfig
** driver_configs
;
506 #ifdef __DRI_COPY_SUB_BUFFER
507 const __DRIcopySubBufferExtension
*driCopySubBuffer
;
510 #ifdef __DRI_SWAP_CONTROL
511 const __DRIswapControlExtension
*swapControl
;
514 #ifdef __DRI_ALLOCATE
515 const __DRIallocateExtension
*allocate
;
518 #ifdef __DRI_FRAME_TRACKING
519 const __DRIframeTrackingExtension
*frameTracking
;
522 #ifdef __DRI_MEDIA_STREAM_COUNTER
523 const __DRImediaStreamCounterExtension
*msc
;
526 #ifdef __DRI_TEX_BUFFER
527 const __DRItexBufferExtension
*texBuffer
;
531 const __DRI2flushExtension
*f
;
537 * Linked list of glx visuals and fbconfigs for this screen.
539 __GLcontextModes
*visuals
, *configs
;
542 * Per-screen dynamic GLX extension tracking. The \c direct_support
543 * field only contains enough bits for 64 extensions. Should libGL
544 * ever need to track more than 64 GLX extensions, we can safely grow
545 * this field. The \c __GLXscreenConfigs structure is not used outside
549 unsigned char direct_support
[8];
550 GLboolean ext_list_first_time
;
556 * Per display private data. One of these records exists for each display
557 * that is using the OpenGL (GLX) extension.
559 struct __GLXdisplayPrivateRec
{
561 * Back pointer to the display
566 * The \c majorOpcode is common to all connections to the same server.
567 * It is also copied into the context structure.
572 * \name Server Version
574 * Major and minor version returned by the server during initialization.
577 int majorVersion
, minorVersion
;
581 * \name Storage for the servers GLX vendor and versions strings.
583 * These are the same for all screens on this display. These fields will
584 * be filled in on demand.
587 const char *serverGLXvendor
;
588 const char *serverGLXversion
;
592 * Configurations of visuals for all screens on this display.
593 * Also, per screen data which now includes the server \c GLX_EXTENSION
596 __GLXscreenConfigs
*screenConfigs
;
598 #ifdef GLX_DIRECT_RENDERING
600 * Per display direct rendering interface functions and data.
602 __GLXDRIdisplay
*driswDisplay
;
603 __GLXDRIdisplay
*driDisplay
;
604 __GLXDRIdisplay
*dri2Display
;
609 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
611 extern void __glXSendLargeChunk(__GLXcontext
*gc
, GLint requestNumber
,
613 const GLvoid
* data
, GLint dataLen
);
615 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
616 const GLvoid
*, GLint
);
618 /* Initialize the GLX extension for dpy */
619 extern __GLXdisplayPrivate
*__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( USE_XTHREADS ) || defined( PTHREADS )
630 extern void __glXSetCurrentContext(__GLXcontext
*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 __GLXcontext
*__glXGetCurrentContext(void);
643 # endif /* defined( GLX_USE_TLS ) */
647 extern __GLXcontext
*__glXcurrentContext
;
648 #define __glXGetCurrentContext() __glXcurrentContext
649 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
651 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
653 extern void __glXSetCurrentContextNull(void);
655 extern void __glXFreeContext(__GLXcontext
*);
659 ** Global lock for all threads in this address space using the GLX
662 #if defined( USE_XTHREADS )
663 extern xmutex_rec __glXmutex
;
664 #define __glXLock() xmutex_lock(&__glXmutex)
665 #define __glXUnlock() xmutex_unlock(&__glXmutex)
666 #elif defined( PTHREADS )
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(__GLXcontext
*gc
, GLint compsize
, GLint dim
,
690 GLint width
, GLint height
, GLint depth
, GLenum format
, GLenum type
,
691 const GLvoid
*src
, GLubyte
*pc
, GLubyte
*modes
);
693 /* Return the size, in bytes, of some pixel data */
694 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
696 /* Return the number of elements per group of a specified format*/
697 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
699 /* Return the number of bytes per element, based on the element type (other
702 extern GLint
__glBytesPerElement(GLenum type
);
705 ** Fill the transport buffer with the data from the users buffer,
706 ** applying some of the pixel store modes (unpack modes) to the data
707 ** first. As a side effect of this call, the "modes" field is
708 ** updated to contain the modes needed by the server to decode the
711 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
712 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
714 /* Copy map data with a stride into a packed buffer */
715 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
716 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
717 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
718 const GLfloat
*, GLfloat
*);
719 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
720 const GLdouble
*, GLdouble
*);
723 ** Empty an image out of the reply buffer into the clients memory applying
724 ** the pack modes to pack back into the clients requested format.
726 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
727 GLenum
, const GLubyte
*, GLvoid
*);
731 ** Allocate and Initialize Vertex Array client state, and free.
733 extern void __glXInitVertexArrayState(__GLXcontext
*);
734 extern void __glXFreeVertexArrayState(__GLXcontext
*);
737 ** Inform the Server of the major and minor numbers and of the client
738 ** libraries extension string.
740 extern void __glXClientInfo ( Display
*dpy
, int opcode
);
742 /************************************************************************/
745 ** Declarations that should be in Xlib
747 #ifdef __GL_USE_OUR_PROTOTYPES
748 extern void _XFlush(Display
*);
749 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
750 extern void _XRead(Display
*, void*, long);
751 extern void _XSend(Display
*, const void*, long);
755 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes
*config
,
756 int count
, const INT32
*bp
, Bool tagged_only
, Bool fbconfig_style_tags
);
758 extern char * __glXQueryServerString(Display
* dpy
, int opcode
,
759 CARD32 screen
, CARD32 name
);
760 extern char * __glXGetString(Display
* dpy
, int opcode
,
761 CARD32 screen
, CARD32 name
);
763 extern char *__glXstrdup(const char *str
);
766 extern const char __glXGLClientVersion
[];
767 extern const char __glXGLClientExtensions
[];
769 /* Get the unadjusted system time */
770 extern int __glXGetUST( int64_t * ust
);
772 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
773 int32_t * numerator
, int32_t * denominator
);
775 #ifdef GLX_DIRECT_RENDERING
777 __driGetMscRateOML(__DRIdrawable
*draw
,
778 int32_t *numerator
, int32_t *denominator
, void *private);
781 #endif /* !__GLX_client_h__ */