Add an x11drv escape that returns a glx drawable.
[wine/multimedia.git] / dlls / x11drv / opengl.c
blob9a5355c086ef1329a62d7caef9112f3e2b51287c
1 /*
2 * X11DRV OpenGL functions
4 * Copyright 2000 Lionel Ulmer
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include "config.h"
22 #include "wine/port.h"
24 #include <stdlib.h>
25 #include <string.h>
27 #include "x11drv.h"
28 #include "wine/library.h"
29 #include "wine/debug.h"
31 WINE_DEFAULT_DEBUG_CHANNEL(opengl);
33 #if defined(HAVE_GL_GL_H) && defined(HAVE_GL_GLX_H)
35 #undef APIENTRY
36 #undef CALLBACK
37 #undef WINAPI
39 #ifdef HAVE_GL_GL_H
40 # include <GL/gl.h>
41 #endif
42 #ifdef HAVE_GL_GLX_H
43 # include <GL/glx.h>
44 #endif
45 #ifdef HAVE_GL_GLEXT_H
46 # include <GL/glext.h>
47 #endif
49 #undef APIENTRY
50 #undef CALLBACK
51 #undef WINAPI
53 /* Redefines the constants */
54 #define CALLBACK __stdcall
55 #define WINAPI __stdcall
56 #define APIENTRY WINAPI
59 static void dump_PIXELFORMATDESCRIPTOR(const PIXELFORMATDESCRIPTOR *ppfd) {
60 TRACE(" - size / version : %d / %d\n", ppfd->nSize, ppfd->nVersion);
61 TRACE(" - dwFlags : ");
62 #define TEST_AND_DUMP(t,tv) if ((t) & (tv)) TRACE(#tv " ")
63 TEST_AND_DUMP(ppfd->dwFlags, PFD_DEPTH_DONTCARE);
64 TEST_AND_DUMP(ppfd->dwFlags, PFD_DOUBLEBUFFER);
65 TEST_AND_DUMP(ppfd->dwFlags, PFD_DOUBLEBUFFER_DONTCARE);
66 TEST_AND_DUMP(ppfd->dwFlags, PFD_DRAW_TO_WINDOW);
67 TEST_AND_DUMP(ppfd->dwFlags, PFD_DRAW_TO_BITMAP);
68 TEST_AND_DUMP(ppfd->dwFlags, PFD_GENERIC_ACCELERATED);
69 TEST_AND_DUMP(ppfd->dwFlags, PFD_GENERIC_FORMAT);
70 TEST_AND_DUMP(ppfd->dwFlags, PFD_NEED_PALETTE);
71 TEST_AND_DUMP(ppfd->dwFlags, PFD_NEED_SYSTEM_PALETTE);
72 TEST_AND_DUMP(ppfd->dwFlags, PFD_STEREO);
73 TEST_AND_DUMP(ppfd->dwFlags, PFD_STEREO_DONTCARE);
74 TEST_AND_DUMP(ppfd->dwFlags, PFD_SUPPORT_GDI);
75 TEST_AND_DUMP(ppfd->dwFlags, PFD_SUPPORT_OPENGL);
76 TEST_AND_DUMP(ppfd->dwFlags, PFD_SWAP_COPY);
77 TEST_AND_DUMP(ppfd->dwFlags, PFD_SWAP_EXCHANGE);
78 TEST_AND_DUMP(ppfd->dwFlags, PFD_SWAP_LAYER_BUFFERS);
79 #undef TEST_AND_DUMP
80 TRACE("\n");
82 TRACE(" - iPixelType : ");
83 switch (ppfd->iPixelType) {
84 case PFD_TYPE_RGBA: TRACE("PFD_TYPE_RGBA"); break;
85 case PFD_TYPE_COLORINDEX: TRACE("PFD_TYPE_COLORINDEX"); break;
87 TRACE("\n");
89 TRACE(" - Color : %d\n", ppfd->cColorBits);
90 TRACE(" - Red : %d\n", ppfd->cRedBits);
91 TRACE(" - Green : %d\n", ppfd->cGreenBits);
92 TRACE(" - Blue : %d\n", ppfd->cBlueBits);
93 TRACE(" - Alpha : %d\n", ppfd->cAlphaBits);
94 TRACE(" - Accum : %d\n", ppfd->cAccumBits);
95 TRACE(" - Depth : %d\n", ppfd->cDepthBits);
96 TRACE(" - Stencil : %d\n", ppfd->cStencilBits);
97 TRACE(" - Aux : %d\n", ppfd->cAuxBuffers);
99 TRACE(" - iLayerType : ");
100 switch (ppfd->iLayerType) {
101 case PFD_MAIN_PLANE: TRACE("PFD_MAIN_PLANE"); break;
102 case PFD_OVERLAY_PLANE: TRACE("PFD_OVERLAY_PLANE"); break;
103 case (BYTE)PFD_UNDERLAY_PLANE: TRACE("PFD_UNDERLAY_PLANE"); break;
105 TRACE("\n");
108 /* No need to load any other libraries as according to the ABI, libGL should be self-sufficient and
109 include all dependencies
111 #ifndef SONAME_LIBGL
112 #define SONAME_LIBGL "libGL.so"
113 #endif
115 #define MAKE_FUNCPTR(f) static typeof(f) * p##f;
116 MAKE_FUNCPTR(glGetError)
117 MAKE_FUNCPTR(glXChooseVisual)
118 MAKE_FUNCPTR(glXGetConfig)
119 MAKE_FUNCPTR(glXSwapBuffers)
120 MAKE_FUNCPTR(glXQueryExtension)
122 MAKE_FUNCPTR(glXGetFBConfigs)
123 MAKE_FUNCPTR(glXChooseFBConfig)
124 MAKE_FUNCPTR(glXGetFBConfigAttrib)
125 MAKE_FUNCPTR(glXCreateGLXPixmap)
126 MAKE_FUNCPTR(glXDestroyGLXPixmap)
127 #undef MAKE_FUNCPTR
129 static BOOL has_opengl(void)
131 static int init_done;
132 static void *opengl_handle;
134 int error_base, event_base;
136 if (init_done) return (opengl_handle != NULL);
137 init_done = 1;
139 opengl_handle = wine_dlopen(SONAME_LIBGL, RTLD_NOW|RTLD_GLOBAL, NULL, 0);
140 if (opengl_handle == NULL) return FALSE;
142 #define LOAD_FUNCPTR(f) if((p##f = wine_dlsym(opengl_handle, #f, NULL, 0)) == NULL) goto sym_not_found;
143 LOAD_FUNCPTR(glGetError)
144 LOAD_FUNCPTR(glXChooseVisual)
145 LOAD_FUNCPTR(glXGetConfig)
146 LOAD_FUNCPTR(glXSwapBuffers)
147 LOAD_FUNCPTR(glXQueryExtension)
149 LOAD_FUNCPTR(glXGetFBConfigs)
150 LOAD_FUNCPTR(glXChooseFBConfig)
151 LOAD_FUNCPTR(glXGetFBConfigAttrib)
152 LOAD_FUNCPTR(glXCreateGLXPixmap)
153 LOAD_FUNCPTR(glXDestroyGLXPixmap)
154 #undef LOAD_FUNCPTR
156 wine_tsx11_lock();
157 if (pglXQueryExtension(gdi_display, &event_base, &error_base) == True) {
158 TRACE("GLX is up and running error_base = %d\n", error_base);
159 } else {
160 wine_dlclose(opengl_handle, NULL, 0);
161 opengl_handle = NULL;
163 wine_tsx11_unlock();
164 return (opengl_handle != NULL);
166 sym_not_found:
167 wine_dlclose(opengl_handle, NULL, 0);
168 opengl_handle = NULL;
169 return FALSE;
172 #define TEST_AND_ADD1(t,a) if (t) att_list[att_pos++] = (a)
173 #define TEST_AND_ADD2(t,a,b) if (t) { att_list[att_pos++] = (a); att_list[att_pos++] = (b); }
174 #define NULL_TEST_AND_ADD2(tv,a,b) att_list[att_pos++] = (a); att_list[att_pos++] = ((tv) == 0 ? 0 : (b))
175 #define ADD2(a,b) att_list[att_pos++] = (a); att_list[att_pos++] = (b)
178 * X11DRV_ChoosePixelFormat
180 * Equivalent of glXChooseVisual
182 int X11DRV_ChoosePixelFormat(X11DRV_PDEVICE *physDev,
183 const PIXELFORMATDESCRIPTOR *ppfd) {
184 int att_list[64];
185 int att_pos = 0;
186 GLXFBConfig* cfgs = NULL;
187 int ret = 0;
189 if (!has_opengl()) {
190 ERR("No libGL on this box - disabling OpenGL support !\n");
191 return 0;
194 if (TRACE_ON(opengl)) {
195 TRACE("(%p,%p)\n", physDev, ppfd);
197 dump_PIXELFORMATDESCRIPTOR((const PIXELFORMATDESCRIPTOR *) ppfd);
200 if (ppfd->dwFlags & PFD_DRAW_TO_BITMAP) {
201 ERR("Flag not supported !\n");
202 /* Should SetError here... */
203 return 0;
206 /* Now, build the request to GLX */
207 TEST_AND_ADD2(ppfd->dwFlags & PFD_DOUBLEBUFFER, GLX_DOUBLEBUFFER, TRUE);
208 TEST_AND_ADD1(ppfd->dwFlags & PFD_STEREO, GLX_STEREO);
210 if (ppfd->iPixelType == PFD_TYPE_COLORINDEX) {
211 ADD2(GLX_BUFFER_SIZE, ppfd->cColorBits);
213 if (ppfd->iPixelType == PFD_TYPE_RGBA) {
214 ADD2(GLX_RENDER_TYPE, GLX_RGBA_BIT);
215 ADD2(GLX_BUFFER_SIZE, ppfd->cColorBits);
216 if (32 == ppfd->cDepthBits) {
218 * for 32 bpp depth buffers force to use 24.
219 * needed as some drivers don't support 32bpp
221 TEST_AND_ADD2(ppfd->cDepthBits, GLX_DEPTH_SIZE, 24);
222 } else {
223 TEST_AND_ADD2(ppfd->cDepthBits, GLX_DEPTH_SIZE, ppfd->cDepthBits);
225 TEST_AND_ADD2(ppfd->cAlphaBits, GLX_ALPHA_SIZE, ppfd->cAlphaBits);
227 TEST_AND_ADD2(ppfd->cStencilBits, GLX_STENCIL_SIZE, ppfd->cStencilBits);
228 TEST_AND_ADD2(ppfd->cAuxBuffers, GLX_AUX_BUFFERS, ppfd->cAuxBuffers);
230 /* These flags are not supported yet...
231 ADD2(GLX_ACCUM_SIZE, ppfd->cAccumBits);
233 att_list[att_pos] = None;
235 wine_tsx11_lock();
237 int nCfgs = 0;
238 int gl_test = 0;
239 int fmt_id;
241 GLXFBConfig* cfgs_fmt = NULL;
242 int nCfgs_fmt = 0;
243 int tmp_fmt_id;
244 UINT it_fmt;
246 cfgs = pglXChooseFBConfig(gdi_display, DefaultScreen(gdi_display), att_list, &nCfgs);
247 if (NULL == cfgs || 0 == nCfgs) {
248 ERR("glXChooseFBConfig returns NULL (glError: %d)\n", pglGetError());
249 ret = 0;
250 goto choose_exit;
253 gl_test = pglXGetFBConfigAttrib(gdi_display, cfgs[0], GLX_FBCONFIG_ID, &fmt_id);
254 if (gl_test) {
255 ERR("Failed to retrieve FBCONFIG_ID from GLXFBConfig, expect problems.\n");
256 ret = 0;
257 goto choose_exit;
260 cfgs_fmt = pglXGetFBConfigs(gdi_display, DefaultScreen(gdi_display), &nCfgs_fmt);
261 if (NULL == cfgs_fmt) {
262 ERR("Failed to get All FB Configs\n");
263 ret = 0;
264 goto choose_exit;
267 for (it_fmt = 0; it_fmt < nCfgs_fmt; ++it_fmt) {
268 gl_test = pglXGetFBConfigAttrib(gdi_display, cfgs_fmt[it_fmt], GLX_FBCONFIG_ID, &tmp_fmt_id);
269 if (gl_test) {
270 ERR("Failed to retrieve FBCONFIG_ID from GLXFBConfig, expect problems.\n");
271 XFree(cfgs_fmt);
272 ret = 0;
273 goto choose_exit;
275 if (fmt_id == tmp_fmt_id) {
276 ret = it_fmt + 1;
277 break ;
280 if (it_fmt == nCfgs_fmt) {
281 ERR("Failed to get valid fmt for FBCONFIG_ID(%d)\n", fmt_id);
282 ret = 0;
284 XFree(cfgs_fmt);
287 choose_exit:
288 if (NULL != cfgs) XFree(cfgs);
289 wine_tsx11_unlock();
290 return ret;
294 * X11DRV_DescribePixelFormat
296 * Get the pixel-format descriptor associated to the given id
298 int X11DRV_DescribePixelFormat(X11DRV_PDEVICE *physDev,
299 int iPixelFormat,
300 UINT nBytes,
301 PIXELFORMATDESCRIPTOR *ppfd) {
302 /*XVisualInfo *vis;*/
303 int value;
304 int rb,gb,bb,ab;
306 GLXFBConfig* cfgs = NULL;
307 GLXFBConfig cur;
308 int nCfgs = 0;
309 int ret = 0;
311 if (!has_opengl()) {
312 ERR("No libGL on this box - disabling OpenGL support !\n");
313 return 0;
316 TRACE("(%p,%d,%d,%p)\n", physDev, iPixelFormat, nBytes, ppfd);
318 wine_tsx11_lock();
319 cfgs = pglXGetFBConfigs(gdi_display, DefaultScreen(gdi_display), &nCfgs);
320 wine_tsx11_unlock();
322 if (NULL == cfgs || 0 == nCfgs) {
323 ERR("unexpected iPixelFormat(%d), returns NULL\n", iPixelFormat);
324 return 0; /* unespected error */
327 if (ppfd == NULL) {
328 /* The application is only querying the number of visuals */
329 wine_tsx11_lock();
330 if (NULL != cfgs) XFree(cfgs);
331 wine_tsx11_unlock();
332 return nCfgs;
335 if (nBytes < sizeof(PIXELFORMATDESCRIPTOR)) {
336 ERR("Wrong structure size !\n");
337 /* Should set error */
338 return 0;
341 if (nCfgs < iPixelFormat) {
342 ERR("unexpected iPixelFormat(%d) > nFormats(%d), returns NULL\n", iPixelFormat, nCfgs);
343 return 0; /* unespected error */
346 ret = nCfgs;
347 cur = cfgs[iPixelFormat - 1];
349 memset(ppfd, 0, sizeof(PIXELFORMATDESCRIPTOR));
350 ppfd->nSize = sizeof(PIXELFORMATDESCRIPTOR);
351 ppfd->nVersion = 1;
353 /* These flags are always the same... */
354 ppfd->dwFlags = PFD_DRAW_TO_WINDOW | PFD_SUPPORT_OPENGL | PFD_GENERIC_ACCELERATED;
355 /* Now the flags extraced from the Visual */
357 wine_tsx11_lock();
359 pglXGetFBConfigAttrib(gdi_display, cur, GLX_DOUBLEBUFFER, &value); if (value) ppfd->dwFlags |= PFD_DOUBLEBUFFER;
360 pglXGetFBConfigAttrib(gdi_display, cur, GLX_STEREO, &value); if (value) ppfd->dwFlags |= PFD_STEREO;
362 /* Pixel type */
363 pglXGetFBConfigAttrib(gdi_display, cur, GLX_RENDER_TYPE, &value);
364 if (value & GLX_RGBA_BIT)
365 ppfd->iPixelType = PFD_TYPE_RGBA;
366 else
367 ppfd->iPixelType = PFD_TYPE_COLORINDEX;
369 /* Color bits */
370 pglXGetFBConfigAttrib(gdi_display, cur, GLX_BUFFER_SIZE, &value);
371 ppfd->cColorBits = value;
373 /* Red, green, blue and alpha bits / shifts */
374 if (ppfd->iPixelType == PFD_TYPE_RGBA) {
375 pglXGetFBConfigAttrib(gdi_display, cur, GLX_RED_SIZE, &rb);
376 pglXGetFBConfigAttrib(gdi_display, cur, GLX_GREEN_SIZE, &gb);
377 pglXGetFBConfigAttrib(gdi_display, cur, GLX_BLUE_SIZE, &bb);
378 pglXGetFBConfigAttrib(gdi_display, cur, GLX_ALPHA_SIZE, &ab);
380 ppfd->cRedBits = rb;
381 ppfd->cRedShift = gb + bb + ab;
382 ppfd->cBlueBits = bb;
383 ppfd->cBlueShift = ab;
384 ppfd->cGreenBits = gb;
385 ppfd->cGreenShift = bb + ab;
386 ppfd->cAlphaBits = ab;
387 ppfd->cAlphaShift = 0;
388 } else {
389 ppfd->cRedBits = 0;
390 ppfd->cRedShift = 0;
391 ppfd->cBlueBits = 0;
392 ppfd->cBlueShift = 0;
393 ppfd->cGreenBits = 0;
394 ppfd->cGreenShift = 0;
395 ppfd->cAlphaBits = 0;
396 ppfd->cAlphaShift = 0;
398 /* Accums : to do ... */
400 /* Depth bits */
401 pglXGetFBConfigAttrib(gdi_display, cur, GLX_DEPTH_SIZE, &value);
402 ppfd->cDepthBits = value;
404 /* stencil bits */
405 pglXGetFBConfigAttrib(gdi_display, cur, GLX_STENCIL_SIZE, &value);
406 ppfd->cStencilBits = value;
408 wine_tsx11_unlock();
410 /* Aux : to do ... */
412 ppfd->iLayerType = PFD_MAIN_PLANE;
414 if (TRACE_ON(opengl)) {
415 dump_PIXELFORMATDESCRIPTOR(ppfd);
418 wine_tsx11_lock();
419 if (NULL != cfgs) XFree(cfgs);
420 wine_tsx11_unlock();
422 return ret;
426 * X11DRV_GetPixelFormat
428 * Get the pixel-format id used by this DC
430 int X11DRV_GetPixelFormat(X11DRV_PDEVICE *physDev) {
431 TRACE("(%p): returns %d\n", physDev, physDev->current_pf);
433 return physDev->current_pf;
437 * X11DRV_SetPixelFormat
439 * Set the pixel-format id used by this DC
441 BOOL X11DRV_SetPixelFormat(X11DRV_PDEVICE *physDev,
442 int iPixelFormat,
443 const PIXELFORMATDESCRIPTOR *ppfd) {
444 TRACE("(%p,%d,%p)\n", physDev, iPixelFormat, ppfd);
446 physDev->current_pf = iPixelFormat;
448 return TRUE;
452 * X11DRV_SwapBuffers
454 * Swap the buffers of this DC
456 BOOL X11DRV_SwapBuffers(X11DRV_PDEVICE *physDev) {
457 if (!has_opengl()) {
458 ERR("No libGL on this box - disabling OpenGL support !\n");
459 return 0;
462 TRACE("(%p)\n", physDev);
464 wine_tsx11_lock();
465 pglXSwapBuffers(gdi_display, physDev->drawable);
466 wine_tsx11_unlock();
468 return TRUE;
471 /***********************************************************************
472 * X11DRV_setup_opengl_visual
474 * Setup the default visual used for OpenGL and Direct3D, and the desktop
475 * window (if it exists). If OpenGL isn't available, the visual is simply
476 * set to the default visual for the display
478 XVisualInfo *X11DRV_setup_opengl_visual( Display *display )
480 XVisualInfo *visual = NULL;
481 /* In order to support OpenGL or D3D, we require a double-buffered visual and stencil buffer support, */
482 int dblBuf[] = {GLX_RGBA,GLX_DEPTH_SIZE, 16, GLX_STENCIL_SIZE, 8, GLX_DOUBLEBUFFER, None};
483 if (!has_opengl()) return NULL;
485 wine_tsx11_lock();
486 visual = pglXChooseVisual(display, DefaultScreen(display), dblBuf);
487 wine_tsx11_unlock();
488 if (visual == NULL) {
489 /* fallback to no stencil */
490 int dblBuf2[] = {GLX_RGBA,GLX_DEPTH_SIZE, 16, GLX_DOUBLEBUFFER, None};
491 WARN("Failed to get a visual with at least 8 bits of stencil\n");
493 wine_tsx11_lock();
494 visual = pglXChooseVisual(display, DefaultScreen(display), dblBuf2);
495 wine_tsx11_unlock();
496 if (visual == NULL) {
497 /* This should only happen if we cannot find a match with a depth size 16 */
498 FIXME("Failed to find a suitable visual\n");
499 return visual;
502 TRACE("Visual ID %lx Chosen\n",visual->visualid);
503 return visual;
506 XID create_glxpixmap(X11DRV_PDEVICE *physDev)
508 GLXPixmap ret;
509 XVisualInfo *vis;
510 XVisualInfo template;
511 int num;
513 wine_tsx11_lock();
514 template.visualid = XVisualIDFromVisual(visual);
515 vis = XGetVisualInfo(gdi_display, VisualIDMask, &template, &num);
517 ret = pglXCreateGLXPixmap(gdi_display, vis, physDev->bitmap->pixmap);
518 XFree(vis);
519 wine_tsx11_unlock();
520 TRACE("return %lx\n", ret);
521 return ret;
524 BOOL destroy_glxpixmap(XID glxpixmap)
526 wine_tsx11_lock();
527 pglXDestroyGLXPixmap(gdi_display, glxpixmap);
528 wine_tsx11_unlock();
529 return TRUE;
532 #else /* no OpenGL includes */
534 void X11DRV_OpenGL_Init(Display *display)
538 /***********************************************************************
539 * ChoosePixelFormat (X11DRV.@)
541 int X11DRV_ChoosePixelFormat(X11DRV_PDEVICE *physDev,
542 const PIXELFORMATDESCRIPTOR *ppfd) {
543 ERR("No OpenGL support compiled in.\n");
545 return 0;
548 /***********************************************************************
549 * DescribePixelFormat (X11DRV.@)
551 int X11DRV_DescribePixelFormat(X11DRV_PDEVICE *physDev,
552 int iPixelFormat,
553 UINT nBytes,
554 PIXELFORMATDESCRIPTOR *ppfd) {
555 ERR("No OpenGL support compiled in.\n");
557 return 0;
560 /***********************************************************************
561 * GetPixelFormat (X11DRV.@)
563 int X11DRV_GetPixelFormat(X11DRV_PDEVICE *physDev) {
564 ERR("No OpenGL support compiled in.\n");
566 return 0;
569 /***********************************************************************
570 * SetPixelFormat (X11DRV.@)
572 BOOL X11DRV_SetPixelFormat(X11DRV_PDEVICE *physDev,
573 int iPixelFormat,
574 const PIXELFORMATDESCRIPTOR *ppfd) {
575 ERR("No OpenGL support compiled in.\n");
577 return FALSE;
580 /***********************************************************************
581 * SwapBuffers (X11DRV.@)
583 BOOL X11DRV_SwapBuffers(X11DRV_PDEVICE *physDev) {
584 ERR("No OpenGL support compiled in.\n");
586 return FALSE;
589 XVisualInfo *X11DRV_setup_opengl_visual( Display *display )
591 return NULL;
594 XID create_glxpixmap(X11DRV_PDEVICE *physDev)
596 return NULL;
599 BOOL destroy_glxpixmap(XID glxpixmap)
601 return FALSE;
604 #endif /* defined(HAVE_OPENGL) */