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"
63 #if defined( XTHREADS )
64 # include "Xthreads.h"
65 #elif defined( PTHREADS )
69 #define GLX_MAJOR_VERSION 1 /* current version numbers */
70 #define GLX_MINOR_VERSION 4
72 #define __GLX_MAX_TEXTURE_UNITS 32
74 typedef struct __GLXcontextRec __GLXcontext
;
75 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate
;
76 typedef struct _glapi_table __GLapi
;
78 /************************************************************************/
80 #ifdef GLX_DIRECT_RENDERING
82 #include <GL/internal/dri_interface.h>
86 * Display dependent methods. This structure is initialized during the
87 * \c driCreateDisplay call.
89 struct __DRIdisplayRec
{
91 * Method to destroy the private DRI display data.
93 void (*destroyDisplay
)(Display
*dpy
, void *displayPrivate
);
96 * Opaque pointer to private per display direct rendering data.
97 * \c NULL if direct rendering is not supported on this display.
99 struct __DRIdisplayPrivateRec
*private;
102 * Array of pointers to methods to create and initialize the private DRI
105 PFNCREATENEWSCREENFUNC
* createNewScreen
;
110 ** We keep a linked list of these structures, one per DRI device driver.
112 struct __DRIdriverRec
{
115 PFNCREATENEWSCREENFUNC createNewScreenFunc
;
116 struct __DRIdriverRec
*next
;
120 ** Function to create and DRI display data and initialize the display
121 ** dependent methods.
123 extern void *driCreateDisplay(Display
*dpy
, __DRIdisplay
*pdisp
);
125 extern __DRIdriver
*driGetDriver(Display
*dpy
, int scrNum
);
127 extern void DRI_glXUseXFont( Font font
, int first
, int count
, int listbase
);
130 ** Functions to obtain driver configuration information from a direct
131 ** rendering client application
133 extern const char *glXGetScreenDriver (Display
*dpy
, int scrNum
);
135 extern const char *glXGetDriverConfig (const char *driverName
);
137 extern Bool
__glXWindowExists(Display
*dpy
, GLXDrawable draw
);
141 /************************************************************************/
143 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
145 typedef struct __GLXpixelStoreModeRec
{
146 GLboolean swapEndian
;
155 } __GLXpixelStoreMode
;
157 /* The next 3 structures are deprecated. Client state is no longer tracked
158 * using them. They only remain to maintain the layout / structure offset of
159 * __GLXcontextRec. In XFree86 5.0 they will be removed altogether.
162 typedef struct __GLXvertexArrayPointerStateRecDEPRECATED
{
164 void (*proc
)(const void *);
170 } __GLXvertexArrayPointerStateDEPRECATED
;
172 typedef struct __GLXvertArrayStateRecDEPRECATED
{
173 __GLXvertexArrayPointerStateDEPRECATED vertex
;
174 __GLXvertexArrayPointerStateDEPRECATED normal
;
175 __GLXvertexArrayPointerStateDEPRECATED color
;
176 __GLXvertexArrayPointerStateDEPRECATED index
;
177 __GLXvertexArrayPointerStateDEPRECATED texCoord
[__GLX_MAX_TEXTURE_UNITS
];
178 __GLXvertexArrayPointerStateDEPRECATED edgeFlag
;
179 GLint maxElementsVertices
;
180 GLint maxElementsIndices
;
182 } __GLXvertArrayStateDEPRECATED
;
184 typedef struct __GLXattributeRecDEPRECATED
{
188 ** Pixel storage state. Most of the pixel store mode state is kept
189 ** here and used by the client code to manage the packing and
190 ** unpacking of data sent to/received from the server.
192 __GLXpixelStoreMode storePack
, storeUnpack
;
195 ** Vertex Array storage state. The vertex array component
196 ** state is stored here and is used to manage the packing of
197 ** DrawArrays data sent to the server.
199 __GLXvertArrayStateDEPRECATED vertArray
;
200 } __GLXattributeDEPRECATED
;
203 typedef struct __GLXattributeRec
{
207 * Pixel storage state. Most of the pixel store mode state is kept
208 * here and used by the client code to manage the packing and
209 * unpacking of data sent to/received from the server.
211 __GLXpixelStoreMode storePack
, storeUnpack
;
214 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
217 GLboolean NoDrawArraysProtocol
;
220 * Vertex Array storage state. The vertex array component
221 * state is stored here and is used to manage the packing of
222 * DrawArrays data sent to the server.
224 struct array_state_vector
* array_state
;
227 typedef struct __GLXattributeMachineRec
{
228 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
229 __GLXattribute
**stackPointer
;
230 } __GLXattributeMachine
;
233 * GLX state that needs to be kept on the client. One of these records
234 * exist for each context that has been made current by this client.
236 struct __GLXcontextRec
{
238 * \name Drawing command buffer.
240 * Drawing commands are packed into this buffer before being sent as a
241 * single GLX protocol request. The buffer is sent when it overflows or
242 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
243 * in the buffer to be filled. \c limit is described above in the buffer
246 * Commands that require large amounts of data to be transfered will
247 * also use this buffer to hold a header that describes the large
250 * These must be the first 6 fields since they are static initialized
251 * in the dummy context in glxext.c
262 * The XID of this rendering context. When the context is created a
263 * new XID is allocated. This is set to None when the context is
264 * destroyed but is still current to some thread. In this case the
265 * context will be freed on next MakeCurrent.
270 * The XID of the \c shareList context.
278 * This filed has been largely been replaced by the \c mode field, but
279 * the work is not quite done.
289 * \c GL_TRUE if the context was created with ImportContext, which
290 * means the server-side context was created by another X client.
295 * The context tag returned by MakeCurrent when this context is made
296 * current. This tag is used to identify the context that a thread has
297 * current so that proper server context management can be done. It is
298 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
299 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
302 GLXContextTag currentContextTag
;
305 * \name Rendering mode
307 * The rendering mode is kept on the client as well as the server.
308 * When \c glRenderMode is called, the buffer associated with the
309 * previous rendering mode (feedback or select) is filled.
313 GLfloat
*feedbackBuf
;
318 * This is \c GL_TRUE if the pixel unpack modes are such that an image
319 * can be unpacked from the clients memory by just copying. It may
320 * still be true that the server will have to do some work. This
321 * just promises that a straight copy will fetch the correct bytes.
323 GLboolean fastImageUnpack
;
326 * Fill newImage with the unpacked form of \c oldImage getting it
327 * ready for transport to the server.
329 void (*fillImage
)(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
330 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
333 * \name Client side attribs.
336 __GLXattributeDEPRECATED stateDEPRECATED
;
337 __GLXattributeMachine attributes
;
341 * Client side error code. This is set when client side gl API
342 * routines need to set an error because of a bad enumerant or
343 * running out of memory, etc.
348 * Whether this context does direct rendering.
353 * \c dpy of current display for this context. Will be \c NULL if not
354 * current to any display, or if this is the "dummy context".
359 * The current drawable for this context. Will be None if this
360 * context is not current to any drawable. currentReadable is below.
362 GLXDrawable currentDrawable
;
365 * \name GL Constant Strings
367 * Constant strings that describe the server implementation
368 * These pertain to GL attributes, not to be confused with
369 * GLX versioning attributes.
379 * Record the dpy this context was created on for later freeing
384 * Maximum small render command size. This is the smaller of 64k and
385 * the size of the above buffer.
387 GLint maxSmallRenderCommandSize
;
390 * Major opcode for the extension. Copied here so a lookup isn't
395 #ifdef GLX_DIRECT_RENDERING
397 * Per context direct rendering interface functions and data.
399 __DRIcontext driContext
;
403 * \c GLXFBConfigID used to create this context. May be \c None. This
404 * field has been replaced by the \c mode field.
406 * \since Internal API version 20030317.
409 * This filed has been largely been replaced by the \c mode field, but
410 * the work is not quite done.
412 GLXFBConfigID fbconfigID
;
415 * The current read-drawable for this context. Will be None if this
416 * context is not current to any drawable.
418 * \since Internal API version 20030606.
420 GLXDrawable currentReadable
;
423 * Pointer to client-state data that is private to libGL. This is only
424 * used for indirect rendering contexts.
426 * No internal API version change was made for this change. Client-side
427 * drivers should NEVER use this data or even care that it exists.
429 void * client_state_private
;
432 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
437 * \name Raw server GL version
439 * True core GL version supported by the server. This is the raw value
440 * returned by the server, and it may not reflect what is actually
441 * supported (or reported) by the client-side library.
444 int server_major
; /**< Major version number. */
445 int server_minor
; /**< Minor version number. */
448 char gl_extension_bits
[ __GL_EXT_BYTES
];
451 #define __glXSetError(gc,code) \
452 if (!(gc)->error) { \
453 (gc)->error = code; \
456 extern void __glFreeAttributeState(__GLXcontext
*);
458 /************************************************************************/
461 * The size of the largest drawing command known to the implementation
462 * that will use the GLXRender GLX command. In this case it is
463 * \c glPolygonStipple.
465 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
468 * To keep the implementation fast, the code uses a "limit" pointer
469 * to determine when the drawing command buffer is too full to hold
470 * another fixed size command. This constant defines the amount of
471 * space that must always be available in the drawing command buffer
472 * at all times for the implementation to work. It is important that
473 * the number be just large enough, but not so large as to reduce the
474 * efficacy of the buffer. The "+32" is just to keep the code working
475 * in case somebody counts wrong.
477 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
480 * This implementation uses a smaller threshold for switching
481 * to the RenderLarge protocol than the protcol requires so that
482 * large copies don't occur.
484 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
487 * One of these records exists per screen of the display. It contains
488 * a pointer to the config data for that screen (if the screen supports GL).
490 typedef struct __GLXscreenConfigsRec
{
492 * GLX extension string reported by the X-server.
494 const char *serverGLXexts
;
497 * GLX extension string to be reported to applications. This is the
498 * set of extensions that the application can actually use.
500 char *effectiveGLXexts
;
502 #ifdef GLX_DIRECT_RENDERING
504 * Per screen direct rendering interface functions and data.
506 __DRIscreen driScreen
;
510 * Linked list of configurations for this screen.
512 __GLcontextModes
*configs
;
515 * Per-screen dynamic GLX extension tracking. The \c direct_support
516 * field only contains enough bits for 64 extensions. Should libGL
517 * ever need to track more than 64 GLX extensions, we can safely grow
518 * this field. The \c __GLXscreenConfigs structure is not used outside
522 unsigned char direct_support
[8];
523 GLboolean ext_list_first_time
;
526 } __GLXscreenConfigs
;
529 * Per display private data. One of these records exists for each display
530 * that is using the OpenGL (GLX) extension.
532 struct __GLXdisplayPrivateRec
{
534 * Back pointer to the display
539 * The \c majorOpcode is common to all connections to the same server.
540 * It is also copied into the context structure.
545 * \name Server Version
547 * Major and minor version returned by the server during initialization.
550 int majorVersion
, minorVersion
;
554 * \name Storage for the servers GLX vendor and versions strings.
556 * These are the same for all screens on this display. These fields will
557 * be filled in on demand.
560 const char *serverGLXvendor
;
561 const char *serverGLXversion
;
565 * Configurations of visuals for all screens on this display.
566 * Also, per screen data which now includes the server \c GLX_EXTENSION
569 __GLXscreenConfigs
*screenConfigs
;
571 #ifdef GLX_DIRECT_RENDERING
573 * Per display direct rendering interface functions and data.
575 __DRIdisplay driDisplay
;
579 void __glXFreeContext(__GLXcontext
*);
581 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
583 extern void __glXSendLargeChunk(__GLXcontext
*gc
, GLint requestNumber
,
585 const GLvoid
* data
, GLint dataLen
);
587 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
588 const GLvoid
*, GLint
);
590 /* Initialize the GLX extension for dpy */
591 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
593 /************************************************************************/
595 extern int __glXDebug
;
597 /* This is per-thread storage in an MT environment */
598 #if defined( XTHREADS ) || defined( PTHREADS )
600 extern void __glXSetCurrentContext(__GLXcontext
*c
);
602 # if defined( GLX_USE_TLS )
604 extern __thread
void * __glX_tls_Context
605 __attribute__((tls_model("initial-exec")));
607 # define __glXGetCurrentContext() __glX_tls_Context
611 extern __GLXcontext
*__glXGetCurrentContext(void);
613 # endif /* defined( GLX_USE_TLS ) */
617 extern __GLXcontext
*__glXcurrentContext
;
618 #define __glXGetCurrentContext() __glXcurrentContext
619 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
621 #endif /* defined( XTHREADS ) || defined( PTHREADS ) */
625 ** Global lock for all threads in this address space using the GLX
628 #if defined( XTHREADS )
629 extern xmutex_rec __glXmutex
;
630 #define __glXLock() xmutex_lock(&__glXmutex)
631 #define __glXUnlock() xmutex_unlock(&__glXmutex)
632 #elif defined( PTHREADS )
633 extern pthread_mutex_t __glXmutex
;
634 #define __glXLock() pthread_mutex_lock(&__glXmutex)
635 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
638 #define __glXUnlock()
642 ** Setup for a command. Initialize the extension for dpy if necessary.
644 extern CARD8
__glXSetupForCommand(Display
*dpy
);
646 /************************************************************************/
649 ** Data conversion and packing support.
652 extern const GLuint __glXDefaultPixelStore
[9];
654 /* Send an image to the server using RenderLarge. */
655 extern void __glXSendLargeImage(__GLXcontext
*gc
, GLint compsize
, GLint dim
,
656 GLint width
, GLint height
, GLint depth
, GLenum format
, GLenum type
,
657 const GLvoid
*src
, GLubyte
*pc
, GLubyte
*modes
);
659 /* Return the size, in bytes, of some pixel data */
660 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
662 /* Return the number of elements per group of a specified format*/
663 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
665 /* Return the number of bytes per element, based on the element type (other
668 extern GLint
__glBytesPerElement(GLenum type
);
671 ** Fill the transport buffer with the data from the users buffer,
672 ** applying some of the pixel store modes (unpack modes) to the data
673 ** first. As a side effect of this call, the "modes" field is
674 ** updated to contain the modes needed by the server to decode the
677 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
678 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
680 /* Copy map data with a stride into a packed buffer */
681 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
682 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
683 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
684 const GLfloat
*, GLfloat
*);
685 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
686 const GLdouble
*, GLdouble
*);
689 ** Empty an image out of the reply buffer into the clients memory applying
690 ** the pack modes to pack back into the clients requested format.
692 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
693 GLenum
, const GLubyte
*, GLvoid
*);
697 ** Allocate and Initialize Vertex Array client state
699 extern void __glXInitVertexArrayState(__GLXcontext
*);
702 ** Inform the Server of the major and minor numbers and of the client
703 ** libraries extension string.
705 extern void __glXClientInfo ( Display
*dpy
, int opcode
);
707 /************************************************************************/
710 ** Declarations that should be in Xlib
712 #ifdef __GL_USE_OUR_PROTOTYPES
713 extern void _XFlush(Display
*);
714 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
715 extern void _XRead(Display
*, void*, long);
716 extern void _XSend(Display
*, const void*, long);
720 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes
*config
,
721 int count
, const INT32
*bp
, Bool tagged_only
, Bool fbconfig_style_tags
);
723 extern char * __glXGetStringFromServer( Display
* dpy
, int opcode
,
724 CARD32 glxCode
, CARD32 for_whom
, CARD32 name
);
726 extern char *__glXstrdup(const char *str
);
729 extern const char __glXGLClientVersion
[];
730 extern const char __glXGLClientExtensions
[];
732 /* Determine the internal API version */
733 extern int __glXGetInternalVersion(void);
735 /* Get the unadjusted system time */
736 extern int __glXGetUST( int64_t * ust
);
738 #endif /* !__GLX_client_h__ */