2 ** License Applicability. Except to the extent portions of this file are
3 ** made subject to an alternative license as permitted in the SGI Free
4 ** Software License B, Version 1.1 (the "License"), the contents of this
5 ** file are subject only to the provisions of the License. You may not use
6 ** this file except in compliance with the License. You may obtain a copy
7 ** of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
8 ** Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:
10 ** http://oss.sgi.com/projects/FreeB
12 ** Note that, as provided in the License, the Software is distributed on an
13 ** "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
14 ** DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
15 ** CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
16 ** PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
18 ** Original Code. The Original Code is: OpenGL Sample Implementation,
19 ** Version 1.2.1, released January 26, 2000, developed by Silicon Graphics,
20 ** Inc. The Original Code is Copyright (c) 1991-2000 Silicon Graphics, Inc.
21 ** Copyright in any portions created by third parties is as indicated
22 ** elsewhere herein. All Rights Reserved.
24 ** Additional Notice Provisions: The application programming interfaces
25 ** established by SGI in conjunction with the Original Code are The
26 ** OpenGL(R) Graphics System: A Specification (Version 1.2.1), released
27 ** April 1, 1999; The OpenGL(R) Graphics System Utility Library (Version
28 ** 1.3), released November 4, 1998; and OpenGL(R) Graphics with the X
29 ** Window System(R) (Version 1.3), released October 19, 1998. This software
30 ** was created using the OpenGL(R) version 1.2.1 Sample Implementation
31 ** published by SGI, but has not been independently verified as being
32 ** compliant with the OpenGL(R) version 1.2.1 Specification.
34 /* $XFree86: xc/lib/GL/glx/glxclient.h,v 1.21 2004/02/09 23:46:31 alanh Exp $ */
38 * Direct rendering support added by Precision Insight, Inc.
40 * \author Kevin E. Martin <kevin@precisioninsight.com>
43 #ifndef _GLX_client_h_
44 #define _GLX_client_h_
47 #include <X11/Xproto.h>
48 #include <X11/Xlibint.h>
49 #define GLX_GLXEXT_PROTOTYPES
51 #include <GL/glxext.h>
58 #include "GL/glxint.h"
59 #include "GL/glxproto.h"
60 #include "GL/internal/glcore.h"
61 #include "glapitable.h"
62 #include "glxextensions.h"
64 #if defined( USE_XTHREADS )
65 # include <X11/Xthreads.h>
66 #elif defined( PTHREADS )
70 #define GLX_MAJOR_VERSION 1 /* current version numbers */
71 #define GLX_MINOR_VERSION 4
73 #define __GLX_MAX_TEXTURE_UNITS 32
75 typedef struct __GLXscreenConfigsRec __GLXscreenConfigs
;
76 typedef struct __GLXcontextRec __GLXcontext
;
77 typedef struct __GLXdrawableRec __GLXdrawable
;
78 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate
;
79 typedef struct _glapi_table __GLapi
;
81 /************************************************************************/
83 #ifdef GLX_DIRECT_RENDERING
85 #define containerOf(ptr, type, member) \
86 (type *)( (char *)ptr - offsetof(type,member) )
88 #include <GL/internal/dri_interface.h>
92 * Display dependent methods. This structure is initialized during the
93 * \c driCreateDisplay call.
95 struct __DRIdisplayRec
{
97 * Method to destroy the private DRI display data.
99 void (*destroyDisplay
)(Display
*dpy
, void *displayPrivate
);
102 * Opaque pointer to private per display direct rendering data.
103 * \c NULL if direct rendering is not supported on this display.
105 struct __DRIdisplayPrivateRec
*private;
108 * Array of pointers to methods to create and initialize the private DRI
111 PFNCREATENEWSCREENFUNC
* createNewScreen
;
116 ** We keep a linked list of these structures, one per DRI device driver.
118 struct __DRIdriverRec
{
122 PFNCREATENEWSCREENFUNC createNewScreenFunc
;
123 struct __DRIdriverRec
*next
;
127 ** Function to create and DRI display data and initialize the display
128 ** dependent methods.
130 extern void *driCreateDisplay(Display
*dpy
, __DRIdisplay
*pdisp
);
131 extern void driCreateScreen(__GLXscreenConfigs
*psc
, int screen
,
132 __GLXdisplayPrivate
*priv
);
134 extern __DRIdriver
*driGetDriver(Display
*dpy
, int scrNum
);
136 extern void DRI_glXUseXFont( Font font
, int first
, int count
, int listbase
);
139 ** Functions to obtain driver configuration information from a direct
140 ** rendering client application
142 extern const char *glXGetScreenDriver (Display
*dpy
, int scrNum
);
144 extern const char *glXGetDriverConfig (const char *driverName
);
146 extern Bool
__glXWindowExists(Display
*dpy
, GLXDrawable draw
);
150 /************************************************************************/
152 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
154 typedef struct __GLXpixelStoreModeRec
{
155 GLboolean swapEndian
;
164 } __GLXpixelStoreMode
;
167 typedef struct __GLXattributeRec
{
171 * Pixel storage state. Most of the pixel store mode state is kept
172 * here and used by the client code to manage the packing and
173 * unpacking of data sent to/received from the server.
175 __GLXpixelStoreMode storePack
, storeUnpack
;
178 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
181 GLboolean NoDrawArraysProtocol
;
184 * Vertex Array storage state. The vertex array component
185 * state is stored here and is used to manage the packing of
186 * DrawArrays data sent to the server.
188 struct array_state_vector
* array_state
;
191 typedef struct __GLXattributeMachineRec
{
192 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
193 __GLXattribute
**stackPointer
;
194 } __GLXattributeMachine
;
197 * GLX state that needs to be kept on the client. One of these records
198 * exist for each context that has been made current by this client.
200 struct __GLXcontextRec
{
202 * \name Drawing command buffer.
204 * Drawing commands are packed into this buffer before being sent as a
205 * single GLX protocol request. The buffer is sent when it overflows or
206 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
207 * in the buffer to be filled. \c limit is described above in the buffer
210 * Commands that require large amounts of data to be transfered will
211 * also use this buffer to hold a header that describes the large
214 * These must be the first 6 fields since they are static initialized
215 * in the dummy context in glxext.c
226 * The XID of this rendering context. When the context is created a
227 * new XID is allocated. This is set to None when the context is
228 * destroyed but is still current to some thread. In this case the
229 * context will be freed on next MakeCurrent.
234 * The XID of the \c shareList context.
242 __GLXscreenConfigs
*psc
;
245 * \c GL_TRUE if the context was created with ImportContext, which
246 * means the server-side context was created by another X client.
251 * The context tag returned by MakeCurrent when this context is made
252 * current. This tag is used to identify the context that a thread has
253 * current so that proper server context management can be done. It is
254 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
255 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
258 GLXContextTag currentContextTag
;
261 * \name Rendering mode
263 * The rendering mode is kept on the client as well as the server.
264 * When \c glRenderMode is called, the buffer associated with the
265 * previous rendering mode (feedback or select) is filled.
269 GLfloat
*feedbackBuf
;
274 * This is \c GL_TRUE if the pixel unpack modes are such that an image
275 * can be unpacked from the clients memory by just copying. It may
276 * still be true that the server will have to do some work. This
277 * just promises that a straight copy will fetch the correct bytes.
279 GLboolean fastImageUnpack
;
282 * Fill newImage with the unpacked form of \c oldImage getting it
283 * ready for transport to the server.
285 void (*fillImage
)(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
286 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
289 * Client side attribs.
291 __GLXattributeMachine attributes
;
294 * Client side error code. This is set when client side gl API
295 * routines need to set an error because of a bad enumerant or
296 * running out of memory, etc.
301 * Whether this context does direct rendering.
306 * \c dpy of current display for this context. Will be \c NULL if not
307 * current to any display, or if this is the "dummy context".
312 * The current drawable for this context. Will be None if this
313 * context is not current to any drawable. currentReadable is below.
315 GLXDrawable currentDrawable
;
318 * \name GL Constant Strings
320 * Constant strings that describe the server implementation
321 * These pertain to GL attributes, not to be confused with
322 * GLX versioning attributes.
332 * Record the dpy this context was created on for later freeing
337 * Maximum small render command size. This is the smaller of 64k and
338 * the size of the above buffer.
340 GLint maxSmallRenderCommandSize
;
343 * Major opcode for the extension. Copied here so a lookup isn't
349 * Pointer to the mode used to create this context.
351 const __GLcontextModes
* mode
;
353 #ifdef GLX_DIRECT_RENDERING
355 * Per context direct rendering interface functions and data.
357 __DRIcontext driContext
;
360 * XID for the server side drm_context_t
366 * The current read-drawable for this context. Will be None if this
367 * context is not current to any drawable.
369 * \since Internal API version 20030606.
371 GLXDrawable currentReadable
;
374 * Pointer to client-state data that is private to libGL. This is only
375 * used for indirect rendering contexts.
377 * No internal API version change was made for this change. Client-side
378 * drivers should NEVER use this data or even care that it exists.
380 void * client_state_private
;
383 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
388 * \name Raw server GL version
390 * True core GL version supported by the server. This is the raw value
391 * returned by the server, and it may not reflect what is actually
392 * supported (or reported) by the client-side library.
395 int server_major
; /**< Major version number. */
396 int server_minor
; /**< Minor version number. */
399 char gl_extension_bits
[ __GL_EXT_BYTES
];
402 #define __glXSetError(gc,code) \
403 if (!(gc)->error) { \
404 (gc)->error = code; \
407 extern void __glFreeAttributeState(__GLXcontext
*);
409 /************************************************************************/
412 * The size of the largest drawing command known to the implementation
413 * that will use the GLXRender GLX command. In this case it is
414 * \c glPolygonStipple.
416 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
419 * To keep the implementation fast, the code uses a "limit" pointer
420 * to determine when the drawing command buffer is too full to hold
421 * another fixed size command. This constant defines the amount of
422 * space that must always be available in the drawing command buffer
423 * at all times for the implementation to work. It is important that
424 * the number be just large enough, but not so large as to reduce the
425 * efficacy of the buffer. The "+32" is just to keep the code working
426 * in case somebody counts wrong.
428 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
431 * This implementation uses a smaller threshold for switching
432 * to the RenderLarge protocol than the protcol requires so that
433 * large copies don't occur.
435 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
438 * One of these records exists per screen of the display. It contains
439 * a pointer to the config data for that screen (if the screen supports GL).
441 struct __GLXscreenConfigsRec
{
443 * GLX extension string reported by the X-server.
445 const char *serverGLXexts
;
448 * GLX extension string to be reported to applications. This is the
449 * set of extensions that the application can actually use.
451 char *effectiveGLXexts
;
453 #ifdef GLX_DIRECT_RENDERING
455 * Per screen direct rendering interface functions and data.
457 __DRIscreen driScreen
;
458 __glxHashTable
*drawHash
;
462 #ifdef __DRI_COPY_SUB_BUFFER
463 __DRIcopySubBufferExtension
*copySubBuffer
;
466 #ifdef __DRI_SWAP_CONTROL
467 __DRIswapControlExtension
*swapControl
;
470 #ifdef __DRI_ALLOCATE
471 __DRIallocateExtension
*allocate
;
474 #ifdef __DRI_FRAME_TRACKING
475 __DRIframeTrackingExtension
*frameTracking
;
478 #ifdef __DRI_MEDIA_STREAM_COUNTER
479 __DRImediaStreamCounterExtension
*msc
;
485 * Linked list of glx visuals and fbconfigs for this screen.
487 __GLcontextModes
*visuals
, *configs
;
490 * Per-screen dynamic GLX extension tracking. The \c direct_support
491 * field only contains enough bits for 64 extensions. Should libGL
492 * ever need to track more than 64 GLX extensions, we can safely grow
493 * this field. The \c __GLXscreenConfigs structure is not used outside
497 unsigned char direct_support
[8];
498 GLboolean ext_list_first_time
;
504 * Per display private data. One of these records exists for each display
505 * that is using the OpenGL (GLX) extension.
507 struct __GLXdisplayPrivateRec
{
509 * Back pointer to the display
514 * The \c majorOpcode is common to all connections to the same server.
515 * It is also copied into the context structure.
520 * \name Server Version
522 * Major and minor version returned by the server during initialization.
525 int majorVersion
, minorVersion
;
529 * \name Storage for the servers GLX vendor and versions strings.
531 * These are the same for all screens on this display. These fields will
532 * be filled in on demand.
535 const char *serverGLXvendor
;
536 const char *serverGLXversion
;
540 * Configurations of visuals for all screens on this display.
541 * Also, per screen data which now includes the server \c GLX_EXTENSION
544 __GLXscreenConfigs
*screenConfigs
;
546 #ifdef GLX_DIRECT_RENDERING
548 * Per display direct rendering interface functions and data.
550 __DRIdisplay driDisplay
;
554 #ifdef GLX_DIRECT_RENDERING
556 struct __GLXdrawableRec
{
558 __GLXscreenConfigs
*psc
;
559 __DRIdrawable driDrawable
;
566 void __glXFreeContext(__GLXcontext
*);
568 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
570 extern void __glXSendLargeChunk(__GLXcontext
*gc
, GLint requestNumber
,
572 const GLvoid
* data
, GLint dataLen
);
574 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
575 const GLvoid
*, GLint
);
577 /* Initialize the GLX extension for dpy */
578 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
580 /************************************************************************/
582 extern int __glXDebug
;
584 /* This is per-thread storage in an MT environment */
585 #if defined( USE_XTHREADS ) || defined( PTHREADS )
587 extern void __glXSetCurrentContext(__GLXcontext
*c
);
589 # if defined( GLX_USE_TLS )
591 extern __thread
void * __glX_tls_Context
592 __attribute__((tls_model("initial-exec")));
594 # define __glXGetCurrentContext() __glX_tls_Context
598 extern __GLXcontext
*__glXGetCurrentContext(void);
600 # endif /* defined( GLX_USE_TLS ) */
604 extern __GLXcontext
*__glXcurrentContext
;
605 #define __glXGetCurrentContext() __glXcurrentContext
606 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
608 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
612 ** Global lock for all threads in this address space using the GLX
615 #if defined( USE_XTHREADS )
616 extern xmutex_rec __glXmutex
;
617 #define __glXLock() xmutex_lock(&__glXmutex)
618 #define __glXUnlock() xmutex_unlock(&__glXmutex)
619 #elif defined( PTHREADS )
620 extern pthread_mutex_t __glXmutex
;
621 #define __glXLock() pthread_mutex_lock(&__glXmutex)
622 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
625 #define __glXUnlock()
629 ** Setup for a command. Initialize the extension for dpy if necessary.
631 extern CARD8
__glXSetupForCommand(Display
*dpy
);
633 /************************************************************************/
636 ** Data conversion and packing support.
639 extern const GLuint __glXDefaultPixelStore
[9];
641 /* Send an image to the server using RenderLarge. */
642 extern void __glXSendLargeImage(__GLXcontext
*gc
, GLint compsize
, GLint dim
,
643 GLint width
, GLint height
, GLint depth
, GLenum format
, GLenum type
,
644 const GLvoid
*src
, GLubyte
*pc
, GLubyte
*modes
);
646 /* Return the size, in bytes, of some pixel data */
647 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
649 /* Return the number of elements per group of a specified format*/
650 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
652 /* Return the number of bytes per element, based on the element type (other
655 extern GLint
__glBytesPerElement(GLenum type
);
658 ** Fill the transport buffer with the data from the users buffer,
659 ** applying some of the pixel store modes (unpack modes) to the data
660 ** first. As a side effect of this call, the "modes" field is
661 ** updated to contain the modes needed by the server to decode the
664 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
665 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
667 /* Copy map data with a stride into a packed buffer */
668 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
669 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
670 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
671 const GLfloat
*, GLfloat
*);
672 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
673 const GLdouble
*, GLdouble
*);
676 ** Empty an image out of the reply buffer into the clients memory applying
677 ** the pack modes to pack back into the clients requested format.
679 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
680 GLenum
, const GLubyte
*, GLvoid
*);
684 ** Allocate and Initialize Vertex Array client state
686 extern void __glXInitVertexArrayState(__GLXcontext
*);
689 ** Inform the Server of the major and minor numbers and of the client
690 ** libraries extension string.
692 extern void __glXClientInfo ( Display
*dpy
, int opcode
);
694 /************************************************************************/
697 ** Declarations that should be in Xlib
699 #ifdef __GL_USE_OUR_PROTOTYPES
700 extern void _XFlush(Display
*);
701 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
702 extern void _XRead(Display
*, void*, long);
703 extern void _XSend(Display
*, const void*, long);
707 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes
*config
,
708 int count
, const INT32
*bp
, Bool tagged_only
, Bool fbconfig_style_tags
);
710 extern char * __glXGetStringFromServer( Display
* dpy
, int opcode
,
711 CARD32 glxCode
, CARD32 for_whom
, CARD32 name
);
713 extern char *__glXstrdup(const char *str
);
716 extern const char __glXGLClientVersion
[];
717 extern const char __glXGLClientExtensions
[];
719 /* Get the unadjusted system time */
720 extern int __glXGetUST( int64_t * ust
);
722 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
723 int32_t * numerator
, int32_t * denominator
);
725 #ifdef GLX_DIRECT_RENDERING
727 __driGetMscRateOML(__DRIdrawable
*draw
, int32_t *numerator
, int32_t *denominator
);
730 #endif /* !__GLX_client_h__ */