1 /*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25
26 #ifndef XMESAP_H
27 #define XMESAP_H
28
29
30 #include "c11/threads.h"
31 #include "xmesa.h"
32 #include "main/mtypes.h"
33 #include "swrast/s_context.h"
34
35
36 extern mtx_t _xmesa_lock;
37
38 extern XMesaBuffer XMesaBufferList;
39
40 /* for PF_8R8G8B24 pixel format */
41 typedef struct {
42 GLubyte b;
43 GLubyte g;
44 GLubyte r;
45 } bgr_t;
46
47
48 struct xmesa_renderbuffer;
49
50
51 /* Function pointer for clearing color buffers */
52 typedef void (*ClearFunc)( struct gl_context *ctx, struct xmesa_renderbuffer *xrb,
53 GLint x, GLint y, GLint width, GLint height );
54
55
56
57
58 /** Framebuffer pixel formats */
59 enum pixel_format {
60 PF_Truecolor, /**< TrueColor or DirectColor, any depth */
61 PF_Dither_True, /**< TrueColor with dithering */
62 PF_8A8R8G8B, /**< 32-bit TrueColor: 8-A, 8-R, 8-G, 8-B bits */
63 PF_8A8B8G8R, /**< 32-bit TrueColor: 8-A, 8-B, 8-G, 8-R bits */
64 PF_8R8G8B, /**< 32-bit TrueColor: 8-R, 8-G, 8-B bits */
65 PF_8R8G8B24, /**< 24-bit TrueColor: 8-R, 8-G, 8-B bits */
66 PF_5R6G5B, /**< 16-bit TrueColor: 5-R, 6-G, 5-B bits */
67 PF_Dither_5R6G5B /**< 16-bit dithered TrueColor: 5-R, 6-G, 5-B */
68 };
69
70
71 /**
72 * Visual inforation, derived from struct gl_config.
73 * Basically corresponds to an XVisualInfo.
74 */
75 struct xmesa_visual {
76 struct gl_config mesa_visual; /* Device independent visual parameters */
77 XMesaDisplay *display; /* The X11 display */
78 int screen, visualID;
79 int visualType;
80 XMesaVisualInfo visinfo; /* X's visual info (pointer to private copy) */
81 GLint BitsPerPixel; /* True bits per pixel for XImages */
82
83 GLboolean ximage_flag; /* Use XImage for back buffer (not pixmap)? */
84
85 enum pixel_format dithered_pf; /* Pixel format when dithering */
86 enum pixel_format undithered_pf;/* Pixel format when not dithering */
87
88 GLfloat RedGamma; /* Gamma values, 1.0 is default */
89 GLfloat GreenGamma;
90 GLfloat BlueGamma;
91
92 /* For PF_TRUECOLOR */
93 GLint rshift, gshift, bshift;/* Pixel color component shifts */
94 GLubyte Kernel[16]; /* Dither kernel */
95 unsigned long RtoPixel[512]; /* RGB to pixel conversion */
96 unsigned long GtoPixel[512];
97 unsigned long BtoPixel[512];
98 GLubyte PixelToR[256]; /* Pixel to RGB conversion */
99 GLubyte PixelToG[256];
100 GLubyte PixelToB[256];
101 };
102
103
104 /**
105 * Context info, derived from struct gl_context.
106 * Basically corresponds to a GLXContext.
107 */
108 struct xmesa_context {
109 struct gl_context mesa; /* the core library context (containment) */
110 XMesaVisual xm_visual; /* Describes the buffers */
111 XMesaBuffer xm_buffer; /* current span/point/line/triangle buffer */
112
113 XMesaDisplay *display; /* == xm_visual->display */
114 GLboolean swapbytes; /* Host byte order != display byte order? */
115 GLboolean direct; /* Direct rendering context? */
116
117 enum pixel_format pixelformat;
118
119 GLubyte clearcolor[4]; /* current clearing color */
120 unsigned long clearpixel; /* current clearing pixel value */
121 };
122
123
124 /**
125 * Types of X/GLX drawables we might render into.
126 */
127 typedef enum {
128 WINDOW, /* An X window */
129 GLXWINDOW, /* GLX window */
130 PIXMAP, /* GLX pixmap */
131 PBUFFER /* GLX Pbuffer */
132 } BufferType;
133
134
135 /** Values for db_mode: */
136 /*@{*/
137 #define BACK_PIXMAP 1
138 #define BACK_XIMAGE 2
139 /*@}*/
140
141
142 /**
143 * An xmesa_renderbuffer represents the back or front color buffer.
144 * For the front color buffer:
145 * <drawable> is the X window
146 * For the back color buffer:
147 * Either <ximage> or <pixmap> will be used, never both.
148 * In any case, <drawable> always equals <pixmap>.
149 * For stand-alone Mesa, we could merge <drawable> and <pixmap> into one
150 * field. We don't do that for the server-side GLcore module because
151 * pixmaps and drawables are different and we'd need a bunch of casts.
152 */
153 struct xmesa_renderbuffer
154 {
155 struct swrast_renderbuffer Base; /* Base class */
156
157 XMesaBuffer Parent; /**< The XMesaBuffer this renderbuffer belongs to */
158 XMesaDrawable drawable; /* Usually the X window ID */
159 XMesaPixmap pixmap; /* Back color buffer */
160 XMesaImage *ximage; /* The back buffer, if not using a Pixmap */
161
162 GLushort *origin2; /* used for PIXEL_ADDR2 macro */
163 GLint width2;
164 GLubyte *origin3; /* used for PIXEL_ADDR3 macro */
165 GLint width3;
166 GLuint *origin4; /* used for PIXEL_ADDR4 macro */
167 GLint width4;
168
169 GLint bottom; /* used for FLIP macro, equals height - 1 */
170
171 ClearFunc clearFunc;
172
173 GLuint map_x, map_y, map_w, map_h;
174 GLbitfield map_mode;
175 XMesaImage *map_ximage;
176 };
177
178
179 /**
180 * Framebuffer information, derived from.
181 * Basically corresponds to a GLXDrawable.
182 */
183 struct xmesa_buffer {
184 struct gl_framebuffer mesa_buffer; /* depth, stencil, accum, etc buffers */
185 /* This MUST BE FIRST! */
186 GLboolean wasCurrent; /* was ever the current buffer? */
187 XMesaVisual xm_visual; /* the X/Mesa visual */
188
189 XMesaDisplay *display;
190 BufferType type; /* window, pixmap, pbuffer or glxwindow */
191
192 GLboolean largestPbuffer; /**< for pbuffers */
193 GLboolean preservedContents; /**< for pbuffers */
194
195 struct xmesa_renderbuffer *frontxrb; /* front color renderbuffer */
196 struct xmesa_renderbuffer *backxrb; /* back color renderbuffer */
197
198 XMesaColormap cmap; /* the X colormap */
199
200 unsigned long selectedEvents;/* for pbuffers only */
201
202 GLint db_mode; /* 0 = single buffered */
203 /* BACK_PIXMAP = use Pixmap for back buffer */
204 /* BACK_XIMAGE = use XImage for back buffer */
205 GLuint shm; /* X Shared Memory extension status: */
206 /* 0 = not available */
207 /* 1 = XImage support available */
208 /* 2 = Pixmap support available too */
209 #if defined(USE_XSHM)
210 XShmSegmentInfo shminfo;
211 #endif
212
213 // XMesaImage *rowimage; /* Used for optimized span writing */
214 XMesaPixmap stipple_pixmap; /* For polygon stippling */
215 XMesaGC stipple_gc; /* For polygon stippling */
216
217 XMesaGC gc; /* scratch GC for span, line, tri drawing */
218 XMesaGC cleargc; /* GC for clearing the color buffer */
219 XMesaGC swapgc; /* GC for swapping the color buffers */
220
221 /* The following are here instead of in the XMesaVisual
222 * because they depend on the window's colormap.
223 */
224
225 /* For PF_DITHER, PF_LOOKUP, PF_GRAYSCALE */
226 unsigned long color_table[576]; /* RGB -> pixel value */
227
228 /* For PF_DITHER, PF_LOOKUP, PF_GRAYSCALE */
229 GLubyte pixel_to_r[65536]; /* pixel value -> red */
230 GLubyte pixel_to_g[65536]; /* pixel value -> green */
231 GLubyte pixel_to_b[65536]; /* pixel value -> blue */
232
233 /* Used to do XAllocColor/XFreeColors accounting: */
234 int num_alloced;
235 unsigned long alloced_colors[256];
236
237 /* GLX_EXT_texture_from_pixmap */
238 GLint TextureTarget; /** GLX_TEXTURE_1D_EXT, for example */
239 GLint TextureFormat; /** GLX_TEXTURE_FORMAT_RGB_EXT, for example */
240 GLint TextureMipmap; /** 0 or 1 */
241
242 struct xmesa_buffer *Next; /* Linked list pointer: */
243 };
244
245
246 /**
247 * If pixelformat==PF_TRUECOLOR:
248 */
249 #define PACK_TRUECOLOR( PIXEL, R, G, B ) \
250 PIXEL = xmesa->xm_visual->RtoPixel[R] \
251 | xmesa->xm_visual->GtoPixel[G] \
252 | xmesa->xm_visual->BtoPixel[B];
253
254
255 /**
256 * If pixelformat==PF_TRUEDITHER:
257 */
258 #define PACK_TRUEDITHER( PIXEL, X, Y, R, G, B ) \
259 { \
260 int d = xmesa->xm_visual->Kernel[((X)&3) | (((Y)&3)<<2)]; \
261 PIXEL = xmesa->xm_visual->RtoPixel[(R)+d] \
262 | xmesa->xm_visual->GtoPixel[(G)+d] \
263 | xmesa->xm_visual->BtoPixel[(B)+d]; \
264 }
265
266
267
268 /**
269 * If pixelformat==PF_8A8B8G8R:
270 */
271 #define PACK_8A8B8G8R( R, G, B, A ) \
272 ( ((A) << 24) | ((B) << 16) | ((G) << 8) | (R) )
273
274
275 /**
276 * Like PACK_8A8B8G8R() but don't use alpha. This is usually an acceptable
277 * shortcut.
278 */
279 #define PACK_8B8G8R( R, G, B ) ( ((B) << 16) | ((G) << 8) | (R) )
280
281
282
283 /**
284 * If pixelformat==PF_8R8G8B:
285 */
286 #define PACK_8R8G8B( R, G, B) ( ((R) << 16) | ((G) << 8) | (B) )
287
288
289 /**
290 * If pixelformat==PF_5R6G5B:
291 */
292 #define PACK_5R6G5B( R, G, B) ( (((R) & 0xf8) << 8) | (((G) & 0xfc) << 3) | ((B) >> 3) )
293
294
295 /**
296 * If pixelformat==PF_8A8R8G8B:
297 */
298 #define PACK_8A8R8G8B( R, G, B, A ) \
299 ( ((A) << 24) | ((R) << 16) | ((G) << 8) | (B) )
300
301
302
303
304 /**
305 * Converts a GL window Y coord to an X window Y coord:
306 */
307 #define YFLIP(XRB, Y) ((XRB)->bottom - (Y))
308
309
310 /**
311 * Return the address of a 2, 3 or 4-byte pixel in the buffer's XImage:
312 * X==0 is left, Y==0 is bottom.
313 */
314 #define PIXEL_ADDR2(XRB, X, Y) \
315 ( (XRB)->origin2 - (Y) * (XRB)->width2 + (X) )
316
317 #define PIXEL_ADDR3(XRB, X, Y) \
318 ( (bgr_t *) ( (XRB)->origin3 - (Y) * (XRB)->width3 + 3 * (X) ))
319
320 #define PIXEL_ADDR4(XRB, X, Y) \
321 ( (XRB)->origin4 - (Y) * (XRB)->width4 + (X) )
322
323
324
325 /*
326 * External functions:
327 */
328
329 extern struct xmesa_renderbuffer *
330 xmesa_new_renderbuffer(struct gl_context *ctx, GLuint name,
331 const struct xmesa_visual *xmvis,
332 GLboolean backBuffer);
333
334 extern void
335 xmesa_delete_framebuffer(struct gl_framebuffer *fb);
336
337 extern XMesaBuffer
338 xmesa_find_buffer(XMesaDisplay *dpy, XMesaColormap cmap, XMesaBuffer notThis);
339
340 extern unsigned long
341 xmesa_color_to_pixel( struct gl_context *ctx,
342 GLubyte r, GLubyte g, GLubyte b, GLubyte a,
343 GLuint pixelFormat );
344
345 extern void
346 xmesa_get_window_size(XMesaDisplay *dpy, XMesaBuffer b,
347 GLuint *width, GLuint *height);
348
349 extern void
350 xmesa_check_and_update_buffer_size(XMesaContext xmctx, XMesaBuffer drawBuffer);
351
352 extern void
353 xmesa_init_driver_functions( XMesaVisual xmvisual,
354 struct dd_function_table *driver );
355
356 extern void
357 xmesa_MapRenderbuffer(struct gl_context *ctx,
358 struct gl_renderbuffer *rb,
359 GLuint x, GLuint y, GLuint w, GLuint h,
360 GLbitfield mode,
361 GLubyte **mapOut, GLint *rowStrideOut,
362 bool flip_y);
363
364 extern void
365 xmesa_UnmapRenderbuffer(struct gl_context *ctx, struct gl_renderbuffer *rb);
366
367 extern void
368 xmesa_destroy_buffers_on_display(XMesaDisplay *dpy);
369
370
371 /**
372 * Using a function instead of an ordinary cast is safer.
373 */
374 static inline struct xmesa_renderbuffer *
xmesa_renderbuffer(struct gl_renderbuffer * rb)375 xmesa_renderbuffer(struct gl_renderbuffer *rb)
376 {
377 return (struct xmesa_renderbuffer *) rb;
378 }
379
380
381 /**
382 * Return pointer to XMesaContext corresponding to a Mesa struct gl_context.
383 * Since we're using structure containment, it's just a cast!.
384 */
385 static inline XMesaContext
XMESA_CONTEXT(struct gl_context * ctx)386 XMESA_CONTEXT(struct gl_context *ctx)
387 {
388 return (XMesaContext) ctx;
389 }
390
391
392 /**
393 * Return pointer to XMesaBuffer corresponding to a Mesa struct gl_framebuffer.
394 * Since we're using structure containment, it's just a cast!.
395 */
396 static inline XMesaBuffer
XMESA_BUFFER(struct gl_framebuffer * b)397 XMESA_BUFFER(struct gl_framebuffer *b)
398 {
399 return (XMesaBuffer) b;
400 }
401
402
403 /* Plugged into the software rasterizer. Try to use internal
404 * swrast-style point, line and triangle functions.
405 */
406 extern void xmesa_choose_point( struct gl_context *ctx );
407 extern void xmesa_choose_line( struct gl_context *ctx );
408 extern void xmesa_choose_triangle( struct gl_context *ctx );
409
410
411 extern void xmesa_register_swrast_functions( struct gl_context *ctx );
412
413
414
415 #if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
416 #define ENABLE_EXT_timer_query 1 /* should have 64-bit GLuint64EXT */
417 #else
418 #define ENABLE_EXT_timer_query 0 /* may not have 64-bit GLuint64EXT */
419 #endif
420
421
422 #define TEST_META_FUNCS 0
423
424
425 #endif
426