1 /* -*- mode: c; tab-width: 3; indent-tabs-mode: nil; c-basic-offset: 3; coding: utf-8-unix -*- */
3 * SGI FREE SOFTWARE LICENSE B (Version 2.0, Sept. 18, 2008)
4 * Copyright (C) 1991-2000 Silicon Graphics, Inc. All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice including the dates of first publication and
14 * either this permission notice or a reference to
15 * http://oss.sgi.com/projects/FreeB/
16 * shall be included in all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * SILICON GRAPHICS, INC. BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
22 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
23 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * Except as contained in this notice, the name of Silicon Graphics, Inc.
27 * shall not be used in advertising or otherwise to promote the sale, use or
28 * other dealings in this Software without prior written authorization from
29 * Silicon Graphics, Inc.
34 * Direct rendering support added by Precision Insight, Inc.
36 * \author Kevin E. Martin <kevin@precisioninsight.com>
39 #ifndef _GLX_client_h_
40 #define _GLX_client_h_
43 #include <X11/Xproto.h>
44 #include <X11/Xlibint.h>
45 #define GLX_GLXEXT_PROTOTYPES
47 #include <GL/glxext.h>
54 #include "GL/glxint.h"
55 #include "GL/glxproto.h"
56 #include "GL/internal/glcore.h"
57 #include "glapi/glapitable.h"
59 #if defined( USE_XTHREADS )
60 # include <X11/Xthreads.h>
61 #elif defined( PTHREADS )
65 #include "glxextensions.h"
68 /* If we build the library with gcc's -fvisibility=hidden flag, we'll
69 * use the PUBLIC macro to mark functions that are to be exported.
71 * We also need to define a USED attribute, so the optimizer doesn't
72 * inline a static function that we later use in an alias. - ajax
74 #if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
75 # define PUBLIC __attribute__((visibility("default")))
76 # define USED __attribute__((used))
84 #define GLX_MAJOR_VERSION 1 /* current version numbers */
85 #define GLX_MINOR_VERSION 4
87 #define __GLX_MAX_TEXTURE_UNITS 32
89 typedef struct __GLXscreenConfigsRec __GLXscreenConfigs
;
90 typedef struct __GLXcontextRec __GLXcontext
;
91 typedef struct __GLXdrawableRec __GLXdrawable
;
92 typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate
;
93 typedef struct _glapi_table __GLapi
;
95 /************************************************************************/
97 #ifdef GLX_DIRECT_RENDERING
99 #define containerOf(ptr, type, member) \
100 (type *)( (char *)ptr - offsetof(type,member) )
102 #include <GL/internal/dri_interface.h>
106 * Display dependent methods. This structure is initialized during the
107 * \c driCreateDisplay call.
109 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay
;
110 typedef struct __GLXDRIscreenRec __GLXDRIscreen
;
111 typedef struct __GLXDRIdrawableRec __GLXDRIdrawable
;
112 typedef struct __GLXDRIcontextRec __GLXDRIcontext
;
114 #include "glxextensions.h"
116 struct __GLXDRIdisplayRec
{
118 * Method to destroy the private DRI display data.
120 void (*destroyDisplay
)(__GLXDRIdisplay
*display
);
122 __GLXDRIscreen
*(*createScreen
)(__GLXscreenConfigs
*psc
, int screen
,
123 __GLXdisplayPrivate
*priv
);
126 struct __GLXDRIscreenRec
{
128 void (*destroyScreen
)(__GLXscreenConfigs
*psc
);
130 __GLXDRIcontext
*(*createContext
)(__GLXscreenConfigs
*psc
,
131 const __GLcontextModes
*mode
,
133 GLXContext shareList
, int renderType
);
135 __GLXDRIdrawable
*(*createDrawable
)(__GLXscreenConfigs
*psc
,
137 GLXDrawable glxDrawable
,
138 const __GLcontextModes
*modes
);
140 void (*swapBuffers
)(__GLXDRIdrawable
*pdraw
);
141 void (*copySubBuffer
)(__GLXDRIdrawable
*pdraw
,
142 int x
, int y
, int width
, int height
);
145 struct __GLXDRIcontextRec
{
146 void (*destroyContext
)(__GLXDRIcontext
*context
, __GLXscreenConfigs
*psc
,
148 Bool (*bindContext
)(__GLXDRIcontext
*context
,
149 __GLXDRIdrawable
*pdraw
,
150 __GLXDRIdrawable
*pread
);
152 void (*unbindContext
)(__GLXDRIcontext
*context
);
155 struct __GLXDRIdrawableRec
{
156 void (*destroyDrawable
)(__GLXDRIdrawable
*drawable
);
160 __GLXscreenConfigs
*psc
;
161 GLenum textureTarget
;
162 __DRIdrawable
*driDrawable
;
166 ** Function to create and DRI display data and initialize the display
167 ** dependent methods.
169 extern __GLXDRIdisplay
*driswCreateDisplay(Display
*dpy
);
170 extern __GLXDRIdisplay
*driCreateDisplay(Display
*dpy
);
171 extern __GLXDRIdisplay
*dri2CreateDisplay(Display
*dpy
);
173 extern void DRI_glXUseXFont( Font font
, int first
, int count
, int listbase
);
176 ** Functions to obtain driver configuration information from a direct
177 ** rendering client application
179 extern const char *glXGetScreenDriver (Display
*dpy
, int scrNum
);
181 extern const char *glXGetDriverConfig (const char *driverName
);
185 /************************************************************************/
187 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
189 typedef struct __GLXpixelStoreModeRec
{
190 GLboolean swapEndian
;
199 } __GLXpixelStoreMode
;
202 typedef struct __GLXattributeRec
{
206 * Pixel storage state. Most of the pixel store mode state is kept
207 * here and used by the client code to manage the packing and
208 * unpacking of data sent to/received from the server.
210 __GLXpixelStoreMode storePack
, storeUnpack
;
213 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
216 GLboolean NoDrawArraysProtocol
;
219 * Vertex Array storage state. The vertex array component
220 * state is stored here and is used to manage the packing of
221 * DrawArrays data sent to the server.
223 struct array_state_vector
* array_state
;
226 typedef struct __GLXattributeMachineRec
{
227 __GLXattribute
*stack
[__GL_CLIENT_ATTRIB_STACK_DEPTH
];
228 __GLXattribute
**stackPointer
;
229 } __GLXattributeMachine
;
232 * GLX state that needs to be kept on the client. One of these records
233 * exist for each context that has been made current by this client.
235 struct __GLXcontextRec
{
237 * \name Drawing command buffer.
239 * Drawing commands are packed into this buffer before being sent as a
240 * single GLX protocol request. The buffer is sent when it overflows or
241 * is flushed by \c __glXFlushRenderBuffer. \c pc is the next location
242 * in the buffer to be filled. \c limit is described above in the buffer
245 * Commands that require large amounts of data to be transfered will
246 * also use this buffer to hold a header that describes the large
249 * These must be the first 6 fields since they are static initialized
250 * in the dummy context in glxext.c
261 * The XID of this rendering context. When the context is created a
262 * new XID is allocated. This is set to None when the context is
263 * destroyed but is still current to some thread. In this case the
264 * context will be freed on next MakeCurrent.
269 * The XID of the \c shareList context.
277 __GLXscreenConfigs
*psc
;
280 * \c GL_TRUE if the context was created with ImportContext, which
281 * means the server-side context was created by another X client.
286 * The context tag returned by MakeCurrent when this context is made
287 * current. This tag is used to identify the context that a thread has
288 * current so that proper server context management can be done. It is
289 * used for all context specific commands (i.e., \c Render, \c RenderLarge,
290 * \c WaitX, \c WaitGL, \c UseXFont, and \c MakeCurrent (for the old
293 GLXContextTag currentContextTag
;
296 * \name Rendering mode
298 * The rendering mode is kept on the client as well as the server.
299 * When \c glRenderMode is called, the buffer associated with the
300 * previous rendering mode (feedback or select) is filled.
304 GLfloat
*feedbackBuf
;
309 * This is \c GL_TRUE if the pixel unpack modes are such that an image
310 * can be unpacked from the clients memory by just copying. It may
311 * still be true that the server will have to do some work. This
312 * just promises that a straight copy will fetch the correct bytes.
314 GLboolean fastImageUnpack
;
317 * Fill newImage with the unpacked form of \c oldImage getting it
318 * ready for transport to the server.
320 void (*fillImage
)(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
321 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
324 * Client side attribs.
326 __GLXattributeMachine attributes
;
329 * Client side error code. This is set when client side gl API
330 * routines need to set an error because of a bad enumerant or
331 * running out of memory, etc.
336 * Whether this context does direct rendering.
341 * \c dpy of current display for this context. Will be \c NULL if not
342 * current to any display, or if this is the "dummy context".
347 * The current drawable for this context. Will be None if this
348 * context is not current to any drawable. currentReadable is below.
350 GLXDrawable currentDrawable
;
353 * \name GL Constant Strings
355 * Constant strings that describe the server implementation
356 * These pertain to GL attributes, not to be confused with
357 * GLX versioning attributes.
367 * Record the dpy this context was created on for later freeing
372 * Maximum small render command size. This is the smaller of 64k and
373 * the size of the above buffer.
375 GLint maxSmallRenderCommandSize
;
378 * Major opcode for the extension. Copied here so a lookup isn't
384 * Pointer to the mode used to create this context.
386 const __GLcontextModes
* mode
;
388 #ifdef GLX_DIRECT_RENDERING
389 __GLXDRIcontext
*driContext
;
390 __DRIcontext
*__driContext
;
394 * The current read-drawable for this context. Will be None if this
395 * context is not current to any drawable.
397 * \since Internal API version 20030606.
399 GLXDrawable currentReadable
;
402 * Pointer to client-state data that is private to libGL. This is only
403 * used for indirect rendering contexts.
405 * No internal API version change was made for this change. Client-side
406 * drivers should NEVER use this data or even care that it exists.
408 void * client_state_private
;
411 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
416 * \name Raw server GL version
418 * True core GL version supported by the server. This is the raw value
419 * returned by the server, and it may not reflect what is actually
420 * supported (or reported) by the client-side library.
423 int server_major
; /**< Major version number. */
424 int server_minor
; /**< Minor version number. */
427 char gl_extension_bits
[ __GL_EXT_BYTES
];
430 #define __glXSetError(gc,code) \
431 if (!(gc)->error) { \
432 (gc)->error = code; \
435 extern void __glFreeAttributeState(__GLXcontext
*);
437 /************************************************************************/
440 * The size of the largest drawing command known to the implementation
441 * that will use the GLXRender GLX command. In this case it is
442 * \c glPolygonStipple.
444 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
447 * To keep the implementation fast, the code uses a "limit" pointer
448 * to determine when the drawing command buffer is too full to hold
449 * another fixed size command. This constant defines the amount of
450 * space that must always be available in the drawing command buffer
451 * at all times for the implementation to work. It is important that
452 * the number be just large enough, but not so large as to reduce the
453 * efficacy of the buffer. The "+32" is just to keep the code working
454 * in case somebody counts wrong.
456 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
459 * This implementation uses a smaller threshold for switching
460 * to the RenderLarge protocol than the protcol requires so that
461 * large copies don't occur.
463 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
466 * One of these records exists per screen of the display. It contains
467 * a pointer to the config data for that screen (if the screen supports GL).
469 struct __GLXscreenConfigsRec
{
471 * GLX extension string reported by the X-server.
473 const char *serverGLXexts
;
476 * GLX extension string to be reported to applications. This is the
477 * set of extensions that the application can actually use.
479 char *effectiveGLXexts
;
481 #ifdef GLX_DIRECT_RENDERING
483 * Per screen direct rendering interface functions and data.
485 __DRIscreen
*__driScreen
;
486 const __DRIcoreExtension
*core
;
487 const __DRIlegacyExtension
*legacy
;
488 const __DRIswrastExtension
*swrast
;
489 const __DRIdri2Extension
*dri2
;
490 __glxHashTable
*drawHash
;
495 __GLXDRIscreen
*driScreen
;
497 #ifdef __DRI_COPY_SUB_BUFFER
498 const __DRIcopySubBufferExtension
*driCopySubBuffer
;
501 #ifdef __DRI_SWAP_CONTROL
502 const __DRIswapControlExtension
*swapControl
;
505 #ifdef __DRI_ALLOCATE
506 const __DRIallocateExtension
*allocate
;
509 #ifdef __DRI_FRAME_TRACKING
510 const __DRIframeTrackingExtension
*frameTracking
;
513 #ifdef __DRI_MEDIA_STREAM_COUNTER
514 const __DRImediaStreamCounterExtension
*msc
;
517 #ifdef __DRI_TEX_BUFFER
518 const __DRItexBufferExtension
*texBuffer
;
524 * Linked list of glx visuals and fbconfigs for this screen.
526 __GLcontextModes
*visuals
, *configs
;
529 * Per-screen dynamic GLX extension tracking. The \c direct_support
530 * field only contains enough bits for 64 extensions. Should libGL
531 * ever need to track more than 64 GLX extensions, we can safely grow
532 * this field. The \c __GLXscreenConfigs structure is not used outside
536 unsigned char direct_support
[8];
537 GLboolean ext_list_first_time
;
543 * Per display private data. One of these records exists for each display
544 * that is using the OpenGL (GLX) extension.
546 struct __GLXdisplayPrivateRec
{
548 * Back pointer to the display
553 * The \c majorOpcode is common to all connections to the same server.
554 * It is also copied into the context structure.
559 * \name Server Version
561 * Major and minor version returned by the server during initialization.
564 int majorVersion
, minorVersion
;
568 * \name Storage for the servers GLX vendor and versions strings.
570 * These are the same for all screens on this display. These fields will
571 * be filled in on demand.
574 const char *serverGLXvendor
;
575 const char *serverGLXversion
;
579 * Configurations of visuals for all screens on this display.
580 * Also, per screen data which now includes the server \c GLX_EXTENSION
583 __GLXscreenConfigs
*screenConfigs
;
585 #ifdef GLX_DIRECT_RENDERING
587 * Per display direct rendering interface functions and data.
589 __GLXDRIdisplay
*driswDisplay
;
590 __GLXDRIdisplay
*driDisplay
;
591 __GLXDRIdisplay
*dri2Display
;
596 extern GLubyte
*__glXFlushRenderBuffer(__GLXcontext
*, GLubyte
*);
598 extern void __glXSendLargeChunk(__GLXcontext
*gc
, GLint requestNumber
,
600 const GLvoid
* data
, GLint dataLen
);
602 extern void __glXSendLargeCommand(__GLXcontext
*, const GLvoid
*, GLint
,
603 const GLvoid
*, GLint
);
605 /* Initialize the GLX extension for dpy */
606 extern __GLXdisplayPrivate
*__glXInitialize(Display
*);
608 extern void __glXPreferEGL(int state
);
610 /************************************************************************/
612 extern int __glXDebug
;
614 /* This is per-thread storage in an MT environment */
615 #if defined( USE_XTHREADS ) || defined( PTHREADS )
617 extern void __glXSetCurrentContext(__GLXcontext
*c
);
619 # if defined( GLX_USE_TLS )
621 extern __thread
void * __glX_tls_Context
622 __attribute__((tls_model("initial-exec")));
624 # define __glXGetCurrentContext() __glX_tls_Context
628 extern __GLXcontext
*__glXGetCurrentContext(void);
630 # endif /* defined( GLX_USE_TLS ) */
634 extern __GLXcontext
*__glXcurrentContext
;
635 #define __glXGetCurrentContext() __glXcurrentContext
636 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
638 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
640 extern void __glXSetCurrentContextNull(void);
642 extern void __glXFreeContext(__GLXcontext
*);
646 ** Global lock for all threads in this address space using the GLX
649 #if defined( USE_XTHREADS )
650 extern xmutex_rec __glXmutex
;
651 #define __glXLock() xmutex_lock(&__glXmutex)
652 #define __glXUnlock() xmutex_unlock(&__glXmutex)
653 #elif defined( PTHREADS )
654 extern pthread_mutex_t __glXmutex
;
655 #define __glXLock() pthread_mutex_lock(&__glXmutex)
656 #define __glXUnlock() pthread_mutex_unlock(&__glXmutex)
659 #define __glXUnlock()
663 ** Setup for a command. Initialize the extension for dpy if necessary.
665 extern CARD8
__glXSetupForCommand(Display
*dpy
);
667 /************************************************************************/
670 ** Data conversion and packing support.
673 extern const GLuint __glXDefaultPixelStore
[9];
675 /* Send an image to the server using RenderLarge. */
676 extern void __glXSendLargeImage(__GLXcontext
*gc
, GLint compsize
, GLint dim
,
677 GLint width
, GLint height
, GLint depth
, GLenum format
, GLenum type
,
678 const GLvoid
*src
, GLubyte
*pc
, GLubyte
*modes
);
680 /* Return the size, in bytes, of some pixel data */
681 extern GLint
__glImageSize(GLint
, GLint
, GLint
, GLenum
, GLenum
, GLenum
);
683 /* Return the number of elements per group of a specified format*/
684 extern GLint
__glElementsPerGroup(GLenum format
, GLenum type
);
686 /* Return the number of bytes per element, based on the element type (other
689 extern GLint
__glBytesPerElement(GLenum type
);
692 ** Fill the transport buffer with the data from the users buffer,
693 ** applying some of the pixel store modes (unpack modes) to the data
694 ** first. As a side effect of this call, the "modes" field is
695 ** updated to contain the modes needed by the server to decode the
698 extern void __glFillImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
699 GLenum
, const GLvoid
*, GLubyte
*, GLubyte
*);
701 /* Copy map data with a stride into a packed buffer */
702 extern void __glFillMap1f(GLint
, GLint
, GLint
, const GLfloat
*, GLubyte
*);
703 extern void __glFillMap1d(GLint
, GLint
, GLint
, const GLdouble
*, GLubyte
*);
704 extern void __glFillMap2f(GLint
, GLint
, GLint
, GLint
, GLint
,
705 const GLfloat
*, GLfloat
*);
706 extern void __glFillMap2d(GLint
, GLint
, GLint
, GLint
, GLint
,
707 const GLdouble
*, GLdouble
*);
710 ** Empty an image out of the reply buffer into the clients memory applying
711 ** the pack modes to pack back into the clients requested format.
713 extern void __glEmptyImage(__GLXcontext
*, GLint
, GLint
, GLint
, GLint
, GLenum
,
714 GLenum
, const GLubyte
*, GLvoid
*);
718 ** Allocate and Initialize Vertex Array client state, and free.
720 extern void __glXInitVertexArrayState(__GLXcontext
*);
721 extern void __glXFreeVertexArrayState(__GLXcontext
*);
724 ** Inform the Server of the major and minor numbers and of the client
725 ** libraries extension string.
727 extern void __glXClientInfo ( Display
*dpy
, int opcode
);
729 /************************************************************************/
732 ** Declarations that should be in Xlib
734 #ifdef __GL_USE_OUR_PROTOTYPES
735 extern void _XFlush(Display
*);
736 extern Status
_XReply(Display
*, xReply
*, int, Bool
);
737 extern void _XRead(Display
*, void*, long);
738 extern void _XSend(Display
*, const void*, long);
742 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes
*config
,
743 int count
, const INT32
*bp
, Bool tagged_only
, Bool fbconfig_style_tags
);
745 extern char * __glXGetStringFromServer( Display
* dpy
, int opcode
,
746 CARD32 glxCode
, CARD32 for_whom
, CARD32 name
);
748 extern char *__glXstrdup(const char *str
);
751 extern const char __glXGLClientVersion
[];
752 extern const char __glXGLClientExtensions
[];
754 /* Get the unadjusted system time */
755 extern int __glXGetUST( int64_t * ust
);
757 extern GLboolean
__glXGetMscRateOML(Display
* dpy
, GLXDrawable drawable
,
758 int32_t * numerator
, int32_t * denominator
);
760 #ifdef GLX_DIRECT_RENDERING
762 __driGetMscRateOML(__DRIdrawable
*draw
,
763 int32_t *numerator
, int32_t *denominator
, void *private);
766 #endif /* !__GLX_client_h__ */