/* ** License Applicability. Except to the extent portions of this file are ** made subject to an alternative license as permitted in the SGI Free ** Software License B, Version 1.1 (the "License"), the contents of this ** file are subject only to the provisions of the License. You may not use ** this file except in compliance with the License. You may obtain a copy ** of the License at Silicon Graphics, Inc., attn: Legal Services, 1600 ** Amphitheatre Parkway, Mountain View, CA 94043-1351, or at: ** ** http://oss.sgi.com/projects/FreeB ** ** Note that, as provided in the License, the Software is distributed on an ** "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS ** DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND ** CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A ** PARTICULAR PURPOSE, AND NON-INFRINGEMENT. ** ** Original Code. The Original Code is: OpenGL Sample Implementation, ** Version 1.2.1, released January 26, 2000, developed by Silicon Graphics, ** Inc. The Original Code is Copyright (c) 1991-2000 Silicon Graphics, Inc. ** Copyright in any portions created by third parties is as indicated ** elsewhere herein. All Rights Reserved. ** ** Additional Notice Provisions: The application programming interfaces ** established by SGI in conjunction with the Original Code are The ** OpenGL(R) Graphics System: A Specification (Version 1.2.1), released ** April 1, 1999; The OpenGL(R) Graphics System Utility Library (Version ** 1.3), released November 4, 1998; and OpenGL(R) Graphics with the X ** Window System(R) (Version 1.3), released October 19, 1998. This software ** was created using the OpenGL(R) version 1.2.1 Sample Implementation ** published by SGI, but has not been independently verified as being ** compliant with the OpenGL(R) version 1.2.1 Specification. */ /* $XFree86: xc/lib/GL/glx/glxclient.h,v 1.15 2002/10/30 12:51:26 alanh Exp $ */ /* * Direct rendering support added by Precision Insight, Inc. * * Authors: * Kevin E. Martin * */ #ifndef _GLX_client_h_ #define _GLX_client_h_ #define NEED_REPLIES #define NEED_EVENTS #include #include #define GLX_GLXEXT_PROTOTYPES #include #include #include #include "GL/glxint.h" #include "GL/glxproto.h" #include "GL/internal/glcore.h" #include "glapitable.h" #ifdef NEED_GL_FUNCS_WRAPPED #include "indirect.h" #endif #ifdef XTHREADS #include "Xthreads.h" #endif #ifdef GLX_BUILT_IN_XMESA #include "realglx.h" /* just silences prototype warnings */ #endif #define GLX_MAJOR_VERSION 1 /* current version numbers */ #define GLX_MINOR_VERSION 2 #define __GL_BOOLEAN_ARRAY (GL_BYTE - 1) #define __GLX_MAX_TEXTURE_UNITS 32 typedef struct __GLXcontextRec __GLXcontext; typedef struct __GLXdisplayPrivateRec __GLXdisplayPrivate; typedef struct _glapi_table __GLapi; /************************************************************************/ #ifdef GLX_DIRECT_RENDERING /* ** The following structures define the interface between the GLX client ** side library and the DRI (direct rendering infrastructure). */ typedef struct __DRIdisplayRec __DRIdisplay; typedef struct __DRIscreenRec __DRIscreen; typedef struct __DRIcontextRec __DRIcontext; typedef struct __DRIdrawableRec __DRIdrawable; typedef struct __DRIdriverRec __DRIdriver; extern __DRIscreen *__glXFindDRIScreen(Display *dpy, int scrn); /* ** Display dependent methods. This structure is initialized during the ** driCreateDisplay() call. */ struct __DRIdisplayRec { /* ** Method to destroy the private DRI display data. */ void (*destroyDisplay)(Display *dpy, void *displayPrivate); /* ** Methods to create the private DRI screen data and initialize the ** screen dependent methods. ** This is an array [indexed by screen number] of function pointers. */ void *(**createScreen)(Display *dpy, int scrn, __DRIscreen *psc, int numConfigs, __GLXvisualConfig *config); /* ** Opaque pointer to private per display direct rendering data. ** NULL if direct rendering is not supported on this display. Never ** dereferenced in libGL. */ void *private; }; /* ** Screen dependent methods. This structure is initialized during the ** (*createScreen)() call. */ struct __DRIscreenRec { /* ** Method to destroy the private DRI screen data. */ void (*destroyScreen)(Display *dpy, int scrn, void *screenPrivate); /* ** Method to create the private DRI context data and initialize the ** context dependent methods. */ void *(*createContext)(Display *dpy, XVisualInfo *vis, void *sharedPrivate, __DRIcontext *pctx); /* ** Method to create the private DRI drawable data and initialize the ** drawable dependent methods. */ void *(*createDrawable)(Display *dpy, int scrn, GLXDrawable draw, VisualID vid, __DRIdrawable *pdraw); /* ** Method to return a pointer to the DRI drawable data. */ __DRIdrawable *(*getDrawable)(Display *dpy, GLXDrawable draw, void *drawablePrivate); /* ** Opaque pointer to private per screen direct rendering data. NULL ** if direct rendering is not supported on this screen. Never ** dereferenced in libGL. */ void *private; /* ** Get the number of vertical refreshes since some point in time before ** this function was first called (i.e., system start up). ** ** Added with internal API version "20030317". */ int (*getMSC)( void *screenPrivate, int64_t *msc ); /* ** Opaque pointer that points back to the containing __GLXscreenConfigs. ** This data structure is shared with DRI drivers but __GLXscreenConfigs ** is not. However, they are needed by some GLX functions called by DRI ** drivers. ** ** Added with internal API version "20030813". */ void *screenConfigs; /* ** Added with internal API version "20030815". */ void *(*allocateMemory)(Display *dpy, int scrn, GLsizei size, GLfloat readfreq, GLfloat writefreq, GLfloat priority); void (*freeMemory)(Display *dpy, int scrn, GLvoid *pointer); GLuint (*memoryOffset)(Display *dpy, int scrn, const GLvoid *pointer); }; /* ** Context dependent methods. This structure is initialized during the ** (*createContext)() call. */ struct __DRIcontextRec { /* ** Method to destroy the private DRI context data. */ void (*destroyContext)(Display *dpy, int scrn, void *contextPrivate); /* ** Method to bind a DRI drawable to a DRI graphics context. */ Bool (*bindContext)(Display *dpy, int scrn, GLXDrawable draw, GLXContext gc); /* ** Method to unbind a DRI drawable to a DRI graphics context. */ Bool (*unbindContext)(Display *dpy, int scrn, GLXDrawable draw, GLXContext gc, int will_rebind); /* ** Opaque pointer to private per context direct rendering data. ** NULL if direct rendering is not supported on the display or ** screen used to create this context. Never dereferenced in libGL. */ void *private; /* ** Added with internal API version "20030606". ** ** Method to bind a DRI drawable to a DRI graphics context. */ Bool (*bindContext2)(Display *dpy, int scrn, GLXDrawable draw, GLXDrawable read, GLXContext gc); /* ** Added with internal API version "20030606". ** ** Method to unbind a DRI drawable to a DRI graphics context. */ Bool (*unbindContext2)(Display *dpy, int scrn, GLXDrawable draw, GLXDrawable read, GLXContext gc); }; /* ** Drawable dependent methods. This structure is initialized during the ** (*createDrawable)() call. createDrawable() is not called by libGL at ** this time. It's currently used via the dri_util.c utility code instead. */ struct __DRIdrawableRec { /* ** Method to destroy the private DRI drawable data. */ void (*destroyDrawable)(Display *dpy, void *drawablePrivate); /* ** Method to swap the front and back buffers. */ void (*swapBuffers)(Display *dpy, void *drawablePrivate); /* ** Opaque pointer to private per drawable direct rendering data. ** NULL if direct rendering is not supported on the display or ** screen used to create this drawable. Never dereferenced in libGL. */ void *private; /* ** Get the number of completed swap buffers for this drawable. ** ** Added with internal API version "20030317". */ int (*getSBC)(Display *dpy, void *drawablePrivate, int64_t *sbc ); /* ** Wait for the SBC to be greater than or equal target_sbc. */ int (*waitForSBC)( Display * dpy, void *drawablePriv, int64_t target_sbc, int64_t * msc, int64_t * sbc ); /* ** Wait for the MSC to equal target_msc, or, if that has already passed, ** the next time (MSC % divisor) is equal to remainder. If divisor is ** zero, the function will return as soon as MSC is greater than or equal ** to target_msc. ** ** Added with internal API version "20030317". */ int (*waitForMSC)( Display * dpy, void *drawablePriv, int64_t target_msc, int64_t divisor, int64_t remainder, int64_t * msc, int64_t * sbc ); /* ** Like swapBuffers, but does NOT have an implicit glFlush. Once ** rendering is complete, waits until MSC is equal to target_msc, or ** if that has already passed, waits until (MSC % divisor) is equal ** to remainder. If divisor is zero, the swap will happen as soon as ** MSC is greater than or equal to target_msc. ** ** Added with internal API version "20030317". */ int64_t (*swapBuffersMSC)(Display *dpy, void *drawablePrivate, int64_t target_msc, int64_t divisor, int64_t remainder); /* ** Enable or disable frame usage tracking. ** ** Added with internal API version "20030317". */ int (*frameTracking)(Display *dpy, void *drawablePrivate, Bool enable); /* ** Retrieve frame usage information. ** ** Added with internal API version "20030317". */ int (*queryFrameTracking)(Display *dpy, void *drawablePrivate, int64_t * sbc, int64_t * missedFrames, float * lastMissedUsage, float * usage ); /* ** Used by drivers that implement the GLX_SGI_swap_control or ** GLX_MESA_swap_control extension. ** ** Added with internal API version "20030317". */ unsigned swap_interval; }; typedef void *(*CreateScreenFunc)(Display *dpy, int scrn, __DRIscreen *psc, int numConfigs, __GLXvisualConfig *config); /* ** We keep a linked list of these structures, one per DRI device driver. */ struct __DRIdriverRec { const char *name; void *handle; CreateScreenFunc createScreenFunc; struct __DRIdriverRec *next; }; /* ** Function to create and DRI display data and initialize the display ** dependent methods. */ extern void *driCreateDisplay(Display *dpy, __DRIdisplay *pdisp); extern __DRIdriver *driGetDriver(Display *dpy, int scrNum); extern void DRI_glXUseXFont( Font font, int first, int count, int listbase ); #endif /************************************************************************/ #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16 typedef struct __GLXpixelStoreModeRec { GLboolean swapEndian; GLboolean lsbFirst; GLuint rowLength; GLuint imageHeight; GLuint imageDepth; GLuint skipRows; GLuint skipPixels; GLuint skipImages; GLuint alignment; } __GLXpixelStoreMode; typedef struct __GLXvertexArrayPointerStateRec { GLboolean enable; void (*proc)(const void *); const GLubyte *ptr; GLsizei skip; GLint size; GLenum type; GLsizei stride; } __GLXvertexArrayPointerState; typedef struct __GLXvertArrayStateRec { __GLXvertexArrayPointerState vertex; __GLXvertexArrayPointerState normal; __GLXvertexArrayPointerState color; __GLXvertexArrayPointerState index; __GLXvertexArrayPointerState texCoord[__GLX_MAX_TEXTURE_UNITS]; __GLXvertexArrayPointerState edgeFlag; GLint maxElementsVertices; GLint maxElementsIndices; GLint activeTexture; } __GLXvertArrayState; typedef struct __GLXattributeRec { GLuint mask; /* ** Pixel storage state. Most of the pixel store mode state is kept ** here and used by the client code to manage the packing and ** unpacking of data sent to/received from the server. */ __GLXpixelStoreMode storePack, storeUnpack; /* ** Vertex Array storage state. The vertex array component ** state is stored here and is used to manage the packing of ** DrawArrays data sent to the server. */ __GLXvertArrayState vertArray; } __GLXattribute; typedef struct __GLXattributeMachineRec { __GLXattribute *stack[__GL_CLIENT_ATTRIB_STACK_DEPTH]; __GLXattribute **stackPointer; } __GLXattributeMachine; /* ** GLX state that needs to be kept on the client. One of these records ** exist for each context that has been made current by this client. */ struct __GLXcontextRec { /* ** Drawing command buffer. Drawing commands are packed into this ** buffer before being sent as a single GLX protocol request. The ** buffer is sent when it overflows or is flushed by ** __glXFlushRenderBuffer. "pc" is the next location in the buffer ** to be filled. "limit" is described above in the buffer slop ** discussion. ** ** Commands that require large amounts of data to be transfered will ** also use this buffer to hold a header that describes the large ** command. ** ** These must be the first 6 fields since they are static initialized ** in the dummy context in glxext.c */ GLubyte *buf; GLubyte *pc; GLubyte *limit; GLubyte *bufEnd; GLint bufSize; /* ** The XID of this rendering context. When the context is created a ** new XID is allocated. This is set to None when the context is ** destroyed but is still current to some thread. In this case the ** context will be freed on next MakeCurrent. */ XID xid; /* ** The XID of the shareList context. */ XID share_xid; /* ** Visual id. */ VisualID vid; /* ** screen number. */ GLint screen; /* ** GL_TRUE if the context was created with ImportContext, which ** means the server-side context was created by another X client. */ GLboolean imported; /* ** The context tag returned by MakeCurrent when this context is made ** current. This tag is used to identify the context that a thread has ** current so that proper server context management can be done. It is ** used for all context specific commands (i.e., Render, RenderLarge, ** WaitX, WaitGL, UseXFont, and MakeCurrent (for the old context)). */ GLXContextTag currentContextTag; /* ** The rendering mode is kept on the client as well as the server. ** When glRenderMode() is called, the buffer associated with the ** previous rendering mode (feedback or select) is filled. */ GLenum renderMode; GLfloat *feedbackBuf; GLuint *selectBuf; /* ** This is GL_TRUE if the pixel unpack modes are such that an image ** can be unpacked from the clients memory by just copying. It may ** still be true that the server will have to do some work. This ** just promises that a straight copy will fetch the correct bytes. */ GLboolean fastImageUnpack; /* ** Fill newImage with the unpacked form of oldImage getting it ** ready for transport to the server. */ void (*fillImage)(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum, GLenum, const GLvoid*, GLubyte*, GLubyte*); /* ** Client side attribs. */ __GLXattribute state; __GLXattributeMachine attributes; /* ** Client side error code. This is set when client side gl API ** routines need to set an error because of a bad enumerant or ** running out of memory, etc. */ GLenum error; /* ** Whether this context does direct rendering. */ Bool isDirect; /* ** dpy of current display for this context. Will be NULL if not ** current to any display, or if this is the "dummy context". */ Display *currentDpy; /* ** The current drawable for this context. Will be None if this ** context is not current to any drawable. currentReadable is below. */ GLXDrawable currentDrawable; /* ** Constant strings that describe the server implementation ** These pertain to GL attributes, not to be confused with ** GLX versioning attributes. */ GLubyte *vendor; GLubyte *renderer; GLubyte *version; GLubyte *extensions; /* Record the dpy this context was created on for later freeing */ Display *createDpy; /* ** Maximum small render command size. This is the smaller of 64k and ** the size of the above buffer. */ GLint maxSmallRenderCommandSize; /* ** Major opcode for the extension. Copied here so a lookup isn't ** needed. */ GLint majorOpcode; #ifdef GLX_DIRECT_RENDERING /* ** Per context direct rendering interface functions and data. */ __DRIcontext driContext; #endif /* ** Added with internal API version "20030317". */ GLXFBConfigID fbconfigID; /* ** Added with internal API version "20030606". ** ** The current read-drawable for this context. Will be None if this ** context is not current to any drawable. */ GLXDrawable currentReadable; }; #define __glXSetError(gc,code) \ if (!(gc)->error) { \ (gc)->error = code; \ } extern void __glFreeAttributeState(__GLXcontext *); /************************************************************************/ /* ** The size of the largest drawing command known to the implementation ** that will use the GLXRender glx command. In this case it is ** glPolygonStipple. */ #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156 /* ** To keep the implementation fast, the code uses a "limit" pointer ** to determine when the drawing command buffer is too full to hold ** another fixed size command. This constant defines the amount of ** space that must always be available in the drawing command buffer ** at all times for the implementation to work. It is important that ** the number be just large enough, but not so large as to reduce the ** efficacy of the buffer. The "+32" is just to keep the code working ** in case somebody counts wrong. */ #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32) /* ** This implementation uses a smaller threshold for switching ** to the RenderLarge protocol than the protcol requires so that ** large copies don't occur. */ #define __GLX_RENDER_CMD_SIZE_LIMIT 4096 /* ** One of these records exists per screen of the display. It contains ** a pointer to the config data for that screen (if the screen supports GL). */ typedef struct __GLXscreenConfigsRec { __GLcontextModes *configs; int numConfigs; __GLXvisualConfig * old_configs; int numOldConfigs; const char *serverGLXexts; char *effectiveGLXexts; #ifdef GLX_DIRECT_RENDERING /* ** Per screen direct rendering interface functions and data. */ __DRIscreen driScreen; #endif /** * Per-screen dynamic GLX extension tracking. The \c direct_support * field only contains enough bits for 64 extensions. Should libGL * ever need to track more than 64 GLX extensions, we can safely grow * this field. The \c __GLXscreenConfigs structure is not used outside * libGL. */ /*@{*/ unsigned char direct_support[8]; GLboolean ext_list_first_time; /*@}*/ } __GLXscreenConfigs; /* ** Per display private data. One of these records exists for each display ** that is using the OpenGL (GLX) extension. */ struct __GLXdisplayPrivateRec { /* ** Back pointer to the display */ Display *dpy; /* ** The majorOpcode is common to all connections to the same server. ** It is also copied into the context structure. */ int majorOpcode; /* ** Major and minor version returned by the server during initialization. */ int majorVersion, minorVersion; /* Storage for the servers GLX vendor and versions strings. These ** are the same for all screens on this display. These fields will ** be filled in on demand. */ char *serverGLXvendor; char *serverGLXversion; /* ** Configurations of visuals for all screens on this display. ** Also, per screen data which now includes the server GLX_EXTENSION ** string. */ __GLXscreenConfigs *screenConfigs; #ifdef GLX_DIRECT_RENDERING /* ** Per display direct rendering interface functions and data. */ __DRIdisplay driDisplay; #endif }; void __glXFreeContext(__GLXcontext*); extern GLubyte *__glXFlushRenderBuffer(__GLXcontext*, GLubyte*); extern void __glXSendLargeCommand(__GLXcontext *, const GLvoid *, GLint, const GLvoid *, GLint); /* Initialize the GLX extension for dpy */ extern __GLXdisplayPrivate *__glXInitialize(Display*); /************************************************************************/ extern int __glXDebug; /* This is per-thread storage in an MT environment */ #if defined(GLX_DIRECT_RENDERING) && defined(XTHREADS) extern __GLXcontext *__glXGetCurrentContext(void); extern void __glXSetCurrentContext(__GLXcontext *c); #else extern __GLXcontext *__glXcurrentContext; #define __glXGetCurrentContext() __glXcurrentContext #define __glXSetCurrentContext(gc) __glXcurrentContext = gc #endif /* ** Global lock for all threads in this address space using the GLX ** extension */ #if defined(GLX_DIRECT_RENDERING) && defined(XTHREADS) extern xmutex_rec __glXmutex; #define __glXLock() xmutex_lock(&__glXmutex) #define __glXUnlock() xmutex_unlock(&__glXmutex) #else #define __glXLock() #define __glXUnlock() #endif /* ** Setup for a command. Initialize the extension for dpy if necessary. */ extern CARD8 __glXSetupForCommand(Display *dpy); /************************************************************************/ /* ** Data conversion and packing support. */ /* Return the size, in bytes, of some pixel data */ extern GLint __glImageSize(GLint, GLint, GLint, GLenum, GLenum); /* Return the number of elements per group of a specified format*/ extern GLint __glElementsPerGroup(GLenum format, GLenum type); /* Return the number of bytes per element, based on the element type (other ** than GL_BITMAP). */ extern GLint __glBytesPerElement(GLenum type); /* Return the k value for a given map target */ extern GLint __glEvalComputeK(GLenum); /* ** Fill the transport buffer with the data from the users buffer, ** applying some of the pixel store modes (unpack modes) to the data ** first. As a side effect of this call, the "modes" field is ** updated to contain the modes needed by the server to decode the ** sent data. */ extern void __glFillImage(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum, GLenum, const GLvoid*, GLubyte*, GLubyte*); /* Copy map data with a stride into a packed buffer */ extern void __glFillMap1f(GLint, GLint, GLint, const GLfloat *, GLubyte *); extern void __glFillMap1d(GLint, GLint, GLint, const GLdouble *, GLubyte *); extern void __glFillMap2f(GLint, GLint, GLint, GLint, GLint, const GLfloat *, GLfloat *); extern void __glFillMap2d(GLint, GLint, GLint, GLint, GLint, const GLdouble *, GLdouble *); /* ** Empty an image out of the reply buffer into the clients memory applying ** the pack modes to pack back into the clients requested format. */ extern void __glEmptyImage(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum, GLenum, const GLubyte *, GLvoid *); /* ** Allocate and Initialize Vertex Array client state */ extern void __glXInitVertexArrayState(__GLXcontext*); /* ** Inform the Server of the major and minor numbers and of the client ** libraries extension string. */ extern void __glXClientInfo ( Display *dpy, int opcode ); /************************************************************************/ /* ** Declarations that should be in Xlib */ #ifdef __GL_USE_OUR_PROTOTYPES extern void _XFlush(Display*); extern Status _XReply(Display*, xReply*, int, Bool); extern void _XRead(Display*, void*, long); extern void _XSend(Display*, const void*, long); #endif /* ** GLX_BUILT_IN_XMESA controls whether libGL has a built-in verions of ** Mesa that can render to non-GLX displays. */ #ifdef GLX_BUILT_IN_XMESA #define GLX_PREFIX(function) _real_##function #else #define GLX_PREFIX(function) function #endif extern void __glXInitializeVisualConfigFromTags( __GLcontextModes *config, int count, const INT32 *bp, Bool tagged_only, Bool fbconfig_style_tags ); extern char *__glXInternalQueryServerString( Display *dpy, int opcode, int screen, int name ); extern char *__glXstrdup(const char *str); extern const char __glXGLClientExtensions[]; extern char *__glXCombineExtensionStrings( const char *cext_string, const char *sext_string ); /* Determine the internal API version */ typedef int (* PFNGLXGETINTERNALVERSIONPROC) ( void ); extern int __glXGetInternalVersion(void); extern Bool __glXWindowExists(Display *dpy, GLXDrawable draw); /* Get the unadjusted system time */ typedef int (* PFNGLXGETUSTPROC) ( int64_t * ust ); extern int __glXGetUST( int64_t * ust ); #endif /* !__GLX_client_h__ */