dlls/x11drv/opengl.c

   1 /*
   2  * X11DRV OpenGL functions
   3  *
   4  * Copyright 2000 Lionel Ulmer
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #include "config.h"
  22 #include "wine/port.h"
  23
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "x11drv.h"
  28 #include "wine/library.h"
  29 #include "wine/debug.h"
  30
  31 WINE_DEFAULT_DEBUG_CHANNEL(opengl);
  32
  33 #if defined(HAVE_GL_GL_H) && defined(HAVE_GL_GLX_H)
  34
  35 #undef APIENTRY
  36 #undef CALLBACK
  37 #undef WINAPI
  38
  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
  48
  49 #undef APIENTRY
  50 #undef CALLBACK
  51 #undef WINAPI
  52
  53 /* Redefines the constants */
  54 #define CALLBACK    __stdcall
  55 #define WINAPI      __stdcall
  56 #define APIENTRY    WINAPI
  57
  58
  59 static void dump_PIXELFORMATDESCRIPTOR(const PIXELFORMATDESCRIPTOR *ppfd) {
  60   DPRINTF("  - size / version : %d / %d\n", ppfd->nSize, ppfd->nVersion);
  61   DPRINTF("  - dwFlags : ");
  62 #define TEST_AND_DUMP(t,tv) if ((t) & (tv)) DPRINTF(#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   DPRINTF("\n");
  81
  82   DPRINTF("  - iPixelType : ");
  83   switch (ppfd->iPixelType) {
  84   case PFD_TYPE_RGBA: DPRINTF("PFD_TYPE_RGBA"); break;
  85   case PFD_TYPE_COLORINDEX: DPRINTF("PFD_TYPE_COLORINDEX"); break;
  86   }
  87   DPRINTF("\n");
  88
  89   DPRINTF("  - Color   : %d\n", ppfd->cColorBits);
  90   DPRINTF("  - Red     : %d\n", ppfd->cRedBits);
  91   DPRINTF("  - Green   : %d\n", ppfd->cGreenBits);
  92   DPRINTF("  - Blue    : %d\n", ppfd->cBlueBits);
  93   DPRINTF("  - Alpha   : %d\n", ppfd->cAlphaBits);
  94   DPRINTF("  - Accum   : %d\n", ppfd->cAccumBits);
  95   DPRINTF("  - Depth   : %d\n", ppfd->cDepthBits);
  96   DPRINTF("  - Stencil : %d\n", ppfd->cStencilBits);
  97   DPRINTF("  - Aux     : %d\n", ppfd->cAuxBuffers);
  98
  99   DPRINTF("  - iLayerType : ");
 100   switch (ppfd->iLayerType) {
 101   case PFD_MAIN_PLANE: DPRINTF("PFD_MAIN_PLANE"); break;
 102   case PFD_OVERLAY_PLANE: DPRINTF("PFD_OVERLAY_PLANE"); break;
 103   case PFD_UNDERLAY_PLANE: DPRINTF("PFD_UNDERLAY_PLANE"); break;
 104   }
 105   DPRINTF("\n");
 106 }
 107
 108 /* No need to load any other libraries as according to the ABI, libGL should be self-sufficient and
 109    include all dependencies
 110 */
 111 #ifndef SONAME_LIBGL
 112 #define SONAME_LIBGL "libGL.so"
 113 #endif
 114
 115 static void *opengl_handle;
 116
 117 #define MAKE_FUNCPTR(f) static typeof(f) * p##f;
 118 MAKE_FUNCPTR(glGetError)
 119 MAKE_FUNCPTR(glXChooseVisual)
 120 MAKE_FUNCPTR(glXGetConfig)
 121 MAKE_FUNCPTR(glXSwapBuffers)
 122 MAKE_FUNCPTR(glXQueryExtension)
 123
 124 MAKE_FUNCPTR(glXGetFBConfigs)
 125 MAKE_FUNCPTR(glXChooseFBConfig)
 126 MAKE_FUNCPTR(glXGetFBConfigAttrib)
 127 #undef MAKE_FUNCPTR
 128
 129 void X11DRV_OpenGL_Init(Display *display) {
 130     int error_base, event_base;
 131
 132     opengl_handle = wine_dlopen(SONAME_LIBGL, RTLD_NOW|RTLD_GLOBAL, NULL, 0);
 133     if (opengl_handle == NULL) return;
 134
 135 #define LOAD_FUNCPTR(f) if((p##f = wine_dlsym(opengl_handle, #f, NULL, 0)) == NULL) goto sym_not_found;
 136 LOAD_FUNCPTR(glGetError)
 137 LOAD_FUNCPTR(glXChooseVisual)
 138 LOAD_FUNCPTR(glXGetConfig)
 139 LOAD_FUNCPTR(glXSwapBuffers)
 140 LOAD_FUNCPTR(glXQueryExtension)
 141
 142 LOAD_FUNCPTR(glXGetFBConfigs)
 143 LOAD_FUNCPTR(glXChooseFBConfig)
 144 LOAD_FUNCPTR(glXGetFBConfigAttrib)
 145 #undef LOAD_FUNCPTR
 146
 147     wine_tsx11_lock();
 148     if (pglXQueryExtension(display, &event_base, &error_base) == True) {
 149         TRACE("GLX is up and running error_base = %d\n", error_base);
 150     } else {
 151         wine_dlclose(opengl_handle, NULL, 0);
 152         opengl_handle = NULL;
 153     }
 154     wine_tsx11_unlock();
 155     return;
 156
 157 sym_not_found:
 158     wine_dlclose(opengl_handle, NULL, 0);
 159     opengl_handle = NULL;
 160 }
 161
 162 #define TEST_AND_ADD1(t,a) if (t) att_list[att_pos++] = (a)
 163 #define TEST_AND_ADD2(t,a,b) if (t) { att_list[att_pos++] = (a); att_list[att_pos++] = (b); }
 164 #define NULL_TEST_AND_ADD2(tv,a,b) att_list[att_pos++] = (a); att_list[att_pos++] = ((tv) == 0 ? 0 : (b))
 165 #define ADD2(a,b) att_list[att_pos++] = (a); att_list[att_pos++] = (b)
 166
 167 /**
 168  * X11DRV_ChoosePixelFormat
 169  *
 170  * Equivalent of glXChooseVisual
 171  */
 172 int X11DRV_ChoosePixelFormat(X11DRV_PDEVICE *physDev,
 173                              const PIXELFORMATDESCRIPTOR *ppfd) {
 174   int att_list[64];
 175   int att_pos = 0;
 176   GLXFBConfig* cfgs = NULL;
 177   int ret = 0;
 178
 179   if (opengl_handle == NULL) {
 180     ERR("No libGL on this box - disabling OpenGL support !\n");
 181     return 0;
 182   }
 183
 184   if (TRACE_ON(opengl)) {
 185     TRACE("(%p,%p)\n", physDev, ppfd);
 186
 187     dump_PIXELFORMATDESCRIPTOR((const PIXELFORMATDESCRIPTOR *) ppfd);
 188   }
 189
 190   if (ppfd->dwFlags & PFD_DRAW_TO_BITMAP) {
 191     ERR("Flag not supported !\n");
 192     /* Should SetError here... */
 193     return 0;
 194   }
 195
 196   /* Now, build the request to GLX */
 197   TEST_AND_ADD2(ppfd->dwFlags & PFD_DOUBLEBUFFER, GLX_DOUBLEBUFFER, TRUE);
 198   TEST_AND_ADD1(ppfd->dwFlags & PFD_STEREO, GLX_STEREO);
 199
 200   if (ppfd->iPixelType == PFD_TYPE_COLORINDEX) {
 201     ADD2(GLX_BUFFER_SIZE, ppfd->cColorBits);
 202   }
 203   if (ppfd->iPixelType == PFD_TYPE_RGBA) {
 204     ADD2(GLX_RENDER_TYPE, GLX_RGBA_BIT);
 205     ADD2(GLX_BUFFER_SIZE, ppfd->cColorBits);
 206     TEST_AND_ADD2(ppfd->cDepthBits, GLX_DEPTH_SIZE, ppfd->cDepthBits);
 207     TEST_AND_ADD2(ppfd->cAlphaBits, GLX_ALPHA_SIZE, ppfd->cAlphaBits);
 208   }
 209   TEST_AND_ADD2(ppfd->cStencilBits, GLX_STENCIL_SIZE, ppfd->cStencilBits);
 210   TEST_AND_ADD2(ppfd->cAuxBuffers,  GLX_AUX_BUFFERS,  ppfd->cAuxBuffers);
 211
 212   /* These flags are not supported yet...
 213   ADD2(GLX_ACCUM_SIZE, ppfd->cAccumBits);
 214   */
 215   att_list[att_pos] = None;
 216
 217   wine_tsx11_lock();
 218   {
 219     int nCfgs = 0;
 220     int gl_test = 0;
 221     int fmt_id;
 222
 223     GLXFBConfig* cfgs_fmt = NULL;
 224     int nCfgs_fmt = 0;
 225     int tmp_fmt_id;
 226     UINT it_fmt;
 227
 228     cfgs = pglXChooseFBConfig(gdi_display, DefaultScreen(gdi_display), att_list, &nCfgs);
 229     if (NULL == cfgs || 0 == nCfgs) {
 230       ERR("glXChooseFBConfig returns NULL (glError: %d)\n", pglGetError());
 231       ret = 0;
 232       goto choose_exit;
 233     }
 234
 235     gl_test = pglXGetFBConfigAttrib(gdi_display, cfgs[0], GLX_FBCONFIG_ID, &fmt_id);
 236     if (gl_test) {
 237       ERR("Failed to retrieve FBCONFIG_ID from GLXFBConfig, expect problems.\n");
 238       ret = 0;
 239       goto choose_exit;
 240     }
 241
 242     cfgs_fmt = pglXGetFBConfigs(gdi_display, DefaultScreen(gdi_display), &nCfgs_fmt);
 243     if (NULL == cfgs_fmt) {
 244       ERR("Failed to get All FB Configs\n");
 245       ret = 0;
 246       goto choose_exit;
 247     }
 248
 249     for (it_fmt = 0; it_fmt < nCfgs_fmt; ++it_fmt) {
 250       gl_test = pglXGetFBConfigAttrib(gdi_display, cfgs_fmt[it_fmt], GLX_FBCONFIG_ID, &tmp_fmt_id);
 251       if (gl_test) {
 252         ERR("Failed to retrieve FBCONFIG_ID from GLXFBConfig, expect problems.\n");
 253         XFree(cfgs_fmt);
 254         ret = 0;
 255         goto choose_exit;
 256       }
 257       if (fmt_id == tmp_fmt_id) {
 258         ret = it_fmt + 1;
 259         break ;
 260       }
 261     }
 262     if (it_fmt == nCfgs_fmt) {
 263       ERR("Failed to get valid fmt for FBCONFIG_ID(%d)\n", fmt_id);
 264       ret = 0;
 265     }
 266     XFree(cfgs_fmt);
 267   }
 268
 269 choose_exit:
 270   if (NULL != cfgs) XFree(cfgs);
 271   wine_tsx11_unlock();
 272   return ret;
 273 }
 274
 275 /* X11DRV_DescribePixelFormat
 276
 277      Get the pixel-format descriptor associated to the given id
 278 */
 279 int X11DRV_DescribePixelFormat(X11DRV_PDEVICE *physDev,
 280                                int iPixelFormat,
 281                                UINT nBytes,
 282                                PIXELFORMATDESCRIPTOR *ppfd) {
 283   /*XVisualInfo *vis;*/
 284   int value;
 285   int rb,gb,bb,ab;
 286
 287   GLXFBConfig* cfgs = NULL;
 288   GLXFBConfig cur;
 289   int nCfgs = 0;
 290   int ret = 0;
 291
 292   if (opengl_handle == NULL) {
 293     ERR("No libGL on this box - disabling OpenGL support !\n");
 294     return 0;
 295   }
 296
 297   TRACE("(%p,%d,%d,%p)\n", physDev, iPixelFormat, nBytes, ppfd);
 298
 299   wine_tsx11_lock();
 300   cfgs = pglXGetFBConfigs(gdi_display, DefaultScreen(gdi_display), &nCfgs);
 301   wine_tsx11_unlock();
 302
 303   if (NULL == cfgs || 0 == nCfgs) {
 304     ERR("unexpected iPixelFormat(%d), returns NULL\n", iPixelFormat);
 305     return 0; /* unespected error */
 306   }
 307
 308   if (ppfd == NULL) {
 309     /* The application is only querying the number of visuals */
 310     wine_tsx11_lock();
 311     if (NULL != cfgs) XFree(cfgs);
 312     wine_tsx11_unlock();
 313     return nCfgs;
 314   }
 315
 316   if (nBytes < sizeof(PIXELFORMATDESCRIPTOR)) {
 317     ERR("Wrong structure size !\n");
 318     /* Should set error */
 319     return 0;
 320   }
 321
 322   if (nCfgs < iPixelFormat) {
 323     ERR("unexpected iPixelFormat(%d) > nFormats(%d), returns NULL\n", iPixelFormat, nCfgs);
 324     return 0; /* unespected error */
 325   }
 326
 327   ret = nCfgs;
 328   cur = cfgs[iPixelFormat - 1];
 329
 330   memset(ppfd, 0, sizeof(PIXELFORMATDESCRIPTOR));
 331   ppfd->nSize = sizeof(PIXELFORMATDESCRIPTOR);
 332   ppfd->nVersion = 1;
 333
 334   /* These flags are always the same... */
 335   ppfd->dwFlags = PFD_DRAW_TO_WINDOW | PFD_SUPPORT_OPENGL | PFD_GENERIC_ACCELERATED;
 336   /* Now the flags extraced from the Visual */
 337
 338   wine_tsx11_lock();
 339
 340   pglXGetFBConfigAttrib(gdi_display, cur, GLX_DOUBLEBUFFER, &value); if (value) ppfd->dwFlags |= PFD_DOUBLEBUFFER;
 341   pglXGetFBConfigAttrib(gdi_display, cur, GLX_STEREO, &value); if (value) ppfd->dwFlags |= PFD_STEREO;
 342
 343   /* Pixel type */
 344   pglXGetFBConfigAttrib(gdi_display, cur, GLX_RENDER_TYPE, &value);
 345   if (value & GLX_RGBA_BIT)
 346     ppfd->iPixelType = PFD_TYPE_RGBA;
 347   else
 348     ppfd->iPixelType = PFD_TYPE_COLORINDEX;
 349
 350   /* Color bits */
 351   pglXGetFBConfigAttrib(gdi_display, cur, GLX_BUFFER_SIZE, &value);
 352   ppfd->cColorBits = value;
 353
 354   /* Red, green, blue and alpha bits / shifts */
 355   if (ppfd->iPixelType == PFD_TYPE_RGBA) {
 356     pglXGetFBConfigAttrib(gdi_display, cur, GLX_RED_SIZE, &rb);
 357     pglXGetFBConfigAttrib(gdi_display, cur, GLX_GREEN_SIZE, &gb);
 358     pglXGetFBConfigAttrib(gdi_display, cur, GLX_BLUE_SIZE, &bb);
 359     pglXGetFBConfigAttrib(gdi_display, cur, GLX_ALPHA_SIZE, &ab);
 360
 361     ppfd->cRedBits = rb;
 362     ppfd->cRedShift = gb + bb + ab;
 363     ppfd->cBlueBits = bb;
 364     ppfd->cBlueShift = ab;
 365     ppfd->cGreenBits = gb;
 366     ppfd->cGreenShift = bb + ab;
 367     ppfd->cAlphaBits = ab;
 368     ppfd->cAlphaShift = 0;
 369   } else {
 370     ppfd->cRedBits = 0;
 371     ppfd->cRedShift = 0;
 372     ppfd->cBlueBits = 0;
 373     ppfd->cBlueShift = 0;
 374     ppfd->cGreenBits = 0;
 375     ppfd->cGreenShift = 0;
 376     ppfd->cAlphaBits = 0;
 377     ppfd->cAlphaShift = 0;
 378   }
 379   /* Accums : to do ... */
 380
 381   /* Depth bits */
 382   pglXGetFBConfigAttrib(gdi_display, cur, GLX_DEPTH_SIZE, &value);
 383   ppfd->cDepthBits = value;
 384
 385   /* stencil bits */
 386   pglXGetFBConfigAttrib(gdi_display, cur, GLX_STENCIL_SIZE, &value);
 387   ppfd->cStencilBits = value;
 388
 389   wine_tsx11_unlock();
 390
 391   /* Aux : to do ... */
 392
 393   ppfd->iLayerType = PFD_MAIN_PLANE;
 394
 395   if (TRACE_ON(opengl)) {
 396     dump_PIXELFORMATDESCRIPTOR(ppfd);
 397   }
 398
 399   wine_tsx11_lock();
 400   if (NULL != cfgs) XFree(cfgs);
 401   wine_tsx11_unlock();
 402
 403   return ret;
 404 }
 405
 406 /* X11DRV_GetPixelFormat
 407
 408      Get the pixel-format id used by this DC
 409 */
 410 int X11DRV_GetPixelFormat(X11DRV_PDEVICE *physDev) {
 411   TRACE("(%p): returns %d\n", physDev, physDev->current_pf);
 412
 413   return physDev->current_pf;
 414 }
 415
 416 /* X11DRV_SetPixelFormat
 417
 418      Set the pixel-format id used by this DC
 419 */
 420 BOOL X11DRV_SetPixelFormat(X11DRV_PDEVICE *physDev,
 421                            int iPixelFormat,
 422                            const PIXELFORMATDESCRIPTOR *ppfd) {
 423   TRACE("(%p,%d,%p)\n", physDev, iPixelFormat, ppfd);
 424
 425   physDev->current_pf = iPixelFormat;
 426
 427   return TRUE;
 428 }
 429
 430 /* X11DRV_SwapBuffers
 431
 432      Swap the buffers of this DC
 433 */
 434 BOOL X11DRV_SwapBuffers(X11DRV_PDEVICE *physDev) {
 435   if (opengl_handle == NULL) {
 436     ERR("No libGL on this box - disabling OpenGL support !\n");
 437     return 0;
 438   }
 439
 440   TRACE("(%p)\n", physDev);
 441
 442   wine_tsx11_lock();
 443   pglXSwapBuffers(gdi_display, physDev->drawable);
 444   wine_tsx11_unlock();
 445
 446   return TRUE;
 447 }
 448
 449 /***********************************************************************
 450  *              X11DRV_setup_opengl_visual
 451  *
 452  * Setup the default visual used for OpenGL and Direct3D, and the desktop
 453  * window (if it exists).  If OpenGL isn't available, the visual is simply
 454  * set to the default visual for the display
 455  */
 456 XVisualInfo *X11DRV_setup_opengl_visual( Display *display )
 457 {
 458     XVisualInfo *visual = NULL;
 459     int dblBuf[]={GLX_RGBA,GLX_DEPTH_SIZE,16,GLX_DOUBLEBUFFER,None};
 460
 461     if (opengl_handle == NULL) return NULL;
 462
 463     /* In order to support OpenGL or D3D, we require a double-buffered visual */
 464     wine_tsx11_lock();
 465     visual = pglXChooseVisual(display, DefaultScreen(display), dblBuf);
 466     wine_tsx11_unlock();
 467     return visual;
 468 }
 469
 470 #else  /* no OpenGL includes */
 471
 472 void X11DRV_OpenGL_Init(Display *display)
 473 {
 474 }
 475
 476 /***********************************************************************
 477  *              ChoosePixelFormat (X11DRV.@)
 478  */
 479 int X11DRV_ChoosePixelFormat(X11DRV_PDEVICE *physDev,
 480                              const PIXELFORMATDESCRIPTOR *ppfd) {
 481   ERR("No OpenGL support compiled in.\n");
 482
 483   return 0;
 484 }
 485
 486 /***********************************************************************
 487  *              DescribePixelFormat (X11DRV.@)
 488  */
 489 int X11DRV_DescribePixelFormat(X11DRV_PDEVICE *physDev,
 490                                int iPixelFormat,
 491                                UINT nBytes,
 492                                PIXELFORMATDESCRIPTOR *ppfd) {
 493   ERR("No OpenGL support compiled in.\n");
 494
 495   return 0;
 496 }
 497
 498 /***********************************************************************
 499  *              GetPixelFormat (X11DRV.@)
 500  */
 501 int X11DRV_GetPixelFormat(X11DRV_PDEVICE *physDev) {
 502   ERR("No OpenGL support compiled in.\n");
 503
 504   return 0;
 505 }
 506
 507 /***********************************************************************
 508  *              SetPixelFormat (X11DRV.@)
 509  */
 510 BOOL X11DRV_SetPixelFormat(X11DRV_PDEVICE *physDev,
 511                            int iPixelFormat,
 512                            const PIXELFORMATDESCRIPTOR *ppfd) {
 513   ERR("No OpenGL support compiled in.\n");
 514
 515   return FALSE;
 516 }
 517
 518 /***********************************************************************
 519  *              SwapBuffers (X11DRV.@)
 520  */
 521 BOOL X11DRV_SwapBuffers(X11DRV_PDEVICE *physDev) {
 522   ERR("No OpenGL support compiled in.\n");
 523
 524   return FALSE;
 525 }
 526
 527 XVisualInfo *X11DRV_setup_opengl_visual( Display *display )
 528 {
 529   return NULL;
 530 }
 531
 532 #endif /* defined(HAVE_OPENGL) */