Introduce __GLXDRIscreen so we can start moving function pointers in there.
[mesa.git] / src / glx / x11 / glxclient.h
1 /*
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:
9 **
10 ** http://oss.sgi.com/projects/FreeB
11 **
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.
17 **
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.
23 **
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.
33 */
34 /* $XFree86: xc/lib/GL/glx/glxclient.h,v 1.21 2004/02/09 23:46:31 alanh Exp $ */
35
36 /**
37 * \file glxclient.h
38 * Direct rendering support added by Precision Insight, Inc.
39 *
40 * \author Kevin E. Martin <kevin@precisioninsight.com>
41 */
42
43 #ifndef _GLX_client_h_
44 #define _GLX_client_h_
45 #define NEED_REPLIES
46 #define NEED_EVENTS
47 #include <X11/Xproto.h>
48 #include <X11/Xlibint.h>
49 #define GLX_GLXEXT_PROTOTYPES
50 #include <GL/glx.h>
51 #include <GL/glxext.h>
52 #include <string.h>
53 #include <stdlib.h>
54 #include <stdio.h>
55 #ifdef WIN32
56 #include <stdint.h>
57 #endif
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 #include "glxhash.h"
64 #if defined( USE_XTHREADS )
65 # include <X11/Xthreads.h>
66 #elif defined( PTHREADS )
67 # include <pthread.h>
68 #endif
69
70 #define GLX_MAJOR_VERSION 1 /* current version numbers */
71 #define GLX_MINOR_VERSION 4
72
73 #define __GLX_MAX_TEXTURE_UNITS 32
74
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;
80
81 /************************************************************************/
82
83 #ifdef GLX_DIRECT_RENDERING
84
85 #define containerOf(ptr, type, member) \
86 (type *)( (char *)ptr - offsetof(type,member) )
87
88 #include <GL/internal/dri_interface.h>
89
90
91 /**
92 * Display dependent methods. This structure is initialized during the
93 * \c driCreateDisplay call.
94 */
95 typedef struct __GLXDRIdisplayRec __GLXDRIdisplay;
96 typedef struct __GLXDRIscreenRec __GLXDRIscreen;
97
98 struct __GLXDRIdisplayRec {
99 /**
100 * Method to destroy the private DRI display data.
101 */
102 void (*destroyDisplay)(__GLXDRIdisplay *display);
103
104 __GLXDRIscreen *(*createScreen)(__GLXscreenConfigs *psc, int screen,
105 __GLXdisplayPrivate *priv);
106 };
107
108 struct __GLXDRIscreenRec {
109
110 void (*destroyScreen)(__GLXscreenConfigs *psc);
111
112 void (*createContext)(__GLXscreenConfigs *psc,
113 const __GLcontextModes *mode,
114 GLXContext gc, GLXContext shareList, int renderType);
115 };
116
117 /*
118 ** Function to create and DRI display data and initialize the display
119 ** dependent methods.
120 */
121 extern __GLXDRIdisplay *driCreateDisplay(Display *dpy);
122
123 extern void DRI_glXUseXFont( Font font, int first, int count, int listbase );
124
125 /*
126 ** Functions to obtain driver configuration information from a direct
127 ** rendering client application
128 */
129 extern const char *glXGetScreenDriver (Display *dpy, int scrNum);
130
131 extern const char *glXGetDriverConfig (const char *driverName);
132
133 extern Bool __glXWindowExists(Display *dpy, GLXDrawable draw);
134
135 #endif
136
137 /************************************************************************/
138
139 #define __GL_CLIENT_ATTRIB_STACK_DEPTH 16
140
141 typedef struct __GLXpixelStoreModeRec {
142 GLboolean swapEndian;
143 GLboolean lsbFirst;
144 GLuint rowLength;
145 GLuint imageHeight;
146 GLuint imageDepth;
147 GLuint skipRows;
148 GLuint skipPixels;
149 GLuint skipImages;
150 GLuint alignment;
151 } __GLXpixelStoreMode;
152
153
154 typedef struct __GLXattributeRec {
155 GLuint mask;
156
157 /**
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.
161 */
162 __GLXpixelStoreMode storePack, storeUnpack;
163
164 /**
165 * Is EXT_vertex_array / GL 1.1 DrawArrays protocol specifically
166 * disabled?
167 */
168 GLboolean NoDrawArraysProtocol;
169
170 /**
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.
174 */
175 struct array_state_vector * array_state;
176 } __GLXattribute;
177
178 typedef struct __GLXattributeMachineRec {
179 __GLXattribute *stack[__GL_CLIENT_ATTRIB_STACK_DEPTH];
180 __GLXattribute **stackPointer;
181 } __GLXattributeMachine;
182
183 /**
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.
186 */
187 struct __GLXcontextRec {
188 /**
189 * \name Drawing command buffer.
190 *
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
195 * slop discussion.
196 *
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
199 * command.
200 *
201 * These must be the first 6 fields since they are static initialized
202 * in the dummy context in glxext.c
203 */
204 /*@{*/
205 GLubyte *buf;
206 GLubyte *pc;
207 GLubyte *limit;
208 GLubyte *bufEnd;
209 GLint bufSize;
210 /*@}*/
211
212 /**
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.
217 */
218 XID xid;
219
220 /**
221 * The XID of the \c shareList context.
222 */
223 XID share_xid;
224
225 /**
226 * Screen number.
227 */
228 GLint screen;
229 __GLXscreenConfigs *psc;
230
231 /**
232 * \c GL_TRUE if the context was created with ImportContext, which
233 * means the server-side context was created by another X client.
234 */
235 GLboolean imported;
236
237 /**
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
243 * context)).
244 */
245 GLXContextTag currentContextTag;
246
247 /**
248 * \name Rendering mode
249 *
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.
253 */
254 /*@{*/
255 GLenum renderMode;
256 GLfloat *feedbackBuf;
257 GLuint *selectBuf;
258 /*@}*/
259
260 /**
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.
265 */
266 GLboolean fastImageUnpack;
267
268 /**
269 * Fill newImage with the unpacked form of \c oldImage getting it
270 * ready for transport to the server.
271 */
272 void (*fillImage)(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum,
273 GLenum, const GLvoid*, GLubyte*, GLubyte*);
274
275 /**
276 * Client side attribs.
277 */
278 __GLXattributeMachine attributes;
279
280 /**
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.
284 */
285 GLenum error;
286
287 /**
288 * Whether this context does direct rendering.
289 */
290 Bool isDirect;
291
292 /**
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".
295 */
296 Display *currentDpy;
297
298 /**
299 * The current drawable for this context. Will be None if this
300 * context is not current to any drawable. currentReadable is below.
301 */
302 GLXDrawable currentDrawable;
303
304 /**
305 * \name GL Constant Strings
306 *
307 * Constant strings that describe the server implementation
308 * These pertain to GL attributes, not to be confused with
309 * GLX versioning attributes.
310 */
311 /*@{*/
312 GLubyte *vendor;
313 GLubyte *renderer;
314 GLubyte *version;
315 GLubyte *extensions;
316 /*@}*/
317
318 /**
319 * Record the dpy this context was created on for later freeing
320 */
321 Display *createDpy;
322
323 /**
324 * Maximum small render command size. This is the smaller of 64k and
325 * the size of the above buffer.
326 */
327 GLint maxSmallRenderCommandSize;
328
329 /**
330 * Major opcode for the extension. Copied here so a lookup isn't
331 * needed.
332 */
333 GLint majorOpcode;
334
335 /**
336 * Pointer to the mode used to create this context.
337 */
338 const __GLcontextModes * mode;
339
340 #ifdef GLX_DIRECT_RENDERING
341 /**
342 * Per context direct rendering interface functions and data.
343 */
344 __DRIcontext driContext;
345
346 /**
347 * XID for the server side drm_context_t
348 */
349 XID hwContextID;
350 #endif
351
352 /**
353 * The current read-drawable for this context. Will be None if this
354 * context is not current to any drawable.
355 *
356 * \since Internal API version 20030606.
357 */
358 GLXDrawable currentReadable;
359
360 /**
361 * Pointer to client-state data that is private to libGL. This is only
362 * used for indirect rendering contexts.
363 *
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.
366 */
367 void * client_state_private;
368
369 /**
370 * Stored value for \c glXQueryContext attribute \c GLX_RENDER_TYPE.
371 */
372 int renderType;
373
374 /**
375 * \name Raw server GL version
376 *
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.
380 */
381 /*@{*/
382 int server_major; /**< Major version number. */
383 int server_minor; /**< Minor version number. */
384 /*@}*/
385
386 char gl_extension_bits[ __GL_EXT_BYTES ];
387 };
388
389 #define __glXSetError(gc,code) \
390 if (!(gc)->error) { \
391 (gc)->error = code; \
392 }
393
394 extern void __glFreeAttributeState(__GLXcontext *);
395
396 /************************************************************************/
397
398 /**
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.
402 */
403 #define __GLX_MAX_SMALL_RENDER_CMD_SIZE 156
404
405 /**
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.
414 */
415 #define __GLX_BUFFER_LIMIT_SIZE (__GLX_MAX_SMALL_RENDER_CMD_SIZE + 32)
416
417 /**
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.
421 */
422 #define __GLX_RENDER_CMD_SIZE_LIMIT 4096
423
424 /**
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).
427 */
428 struct __GLXscreenConfigsRec {
429 /**
430 * GLX extension string reported by the X-server.
431 */
432 const char *serverGLXexts;
433
434 /**
435 * GLX extension string to be reported to applications. This is the
436 * set of extensions that the application can actually use.
437 */
438 char *effectiveGLXexts;
439
440 #ifdef GLX_DIRECT_RENDERING
441 /**
442 * Per screen direct rendering interface functions and data.
443 */
444 __DRIscreen __driScreen;
445 __glxHashTable *drawHash;
446 Display *dpy;
447 int scr;
448 void *driver;
449
450 __GLXDRIscreen *driScreen;
451
452 #ifdef __DRI_COPY_SUB_BUFFER
453 __DRIcopySubBufferExtension *copySubBuffer;
454 #endif
455
456 #ifdef __DRI_SWAP_CONTROL
457 __DRIswapControlExtension *swapControl;
458 #endif
459
460 #ifdef __DRI_ALLOCATE
461 __DRIallocateExtension *allocate;
462 #endif
463
464 #ifdef __DRI_FRAME_TRACKING
465 __DRIframeTrackingExtension *frameTracking;
466 #endif
467
468 #ifdef __DRI_MEDIA_STREAM_COUNTER
469 __DRImediaStreamCounterExtension *msc;
470 #endif
471
472 #endif
473
474 /**
475 * Linked list of glx visuals and fbconfigs for this screen.
476 */
477 __GLcontextModes *visuals, *configs;
478
479 /**
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
484 * libGL.
485 */
486 /*@{*/
487 unsigned char direct_support[8];
488 GLboolean ext_list_first_time;
489 /*@}*/
490
491 };
492
493 /**
494 * Per display private data. One of these records exists for each display
495 * that is using the OpenGL (GLX) extension.
496 */
497 struct __GLXdisplayPrivateRec {
498 /**
499 * Back pointer to the display
500 */
501 Display *dpy;
502
503 /**
504 * The \c majorOpcode is common to all connections to the same server.
505 * It is also copied into the context structure.
506 */
507 int majorOpcode;
508
509 /**
510 * \name Server Version
511 *
512 * Major and minor version returned by the server during initialization.
513 */
514 /*@{*/
515 int majorVersion, minorVersion;
516 /*@}*/
517
518 /**
519 * \name Storage for the servers GLX vendor and versions strings.
520 *
521 * These are the same for all screens on this display. These fields will
522 * be filled in on demand.
523 */
524 /*@{*/
525 const char *serverGLXvendor;
526 const char *serverGLXversion;
527 /*@}*/
528
529 /**
530 * Configurations of visuals for all screens on this display.
531 * Also, per screen data which now includes the server \c GLX_EXTENSION
532 * string.
533 */
534 __GLXscreenConfigs *screenConfigs;
535
536 #ifdef GLX_DIRECT_RENDERING
537 /**
538 * Per display direct rendering interface functions and data.
539 */
540 __GLXDRIdisplay *driDisplay;
541 #endif
542 };
543
544 #ifdef GLX_DIRECT_RENDERING
545
546 struct __GLXdrawableRec {
547 XID drawable;
548 __GLXscreenConfigs *psc;
549 __DRIdrawable driDrawable;
550 };
551
552 #endif
553
554
555
556 void __glXFreeContext(__GLXcontext*);
557
558 extern GLubyte *__glXFlushRenderBuffer(__GLXcontext*, GLubyte*);
559
560 extern void __glXSendLargeChunk(__GLXcontext *gc, GLint requestNumber,
561 GLint totalRequests,
562 const GLvoid * data, GLint dataLen);
563
564 extern void __glXSendLargeCommand(__GLXcontext *, const GLvoid *, GLint,
565 const GLvoid *, GLint);
566
567 /* Initialize the GLX extension for dpy */
568 extern __GLXdisplayPrivate *__glXInitialize(Display*);
569
570 /************************************************************************/
571
572 extern int __glXDebug;
573
574 /* This is per-thread storage in an MT environment */
575 #if defined( USE_XTHREADS ) || defined( PTHREADS )
576
577 extern void __glXSetCurrentContext(__GLXcontext *c);
578
579 # if defined( GLX_USE_TLS )
580
581 extern __thread void * __glX_tls_Context
582 __attribute__((tls_model("initial-exec")));
583
584 # define __glXGetCurrentContext() __glX_tls_Context
585
586 # else
587
588 extern __GLXcontext *__glXGetCurrentContext(void);
589
590 # endif /* defined( GLX_USE_TLS ) */
591
592 #else
593
594 extern __GLXcontext *__glXcurrentContext;
595 #define __glXGetCurrentContext() __glXcurrentContext
596 #define __glXSetCurrentContext(gc) __glXcurrentContext = gc
597
598 #endif /* defined( USE_XTHREADS ) || defined( PTHREADS ) */
599
600
601 /*
602 ** Global lock for all threads in this address space using the GLX
603 ** extension
604 */
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)
613 #else
614 #define __glXLock()
615 #define __glXUnlock()
616 #endif
617
618 /*
619 ** Setup for a command. Initialize the extension for dpy if necessary.
620 */
621 extern CARD8 __glXSetupForCommand(Display *dpy);
622
623 /************************************************************************/
624
625 /*
626 ** Data conversion and packing support.
627 */
628
629 extern const GLuint __glXDefaultPixelStore[9];
630
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);
635
636 /* Return the size, in bytes, of some pixel data */
637 extern GLint __glImageSize(GLint, GLint, GLint, GLenum, GLenum, GLenum);
638
639 /* Return the number of elements per group of a specified format*/
640 extern GLint __glElementsPerGroup(GLenum format, GLenum type);
641
642 /* Return the number of bytes per element, based on the element type (other
643 ** than GL_BITMAP).
644 */
645 extern GLint __glBytesPerElement(GLenum type);
646
647 /*
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
652 ** sent data.
653 */
654 extern void __glFillImage(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum,
655 GLenum, const GLvoid*, GLubyte*, GLubyte*);
656
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 *);
664
665 /*
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.
668 */
669 extern void __glEmptyImage(__GLXcontext*, GLint, GLint, GLint, GLint, GLenum,
670 GLenum, const GLubyte *, GLvoid *);
671
672
673 /*
674 ** Allocate and Initialize Vertex Array client state
675 */
676 extern void __glXInitVertexArrayState(__GLXcontext*);
677
678 /*
679 ** Inform the Server of the major and minor numbers and of the client
680 ** libraries extension string.
681 */
682 extern void __glXClientInfo ( Display *dpy, int opcode );
683
684 /************************************************************************/
685
686 /*
687 ** Declarations that should be in Xlib
688 */
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);
694 #endif
695
696
697 extern void __glXInitializeVisualConfigFromTags( __GLcontextModes *config,
698 int count, const INT32 *bp, Bool tagged_only, Bool fbconfig_style_tags );
699
700 extern char * __glXGetStringFromServer( Display * dpy, int opcode,
701 CARD32 glxCode, CARD32 for_whom, CARD32 name );
702
703 extern char *__glXstrdup(const char *str);
704
705
706 extern const char __glXGLClientVersion[];
707 extern const char __glXGLClientExtensions[];
708
709 /* Get the unadjusted system time */
710 extern int __glXGetUST( int64_t * ust );
711
712 extern GLboolean __glXGetMscRateOML(Display * dpy, GLXDrawable drawable,
713 int32_t * numerator, int32_t * denominator);
714
715 #ifdef GLX_DIRECT_RENDERING
716 GLboolean
717 __driGetMscRateOML(__DRIdrawable *draw, int32_t *numerator, int32_t *denominator);
718 #endif
719
720 #endif /* !__GLX_client_h__ */