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"
63 #if defined( USE_XTHREADS )
64 # include <X11/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 __GLXscreenConfigsRec __GLXscreenConfigs
;
75 typedef struct __GLXcontextRec __GLXcontext
;
76 typedef struct __GLXdrawableRec __GLXdrawable
;
77 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate
;
78 typedef struct _glapi_table __GLapi
;
80 /************************************************************************/
82 #ifdef GLX_DIRECT_RENDERING
84 #define containerOf(ptr, type, member) \
85 (type *)( (char *)ptr - offsetof(type,member) )
87 #include <GL/internal/dri_interface.h>
91 * Display dependent methods. This structure is initialized during the
92 * \c driCreateDisplay call.
94 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
95 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
96 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
97 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
99 #include "glxextensions.h"
101 struct __GLXDRIdisplayRec
{
103 * Method to destroy the private DRI display data.
105 void (*destroyDisplay
)(__GLXDRIdisplay
*display
);
107 __GLXDRIscreen
*(*createScreen
)(__GLXscreenConfigs
*psc
, int screen
,
108 __GLXdisplayPrivate
*priv
);
111 struct __GLXDRIscreenRec
{
113 void (*destroyScreen
)(__GLXscreenConfigs
*psc
);
115 __GLXDRIcontext
*(*createContext
)(__GLXscreenConfigs
*psc
,
116 const __GLcontextModes
*mode
,
118 GLXContext shareList
, int renderType
);
120 __GLXDRIdrawable
*(*createDrawable
)(__GLXscreenConfigs
*psc
,
122 GLXDrawable glxDrawable
,
123 const __GLcontextModes
*modes
);
126 struct __GLXDRIcontextRec
{
127 void (*destroyContext
)(__GLXDRIcontext
*context
, __GLXscreenConfigs
*psc
,
129 Bool (*bindContext
)(__GLXDRIcontext
*context
,
130 __GLXDRIdrawable
*pdraw
,
131 __GLXDRIdrawable
*pread
);
133 void (*unbindContext
)(__GLXDRIcontext
*context
);
136 struct __GLXDRIdrawableRec
{
137 void (*destroyDrawable
)(__GLXDRIdrawable
*drawable
);
141 __GLXscreenConfigs
*psc
;
142 __DRIdrawable
*driDrawable
;
143 GLenum textureTarget
;
147 ** Function to create and DRI display data and initialize the display
148 ** dependent methods.
150 extern __GLXDRIdisplay
*driCreateDisplay(Display
*dpy
);
151 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
*dpy
);
153 extern void DRI_glXUseXFont( Font font
, int first
, int count
, int listbase
);
156 ** Functions to obtain driver configuration information from a direct
157 ** rendering client application
159 extern const char *glXGetScreenDriver (Display
*dpy
, int scrNum
);
161 extern const char *glXGetDriverConfig (const char *driverName
);
165 /************************************************************************/
167 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
169 typedef struct __GLXpixelStoreModeRec
{
170 GLboolean swapEndian
;
179 } __GLXpixelStoreMode
;
182 typedef struct __GLXattributeRec
{
186 * Pixel storage state. Most of the pixel store mode state is kept
187 * here and used by the client code to manage the packing and
188 * unpacking of data sent to/received from the server.
190 __GLXpixelStoreMode storePack
, storeUnpack
;
193 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
196 GLboolean NoDrawArraysProtocol
;
199 * Vertex Array storage state. The vertex array component
200 * state is stored here and is used to manage the packing of
201 * DrawArrays data sent to the server.
203 struct array_state_vector
* array_state
;
206 typedef struct __GLXattributeMachineRec
{
207 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
208 __GLXattribute
**stackPointer
;
209 } __GLXattributeMachine
;
212 * GLX state that needs to be kept on the client. One of these records
213 * exist for each context that has been made current by this client.
215 struct __GLXcontextRec
{
217 * \name Drawing command buffer.
219 * Drawing commands are packed into this buffer before being sent as a
220 * single GLX protocol request. The buffer is sent when it overflows or
221 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
222 * in the buffer to be filled. \c limit is described above in the buffer
225 * Commands that require large amounts of data to be transfered will
226 * also use this buffer to hold a header that describes the large
229 * These must be the first 6 fields since they are static initialized
230 * in the dummy context in glxext.c
241 * The XID of this rendering context. When the context is created a
242 * new XID is allocated. This is set to None when the context is
243 * destroyed but is still current to some thread. In this case the
244 * context will be freed on next MakeCurrent.
249 * The XID of the \c shareList context.
257 __GLXscreenConfigs
*psc
;
260 * \c GL_TRUE if the context was created with ImportContext, which
261 * means the server-side context was created by another X client.
266 * The context tag returned by MakeCurrent when this context is made
267 * current. This tag is used to identify the context that a thread has
268 * current so that proper server context management can be done. It is
269 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
270 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
273 GLXContextTag currentContextTag
;
276 * \name Rendering mode
278 * The rendering mode is kept on the client as well as the server.
279 * When \c glRenderMode is called, the buffer associated with the
280 * previous rendering mode (feedback or select) is filled.
284 GLfloat
*feedbackBuf
;
289 * This is \c GL_TRUE if the pixel unpack modes are such that an image
290 * can be unpacked from the clients memory by just copying. It may
291 * still be true that the server will have to do some work. This
292 * just promises that a straight copy will fetch the correct bytes.
294 GLboolean fastImageUnpack
;
297 * Fill newImage with the unpacked form of \c oldImage getting it
298 * ready for transport to the server.
300 void (*fillImage
)(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
301 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
304 * Client side attribs.
306 __GLXattributeMachine attributes
;
309 * Client side error code. This is set when client side gl API
310 * routines need to set an error because of a bad enumerant or
311 * running out of memory, etc.
316 * Whether this context does direct rendering.
321 * \c dpy of current display for this context. Will be \c NULL if not
322 * current to any display, or if this is the "dummy context".
327 * The current drawable for this context. Will be None if this
328 * context is not current to any drawable. currentReadable is below.
330 GLXDrawable currentDrawable
;
333 * \name GL Constant Strings
335 * Constant strings that describe the server implementation
336 * These pertain to GL attributes, not to be confused with
337 * GLX versioning attributes.
347 * Record the dpy this context was created on for later freeing
352 * Maximum small render command size. This is the smaller of 64k and
353 * the size of the above buffer.
355 GLint maxSmallRenderCommandSize
;
358 * Major opcode for the extension. Copied here so a lookup isn't
364 * Pointer to the mode used to create this context.
366 const __GLcontextModes
* mode
;
368 #ifdef GLX_DIRECT_RENDERING
369 __GLXDRIcontext
*driContext
;
370 __DRIcontext
*__driContext
;
374 * The current read-drawable for this context. Will be None if this
375 * context is not current to any drawable.
377 * \since Internal API version 20030606.
379 GLXDrawable currentReadable
;
382 * Pointer to client-state data that is private to libGL. This is only
383 * used for indirect rendering contexts.
385 * No internal API version change was made for this change. Client-side
386 * drivers should NEVER use this data or even care that it exists.
388 void * client_state_private
;
391 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
396 * \name Raw server GL version
398 * True core GL version supported by the server. This is the raw value
399 * returned by the server, and it may not reflect what is actually
400 * supported (or reported) by the client-side library.
403 int server_major
; /**< Major version number. */
404 int server_minor
; /**< Minor version number. */
407 char gl_extension_bits
[ __GL_EXT_BYTES
];
410 #define __glXSetError(gc,code) \
411 if (!(gc)->error) { \
412 (gc)->error = code; \
415 extern void __glFreeAttributeState(__GLXcontext
*);
417 /************************************************************************/
420 * The size of the largest drawing command known to the implementation
421 * that will use the GLXRender GLX command. In this case it is
422 * \c glPolygonStipple.
424 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
427 * To keep the implementation fast, the code uses a "limit" pointer
428 * to determine when the drawing command buffer is too full to hold
429 * another fixed size command. This constant defines the amount of
430 * space that must always be available in the drawing command buffer
431 * at all times for the implementation to work. It is important that
432 * the number be just large enough, but not so large as to reduce the
433 * efficacy of the buffer. The "+32" is just to keep the code working
434 * in case somebody counts wrong.
436 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
439 * This implementation uses a smaller threshold for switching
440 * to the RenderLarge protocol than the protcol requires so that
441 * large copies don't occur.
443 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
446 * One of these records exists per screen of the display. It contains
447 * a pointer to the config data for that screen (if the screen supports GL).
449 struct __GLXscreenConfigsRec
{
451 * GLX extension string reported by the X-server.
453 const char *serverGLXexts
;
456 * GLX extension string to be reported to applications. This is the
457 * set of extensions that the application can actually use.
459 char *effectiveGLXexts
;
461 #ifdef GLX_DIRECT_RENDERING
463 * Per screen direct rendering interface functions and data.
465 __DRIscreen
*__driScreen
;
466 const __DRIcoreExtension
*core
;
467 const __DRIlegacyExtension
*legacy
;
468 __glxHashTable
*drawHash
;
473 __GLXDRIscreen
*driScreen
;
475 #ifdef __DRI_COPY_SUB_BUFFER
476 const __DRIcopySubBufferExtension
*copySubBuffer
;
479 #ifdef __DRI_SWAP_CONTROL
480 const __DRIswapControlExtension
*swapControl
;
483 #ifdef __DRI_ALLOCATE
484 const __DRIallocateExtension
*allocate
;
487 #ifdef __DRI_FRAME_TRACKING
488 const __DRIframeTrackingExtension
*frameTracking
;
491 #ifdef __DRI_MEDIA_STREAM_COUNTER
492 const __DRImediaStreamCounterExtension
*msc
;
495 #ifdef __DRI_TEX_BUFFER
496 const __DRItexBufferExtension
*texBuffer
;
502 * Linked list of glx visuals and fbconfigs for this screen.
504 __GLcontextModes
*visuals
, *configs
;
507 * Per-screen dynamic GLX extension tracking. The \c direct_support
508 * field only contains enough bits for 64 extensions. Should libGL
509 * ever need to track more than 64 GLX extensions, we can safely grow
510 * this field. The \c __GLXscreenConfigs structure is not used outside
514 unsigned char direct_support
[8];
515 GLboolean ext_list_first_time
;
521 * Per display private data. One of these records exists for each display
522 * that is using the OpenGL (GLX) extension.
524 struct __GLXdisplayPrivateRec
{
526 * Back pointer to the display
531 * The \c majorOpcode is common to all connections to the same server.
532 * It is also copied into the context structure.
537 * \name Server Version
539 * Major and minor version returned by the server during initialization.
542 int majorVersion
, minorVersion
;
546 * \name Storage for the servers GLX vendor and versions strings.
548 * These are the same for all screens on this display. These fields will
549 * be filled in on demand.
552 const char *serverGLXvendor
;
553 const char *serverGLXversion
;
557 * Configurations of visuals for all screens on this display.
558 * Also, per screen data which now includes the server \c GLX_EXTENSION
561 __GLXscreenConfigs
*screenConfigs
;
563 #ifdef GLX_DIRECT_RENDERING
565 * Per display direct rendering interface functions and data.
567 __GLXDRIdisplay
*driDisplay
;
568 __GLXDRIdisplay
*dri2Display
;
573 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
575 extern void __glXSendLargeChunk(__GLXcontext
*gc
, GLint requestNumber
,
577 const GLvoid
* data
, GLint dataLen
);
579 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
580 const GLvoid
*, GLint
);
582 /* Initialize the GLX extension for dpy */
583 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
585 /************************************************************************/
587 extern int __glXDebug
;
589 /* This is per-thread storage in an MT environment */
590 #if defined( USE_XTHREADS ) || defined( PTHREADS )
592 extern void __glXSetCurrentContext(__GLXcontext
*c
);
594 # if defined( GLX_USE_TLS )
596 extern __thread
void * __glX_tls_Context
597 __attribute__((tls_model("initial-exec")));
599 # define __glXGetCurrentContext() __glX_tls_Context
603 extern __GLXcontext
*__glXGetCurrentContext(void);
605 # endif /* defined( GLX_USE_TLS ) */
609 extern __GLXcontext
*__glXcurrentContext
;
610 #define __glXGetCurrentContext() __glXcurrentContext
611 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
613 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
615 extern void __glXSetCurrentContextNull(void);
617 extern void __glXFreeContext(__GLXcontext
*);
621 ** Global lock for all threads in this address space using the GLX
624 #if defined( USE_XTHREADS )
625 extern xmutex_rec __glXmutex
;
626 #define __glXLock() xmutex_lock(&__glXmutex)
627 #define __glXUnlock() xmutex_unlock(&__glXmutex)
628 #elif defined( PTHREADS )
629 extern pthread_mutex_t __glXmutex
;
630 #define __glXLock() pthread_mutex_lock(&__glXmutex)
631 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
634 #define __glXUnlock()
638 ** Setup for a command. Initialize the extension for dpy if necessary.
640 extern CARD8
__glXSetupForCommand(Display
*dpy
);
642 /************************************************************************/
645 ** Data conversion and packing support.
648 extern const GLuint __glXDefaultPixelStore
[9];
650 /* Send an image to the server using RenderLarge. */
651 extern void __glXSendLargeImage(__GLXcontext
*gc
, GLint compsize
, GLint dim
,
652 GLint width
, GLint height
, GLint depth
, GLenum format
, GLenum type
,
653 const GLvoid
*src
, GLubyte
*pc
, GLubyte
*modes
);
655 /* Return the size, in bytes, of some pixel data */
656 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
658 /* Return the number of elements per group of a specified format*/
659 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
661 /* Return the number of bytes per element, based on the element type (other
664 extern GLint
__glBytesPerElement(GLenum type
);
667 ** Fill the transport buffer with the data from the users buffer,
668 ** applying some of the pixel store modes (unpack modes) to the data
669 ** first. As a side effect of this call, the "modes" field is
670 ** updated to contain the modes needed by the server to decode the
673 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
674 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
676 /* Copy map data with a stride into a packed buffer */
677 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
678 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
679 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
680 const GLfloat
*, GLfloat
*);
681 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
682 const GLdouble
*, GLdouble
*);
685 ** Empty an image out of the reply buffer into the clients memory applying
686 ** the pack modes to pack back into the clients requested format.
688 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
689 GLenum
, const GLubyte
*, GLvoid
*);
693 ** Allocate and Initialize Vertex Array client state
695 extern void __glXInitVertexArrayState(__GLXcontext
*);
698 ** Inform the Server of the major and minor numbers and of the client
699 ** libraries extension string.
701 extern void __glXClientInfo ( Display
*dpy
, int opcode
);
703 /************************************************************************/
706 ** Declarations that should be in Xlib
708 #ifdef __GL_USE_OUR_PROTOTYPES
709 extern void _XFlush(Display
*);
710 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
711 extern void _XRead(Display
*, void*, long);
712 extern void _XSend(Display
*, const void*, long);
716 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes
*config
,
717 int count
, const INT32
*bp
, Bool tagged_only
, Bool fbconfig_style_tags
);
719 extern char * __glXGetStringFromServer( Display
* dpy
, int opcode
,
720 CARD32 glxCode
, CARD32 for_whom
, CARD32 name
);
722 extern char *__glXstrdup(const char *str
);
725 extern const char __glXGLClientVersion
[];
726 extern const char __glXGLClientExtensions
[];
728 /* Get the unadjusted system time */
729 extern int __glXGetUST( int64_t * ust
);
731 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
732 int32_t * numerator
, int32_t * denominator
);
734 #ifdef GLX_DIRECT_RENDERING
736 __driGetMscRateOML(__DRIdrawable
*draw
,
737 int32_t *numerator
, int32_t *denominator
, void *private);
740 #endif /* !__GLX_client_h__ */