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 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
96 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
98 struct __GLXDRIdisplayRec
{
100 * Method to destroy the private DRI display data.
102 void (*destroyDisplay
)(__GLXDRIdisplay
*display
);
104 __GLXDRIscreen
*(*createScreen
)(__GLXscreenConfigs
*psc
, int screen
,
105 __GLXdisplayPrivate
*priv
);
108 struct __GLXDRIscreenRec
{
110 void (*destroyScreen
)(__GLXscreenConfigs
*psc
);
112 void (*createContext
)(__GLXscreenConfigs
*psc
,
113 const __GLcontextModes
*mode
,
114 GLXContext gc
, GLXContext shareList
, int renderType
);
118 ** Function to create and DRI display data and initialize the display
119 ** dependent methods.
121 extern __GLXDRIdisplay
*driCreateDisplay(Display
*dpy
);
123 extern void DRI_glXUseXFont( Font font
, int first
, int count
, int listbase
);
126 ** Functions to obtain driver configuration information from a direct
127 ** rendering client application
129 extern const char *glXGetScreenDriver (Display
*dpy
, int scrNum
);
131 extern const char *glXGetDriverConfig (const char *driverName
);
133 extern Bool
__glXWindowExists(Display
*dpy
, GLXDrawable draw
);
137 /************************************************************************/
139 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
141 typedef struct __GLXpixelStoreModeRec
{
142 GLboolean swapEndian
;
151 } __GLXpixelStoreMode
;
154 typedef struct __GLXattributeRec
{
158 * Pixel storage state. Most of the pixel store mode state is kept
159 * here and used by the client code to manage the packing and
160 * unpacking of data sent to/received from the server.
162 __GLXpixelStoreMode storePack
, storeUnpack
;
165 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
168 GLboolean NoDrawArraysProtocol
;
171 * Vertex Array storage state. The vertex array component
172 * state is stored here and is used to manage the packing of
173 * DrawArrays data sent to the server.
175 struct array_state_vector
* array_state
;
178 typedef struct __GLXattributeMachineRec
{
179 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
180 __GLXattribute
**stackPointer
;
181 } __GLXattributeMachine
;
184 * GLX state that needs to be kept on the client. One of these records
185 * exist for each context that has been made current by this client.
187 struct __GLXcontextRec
{
189 * \name Drawing command buffer.
191 * Drawing commands are packed into this buffer before being sent as a
192 * single GLX protocol request. The buffer is sent when it overflows or
193 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
194 * in the buffer to be filled. \c limit is described above in the buffer
197 * Commands that require large amounts of data to be transfered will
198 * also use this buffer to hold a header that describes the large
201 * These must be the first 6 fields since they are static initialized
202 * in the dummy context in glxext.c
213 * The XID of this rendering context. When the context is created a
214 * new XID is allocated. This is set to None when the context is
215 * destroyed but is still current to some thread. In this case the
216 * context will be freed on next MakeCurrent.
221 * The XID of the \c shareList context.
229 __GLXscreenConfigs
*psc
;
232 * \c GL_TRUE if the context was created with ImportContext, which
233 * means the server-side context was created by another X client.
238 * The context tag returned by MakeCurrent when this context is made
239 * current. This tag is used to identify the context that a thread has
240 * current so that proper server context management can be done. It is
241 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
242 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
245 GLXContextTag currentContextTag
;
248 * \name Rendering mode
250 * The rendering mode is kept on the client as well as the server.
251 * When \c glRenderMode is called, the buffer associated with the
252 * previous rendering mode (feedback or select) is filled.
256 GLfloat
*feedbackBuf
;
261 * This is \c GL_TRUE if the pixel unpack modes are such that an image
262 * can be unpacked from the clients memory by just copying. It may
263 * still be true that the server will have to do some work. This
264 * just promises that a straight copy will fetch the correct bytes.
266 GLboolean fastImageUnpack
;
269 * Fill newImage with the unpacked form of \c oldImage getting it
270 * ready for transport to the server.
272 void (*fillImage
)(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
273 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
276 * Client side attribs.
278 __GLXattributeMachine attributes
;
281 * Client side error code. This is set when client side gl API
282 * routines need to set an error because of a bad enumerant or
283 * running out of memory, etc.
288 * Whether this context does direct rendering.
293 * \c dpy of current display for this context. Will be \c NULL if not
294 * current to any display, or if this is the "dummy context".
299 * The current drawable for this context. Will be None if this
300 * context is not current to any drawable. currentReadable is below.
302 GLXDrawable currentDrawable
;
305 * \name GL Constant Strings
307 * Constant strings that describe the server implementation
308 * These pertain to GL attributes, not to be confused with
309 * GLX versioning attributes.
319 * Record the dpy this context was created on for later freeing
324 * Maximum small render command size. This is the smaller of 64k and
325 * the size of the above buffer.
327 GLint maxSmallRenderCommandSize
;
330 * Major opcode for the extension. Copied here so a lookup isn't
336 * Pointer to the mode used to create this context.
338 const __GLcontextModes
* mode
;
340 #ifdef GLX_DIRECT_RENDERING
342 * Per context direct rendering interface functions and data.
344 __DRIcontext driContext
;
347 * XID for the server side drm_context_t
353 * The current read-drawable for this context. Will be None if this
354 * context is not current to any drawable.
356 * \since Internal API version 20030606.
358 GLXDrawable currentReadable
;
361 * Pointer to client-state data that is private to libGL. This is only
362 * used for indirect rendering contexts.
364 * No internal API version change was made for this change. Client-side
365 * drivers should NEVER use this data or even care that it exists.
367 void * client_state_private
;
370 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
375 * \name Raw server GL version
377 * True core GL version supported by the server. This is the raw value
378 * returned by the server, and it may not reflect what is actually
379 * supported (or reported) by the client-side library.
382 int server_major
; /**< Major version number. */
383 int server_minor
; /**< Minor version number. */
386 char gl_extension_bits
[ __GL_EXT_BYTES
];
389 #define __glXSetError(gc,code) \
390 if (!(gc)->error) { \
391 (gc)->error = code; \
394 extern void __glFreeAttributeState(__GLXcontext
*);
396 /************************************************************************/
399 * The size of the largest drawing command known to the implementation
400 * that will use the GLXRender GLX command. In this case it is
401 * \c glPolygonStipple.
403 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
406 * To keep the implementation fast, the code uses a "limit" pointer
407 * to determine when the drawing command buffer is too full to hold
408 * another fixed size command. This constant defines the amount of
409 * space that must always be available in the drawing command buffer
410 * at all times for the implementation to work. It is important that
411 * the number be just large enough, but not so large as to reduce the
412 * efficacy of the buffer. The "+32" is just to keep the code working
413 * in case somebody counts wrong.
415 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
418 * This implementation uses a smaller threshold for switching
419 * to the RenderLarge protocol than the protcol requires so that
420 * large copies don't occur.
422 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
425 * One of these records exists per screen of the display. It contains
426 * a pointer to the config data for that screen (if the screen supports GL).
428 struct __GLXscreenConfigsRec
{
430 * GLX extension string reported by the X-server.
432 const char *serverGLXexts
;
435 * GLX extension string to be reported to applications. This is the
436 * set of extensions that the application can actually use.
438 char *effectiveGLXexts
;
440 #ifdef GLX_DIRECT_RENDERING
442 * Per screen direct rendering interface functions and data.
444 __DRIscreen __driScreen
;
445 __glxHashTable
*drawHash
;
450 __GLXDRIscreen
*driScreen
;
452 #ifdef __DRI_COPY_SUB_BUFFER
453 __DRIcopySubBufferExtension
*copySubBuffer
;
456 #ifdef __DRI_SWAP_CONTROL
457 __DRIswapControlExtension
*swapControl
;
460 #ifdef __DRI_ALLOCATE
461 __DRIallocateExtension
*allocate
;
464 #ifdef __DRI_FRAME_TRACKING
465 __DRIframeTrackingExtension
*frameTracking
;
468 #ifdef __DRI_MEDIA_STREAM_COUNTER
469 __DRImediaStreamCounterExtension
*msc
;
475 * Linked list of glx visuals and fbconfigs for this screen.
477 __GLcontextModes
*visuals
, *configs
;
480 * Per-screen dynamic GLX extension tracking. The \c direct_support
481 * field only contains enough bits for 64 extensions. Should libGL
482 * ever need to track more than 64 GLX extensions, we can safely grow
483 * this field. The \c __GLXscreenConfigs structure is not used outside
487 unsigned char direct_support
[8];
488 GLboolean ext_list_first_time
;
494 * Per display private data. One of these records exists for each display
495 * that is using the OpenGL (GLX) extension.
497 struct __GLXdisplayPrivateRec
{
499 * Back pointer to the display
504 * The \c majorOpcode is common to all connections to the same server.
505 * It is also copied into the context structure.
510 * \name Server Version
512 * Major and minor version returned by the server during initialization.
515 int majorVersion
, minorVersion
;
519 * \name Storage for the servers GLX vendor and versions strings.
521 * These are the same for all screens on this display. These fields will
522 * be filled in on demand.
525 const char *serverGLXvendor
;
526 const char *serverGLXversion
;
530 * Configurations of visuals for all screens on this display.
531 * Also, per screen data which now includes the server \c GLX_EXTENSION
534 __GLXscreenConfigs
*screenConfigs
;
536 #ifdef GLX_DIRECT_RENDERING
538 * Per display direct rendering interface functions and data.
540 __GLXDRIdisplay
*driDisplay
;
544 #ifdef GLX_DIRECT_RENDERING
546 struct __GLXdrawableRec
{
548 __GLXscreenConfigs
*psc
;
549 __DRIdrawable driDrawable
;
556 void __glXFreeContext(__GLXcontext
*);
558 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
560 extern void __glXSendLargeChunk(__GLXcontext
*gc
, GLint requestNumber
,
562 const GLvoid
* data
, GLint dataLen
);
564 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
565 const GLvoid
*, GLint
);
567 /* Initialize the GLX extension for dpy */
568 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
570 /************************************************************************/
572 extern int __glXDebug
;
574 /* This is per-thread storage in an MT environment */
575 #if defined( USE_XTHREADS ) || defined( PTHREADS )
577 extern void __glXSetCurrentContext(__GLXcontext
*c
);
579 # if defined( GLX_USE_TLS )
581 extern __thread
void * __glX_tls_Context
582 __attribute__((tls_model("initial-exec")));
584 # define __glXGetCurrentContext() __glX_tls_Context
588 extern __GLXcontext
*__glXGetCurrentContext(void);
590 # endif /* defined( GLX_USE_TLS ) */
594 extern __GLXcontext
*__glXcurrentContext
;
595 #define __glXGetCurrentContext() __glXcurrentContext
596 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
598 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
602 ** Global lock for all threads in this address space using the GLX
605 #if defined( USE_XTHREADS )
606 extern xmutex_rec __glXmutex
;
607 #define __glXLock() xmutex_lock(&__glXmutex)
608 #define __glXUnlock() xmutex_unlock(&__glXmutex)
609 #elif defined( PTHREADS )
610 extern pthread_mutex_t __glXmutex
;
611 #define __glXLock() pthread_mutex_lock(&__glXmutex)
612 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
615 #define __glXUnlock()
619 ** Setup for a command. Initialize the extension for dpy if necessary.
621 extern CARD8
__glXSetupForCommand(Display
*dpy
);
623 /************************************************************************/
626 ** Data conversion and packing support.
629 extern const GLuint __glXDefaultPixelStore
[9];
631 /* Send an image to the server using RenderLarge. */
632 extern void __glXSendLargeImage(__GLXcontext
*gc
, GLint compsize
, GLint dim
,
633 GLint width
, GLint height
, GLint depth
, GLenum format
, GLenum type
,
634 const GLvoid
*src
, GLubyte
*pc
, GLubyte
*modes
);
636 /* Return the size, in bytes, of some pixel data */
637 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
639 /* Return the number of elements per group of a specified format*/
640 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
642 /* Return the number of bytes per element, based on the element type (other
645 extern GLint
__glBytesPerElement(GLenum type
);
648 ** Fill the transport buffer with the data from the users buffer,
649 ** applying some of the pixel store modes (unpack modes) to the data
650 ** first. As a side effect of this call, the "modes" field is
651 ** updated to contain the modes needed by the server to decode the
654 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
655 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
657 /* Copy map data with a stride into a packed buffer */
658 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
659 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
660 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
661 const GLfloat
*, GLfloat
*);
662 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
663 const GLdouble
*, GLdouble
*);
666 ** Empty an image out of the reply buffer into the clients memory applying
667 ** the pack modes to pack back into the clients requested format.
669 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
670 GLenum
, const GLubyte
*, GLvoid
*);
674 ** Allocate and Initialize Vertex Array client state
676 extern void __glXInitVertexArrayState(__GLXcontext
*);
679 ** Inform the Server of the major and minor numbers and of the client
680 ** libraries extension string.
682 extern void __glXClientInfo ( Display
*dpy
, int opcode
);
684 /************************************************************************/
687 ** Declarations that should be in Xlib
689 #ifdef __GL_USE_OUR_PROTOTYPES
690 extern void _XFlush(Display
*);
691 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
692 extern void _XRead(Display
*, void*, long);
693 extern void _XSend(Display
*, const void*, long);
697 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes
*config
,
698 int count
, const INT32
*bp
, Bool tagged_only
, Bool fbconfig_style_tags
);
700 extern char * __glXGetStringFromServer( Display
* dpy
, int opcode
,
701 CARD32 glxCode
, CARD32 for_whom
, CARD32 name
);
703 extern char *__glXstrdup(const char *str
);
706 extern const char __glXGLClientVersion
[];
707 extern const char __glXGLClientExtensions
[];
709 /* Get the unadjusted system time */
710 extern int __glXGetUST( int64_t * ust
);
712 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
713 int32_t * numerator
, int32_t * denominator
);
715 #ifdef GLX_DIRECT_RENDERING
717 __driGetMscRateOML(__DRIdrawable
*draw
, int32_t *numerator
, int32_t *denominator
);
720 #endif /* !__GLX_client_h__ */