Add a comment warning when a table must be kept sorted for later use with bsearch().
[wine] / dlls / opengl32 / tests / opengl.c
1 /*
2  * Some tests for OpenGL functions
3  *
4  * Copyright (C) 2007 Roderick Colenbrander
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 #include <windows.h>
22 #include <wingdi.h>
23 #include "wine/test.h"
24
25 #define MAX_FORMATS 256
26 typedef void* HPBUFFERARB;
27
28 /* WGL_ARB_extensions_string */
29 static const char* (WINAPI *pwglGetExtensionsStringARB)(HDC);
30 static int (WINAPI *pwglReleasePbufferDCARB)(HPBUFFERARB, HDC);
31
32 /* WGL_ARB_make_current_read */
33 static BOOL (WINAPI *pwglMakeContextCurrentARB)(HDC hdraw, HDC hread, HGLRC hglrc);
34 static HDC (WINAPI *pwglGetCurrentReadDCARB)();
35
36 /* WGL_ARB_pixel_format */
37 #define WGL_COLOR_BITS_ARB 0x2014
38 #define WGL_RED_BITS_ARB   0x2015
39 #define WGL_GREEN_BITS_ARB 0x2017
40 #define WGL_BLUE_BITS_ARB  0x2019
41 #define WGL_ALPHA_BITS_ARB 0x201B
42 #define WGL_SUPPORT_GDI_ARB   0x200F
43 #define WGL_DOUBLE_BUFFER_ARB 0x2011
44
45 static BOOL (WINAPI *pwglChoosePixelFormatARB)(HDC, const int *, const FLOAT *, UINT, int *, UINT *);
46 static BOOL (WINAPI *pwglGetPixelFormatAttribivARB)(HDC, int, int, UINT, const int *, int *);
47
48 /* WGL_ARB_pbuffer */
49 #define WGL_DRAW_TO_PBUFFER_ARB 0x202D
50 static HPBUFFERARB* (WINAPI *pwglCreatePbufferARB)(HDC, int, int, int, const int *);
51 static HDC (WINAPI *pwglGetPbufferDCARB)(HPBUFFERARB);
52
53 static const char* wgl_extensions = NULL;
54
55 static void init_functions(void)
56 {
57 #define GET_PROC(func) \
58     p ## func = (void*)wglGetProcAddress(#func); \
59     if(!p ## func) \
60       trace("wglGetProcAddress(%s) failed\n", #func);
61
62     /* WGL_ARB_extensions_string */
63     GET_PROC(wglGetExtensionsStringARB)
64
65     /* WGL_ARB_make_current_read */
66     GET_PROC(wglMakeContextCurrentARB);
67     GET_PROC(wglGetCurrentReadDCARB);
68
69     /* WGL_ARB_pixel_format */
70     GET_PROC(wglChoosePixelFormatARB)
71     GET_PROC(wglGetPixelFormatAttribivARB)
72
73     /* WGL_ARB_pbuffer */
74     GET_PROC(wglCreatePbufferARB)
75     GET_PROC(wglGetPbufferDCARB)
76     GET_PROC(wglReleasePbufferDCARB)
77
78 #undef GET_PROC
79 }
80
81 static void test_pbuffers(HDC hdc)
82 {
83     const int iAttribList[] = { WGL_DRAW_TO_PBUFFER_ARB, 1, /* Request pbuffer support */
84                                 0 };
85     int iFormats[MAX_FORMATS];
86     unsigned int nOnscreenFormats;
87     unsigned int nFormats;
88     int i, res;
89     int iPixelFormat = 0;
90
91     nOnscreenFormats = DescribePixelFormat(hdc, 0, 0, NULL);
92
93     /* When you want to render to a pbuffer you need to call wglGetPbufferDCARB which
94      * returns a 'magic' HDC which you can then pass to wglMakeCurrent to switch rendering
95      * to the pbuffer. Below some tests are performed on what happens if you use standard WGL calls
96      * on this 'magic' HDC for both a pixelformat that support onscreen and offscreen rendering
97      * and a pixelformat that's only available for offscreen rendering (this means that only
98      * wglChoosePixelFormatARB and friends know about the format.
99      *
100      * The first thing we need are pixelformats with pbuffer capabilities.
101      */
102     res = pwglChoosePixelFormatARB(hdc, iAttribList, NULL, MAX_FORMATS, iFormats, &nFormats);
103     if(res <= 0)
104     {
105         skip("No pbuffer compatible formats found while WGL_ARB_pbuffer is supported\n");
106         return;
107     }
108     trace("nOnscreenFormats: %d\n", nOnscreenFormats);
109     trace("Total number of pbuffer capable pixelformats: %d\n", nFormats);
110
111     /* Try to select an onscreen pixelformat out of the list */
112     for(i=0; i < nFormats; i++)
113     {
114         /* Check if the format is onscreen, if it is choose it */
115         if(iFormats[i] <= nOnscreenFormats)
116         {
117             iPixelFormat = iFormats[i];
118             trace("Selected iPixelFormat=%d\n", iPixelFormat);
119             break;
120         }
121     }
122
123     /* A video driver supports a large number of onscreen and offscreen pixelformats.
124      * The traditional WGL calls only see a subset of the whole pixelformat list. First
125      * of all they only see the onscreen formats (the offscreen formats are at the end of the
126      * pixelformat list) and second extended pixelformat capabilities are hidden from the
127      * standard WGL calls. Only functions that depend on WGL_ARB_pixel_format can see them.
128      *
129      * Below we check if the pixelformat is also supported onscreen.
130      */
131     if(iPixelFormat != 0)
132     {
133         HDC pbuffer_hdc;
134         HPBUFFERARB pbuffer = pwglCreatePbufferARB(hdc, iPixelFormat, 640 /* width */, 480 /* height */, NULL);
135         if(!pbuffer)
136             skip("Pbuffer creation failed!\n");
137
138         /* Test the pixelformat returned by GetPixelFormat on a pbuffer as the behavior is not clear */
139         pbuffer_hdc = pwglGetPbufferDCARB(pbuffer);
140         res = GetPixelFormat(pbuffer_hdc);
141         ok(res == iPixelFormat, "Unexpected iPixelFormat=%d returned by GetPixelFormat for format %d\n", res, iPixelFormat);
142         trace("iPixelFormat returned by GetPixelFormat: %d\n", res);
143         trace("PixelFormat from wglChoosePixelFormatARB: %d\n", iPixelFormat);
144
145         pwglReleasePbufferDCARB(pbuffer, hdc);
146     }
147     else skip("Pbuffer test for onscreen pixelformat skipped as no onscreen format with pbuffer capabilities have been found\n");
148
149     /* Search for a real offscreen format */
150     for(i=0, iPixelFormat=0; i<nFormats; i++)
151     {
152         if(iFormats[i] > nOnscreenFormats)
153         {
154             iPixelFormat = iFormats[i];
155             trace("Selected iPixelFormat: %d\n", iPixelFormat);
156             break;
157         }
158     }
159
160     if(iPixelFormat != 0)
161     {
162         HDC pbuffer_hdc;
163         HPBUFFERARB pbuffer = pwglCreatePbufferARB(hdc, iPixelFormat, 640 /* width */, 480 /* height */, NULL);
164         if(!pbuffer)
165             skip("Pbuffer creation failed!\n");
166
167         /* Test the pixelformat returned by GetPixelFormat on a pbuffer as the behavior is not clear */
168         pbuffer_hdc = pwglGetPbufferDCARB(pbuffer);
169         res = GetPixelFormat(pbuffer_hdc);
170
171         ok(res == 1, "Unexpected iPixelFormat=%d (1 expected) returned by GetPixelFormat for offscreen format %d\n", res, iPixelFormat);
172         trace("iPixelFormat returned by GetPixelFormat: %d\n", res);
173         trace("PixelFormat from wglChoosePixelFormatARB: %d\n", iPixelFormat);
174         pwglReleasePbufferDCARB(pbuffer, hdc);
175     }
176     else skip("Pbuffer test for offscreen pixelformat skipped as no offscreen-only format with pbuffer capabilities has been found\n");
177 }
178
179 static void test_setpixelformat(HDC winhdc)
180 {
181     int res = 0;
182     int nCfgs;
183     int pf;
184     int i;
185     PIXELFORMATDESCRIPTOR pfd = {
186         sizeof(PIXELFORMATDESCRIPTOR),
187         1,                     /* version */
188         PFD_DRAW_TO_WINDOW |
189         PFD_SUPPORT_OPENGL |
190         PFD_DOUBLEBUFFER,
191         PFD_TYPE_RGBA,
192         24,                    /* 24-bit color depth */
193         0, 0, 0, 0, 0, 0,      /* color bits */
194         0,                     /* alpha buffer */
195         0,                     /* shift bit */
196         0,                     /* accumulation buffer */
197         0, 0, 0, 0,            /* accum bits */
198         32,                    /* z-buffer */
199         0,                     /* stencil buffer */
200         0,                     /* auxiliary buffer */
201         PFD_MAIN_PLANE,        /* main layer */
202         0,                     /* reserved */
203         0, 0, 0                /* layer masks */
204     };
205
206     HDC hdc = GetDC(0);
207     ok(hdc != 0, "GetDC(0) failed!\n");
208
209     /* This should pass even on the main device context */
210     pf = ChoosePixelFormat(hdc, &pfd);
211     ok(pf != 0, "ChoosePixelFormat failed on main device context\n");
212
213     /* SetPixelFormat on the main device context 'X root window' should fail */
214     res = SetPixelFormat(hdc, pf, &pfd);
215     ok(res == 0, "SetPixelFormat on main device context should fail\n");
216
217     /* Setting the same format that was set on the HDC is allowed; other
218        formats fail */
219     nCfgs = DescribePixelFormat(winhdc, 0, 0, NULL);
220     pf = GetPixelFormat(winhdc);
221     for(i = 1;i <= nCfgs;i++)
222     {
223         int res = SetPixelFormat(winhdc, i, NULL);
224         if(i == pf) ok(res, "Failed to set the same pixel format\n");
225         else ok(!res, "Unexpectedly set an alternate pixel format\n");
226     }
227 }
228
229 static void test_colorbits(HDC hdc)
230 {
231     const int iAttribList[] = { WGL_COLOR_BITS_ARB, WGL_RED_BITS_ARB, WGL_GREEN_BITS_ARB,
232                                 WGL_BLUE_BITS_ARB, WGL_ALPHA_BITS_ARB };
233     int iAttribRet[sizeof(iAttribList)/sizeof(iAttribList[0])];
234     const int iAttribs[] = { WGL_ALPHA_BITS_ARB, 1, 0 };
235     unsigned int nFormats;
236     int res;
237     int iPixelFormat = 0;
238
239     if (!pwglChoosePixelFormatARB)
240     {
241         skip("wglChoosePixelFormatARB is not available\n");
242         return;
243     }
244
245     /* We need a pixel format with at least one bit of alpha */
246     res = pwglChoosePixelFormatARB(hdc, iAttribs, NULL, 1, &iPixelFormat, &nFormats);
247     if(res == FALSE || nFormats == 0)
248     {
249         skip("No suitable pixel formats found\n");
250         return;
251     }
252
253     res = pwglGetPixelFormatAttribivARB(hdc, iPixelFormat, 0,
254               sizeof(iAttribList)/sizeof(iAttribList[0]), iAttribList, iAttribRet);
255     if(res == FALSE)
256     {
257         skip("wglGetPixelFormatAttribivARB failed\n");
258         return;
259     }
260     iAttribRet[1] += iAttribRet[2]+iAttribRet[3]+iAttribRet[4];
261     ok(iAttribRet[0] == iAttribRet[1], "WGL_COLOR_BITS_ARB (%d) does not equal R+G+B+A (%d)!\n",
262                                        iAttribRet[0], iAttribRet[1]);
263 }
264
265 static void test_gdi_dbuf(HDC hdc)
266 {
267     const int iAttribList[] = { WGL_SUPPORT_GDI_ARB, WGL_DOUBLE_BUFFER_ARB };
268     int iAttribRet[sizeof(iAttribList)/sizeof(iAttribList[0])];
269     unsigned int nFormats;
270     int iPixelFormat;
271     int res;
272
273     if (!pwglGetPixelFormatAttribivARB)
274     {
275         skip("wglGetPixelFormatAttribivARB is not available\n");
276         return;
277     }
278
279     nFormats = DescribePixelFormat(hdc, 0, 0, NULL);
280     for(iPixelFormat = 1;iPixelFormat <= nFormats;iPixelFormat++)
281     {
282         res = pwglGetPixelFormatAttribivARB(hdc, iPixelFormat, 0,
283                   sizeof(iAttribList)/sizeof(iAttribList[0]), iAttribList,
284                   iAttribRet);
285         ok(res!=FALSE, "wglGetPixelFormatAttribivARB failed for pixel format %d\n", iPixelFormat);
286         if(res == FALSE)
287             continue;
288
289         ok(!(iAttribRet[0] && iAttribRet[1]), "GDI support and double buffering on pixel format %d\n", iPixelFormat);
290     }
291 }
292
293 static void test_make_current_read(HDC hdc)
294 {
295     int res;
296     HDC hread;
297     HGLRC hglrc = wglCreateContext(hdc);
298
299     if(!hglrc)
300     {
301         skip("wglCreateContext failed!\n");
302         return;
303     }
304
305     res = wglMakeCurrent(hdc, hglrc);
306     if(!res)
307     {
308         skip("wglMakeCurrent failed!\n");
309         return;
310     }
311
312     /* Test what wglGetCurrentReadDCARB does for wglMakeCurrent as the spec doesn't mention it */
313     hread = pwglGetCurrentReadDCARB();
314     trace("hread %p, hdc %p\n", hread, hdc);
315     ok(hread == hdc, "wglGetCurrentReadDCARB failed for standard wglMakeCurrent\n");
316
317     pwglMakeContextCurrentARB(hdc, hdc, hglrc);
318     hread = pwglGetCurrentReadDCARB();
319     ok(hread == hdc, "wglGetCurrentReadDCARB failed for wglMakeContextCurrent\n");
320 }
321
322 static void test_dc(HWND hwnd, HDC hdc)
323 {
324     int pf1, pf2;
325     HDC hdc2;
326
327     /* Get another DC and make sure it has the same pixel format */
328     hdc2 = GetDC(hwnd);
329     if(hdc != hdc2)
330     {
331         pf1 = GetPixelFormat(hdc);
332         pf2 = GetPixelFormat(hdc2);
333         ok(pf1 == pf2, "Second DC does not have the same format (%d != %d)\n", pf1, pf2);
334     }
335     else
336         skip("Could not get a different DC for the window\n");
337
338     if(hdc2)
339     {
340         ReleaseDC(hwnd, hdc2);
341         hdc2 = NULL;
342     }
343 }
344
345 START_TEST(opengl)
346 {
347     HWND hwnd;
348     PIXELFORMATDESCRIPTOR pfd = {
349         sizeof(PIXELFORMATDESCRIPTOR),
350         1,                     /* version */
351         PFD_DRAW_TO_WINDOW |
352         PFD_SUPPORT_OPENGL |
353         PFD_DOUBLEBUFFER,
354         PFD_TYPE_RGBA,
355         24,                    /* 24-bit color depth */
356         0, 0, 0, 0, 0, 0,      /* color bits */
357         0,                     /* alpha buffer */
358         0,                     /* shift bit */
359         0,                     /* accumulation buffer */
360         0, 0, 0, 0,            /* accum bits */
361         32,                    /* z-buffer */
362         0,                     /* stencil buffer */
363         0,                     /* auxiliary buffer */
364         PFD_MAIN_PLANE,        /* main layer */
365         0,                     /* reserved */
366         0, 0, 0                /* layer masks */
367     };
368
369     hwnd = CreateWindow("static", "Title", WS_OVERLAPPEDWINDOW,
370                         10, 10, 200, 200, NULL, NULL, NULL, NULL);
371     ok(hwnd != NULL, "err: %d\n", GetLastError());
372     if (hwnd)
373     {
374         HDC hdc;
375         int iPixelFormat, res;
376         HGLRC hglrc;
377         DWORD error;
378         ShowWindow(hwnd, SW_SHOW);
379
380         hdc = GetDC(hwnd);
381
382         iPixelFormat = ChoosePixelFormat(hdc, &pfd);
383         ok(iPixelFormat > 0, "No pixelformat found!\n"); /* This should never happen as ChoosePixelFormat always returns a closest match */
384
385         /* We shouldn't be able to create a context from a hdc which doesn't have a pixel format set */
386         hglrc = wglCreateContext(hdc);
387         ok(hglrc == NULL, "wglCreateContext should fail when no pixel format has been set, but it passed\n");
388         error = GetLastError();
389         ok(error == ERROR_INVALID_PIXEL_FORMAT, "expected ERROR_INVALID_PIXEL_FORMAT for wglCreateContext without a pixelformat set, but received %#x\n", error);
390
391         res = SetPixelFormat(hdc, iPixelFormat, &pfd);
392         ok(res, "SetPixelformat failed: %x\n", GetLastError());
393
394         test_dc(hwnd, hdc);
395
396         hglrc = wglCreateContext(hdc);
397         res = wglMakeCurrent(hdc, hglrc);
398         ok(res, "wglMakeCurrent failed!\n");
399         init_functions();
400
401         test_setpixelformat(hdc);
402         test_colorbits(hdc);
403         test_gdi_dbuf(hdc);
404
405         if (!pwglGetExtensionsStringARB)
406         {
407             skip("wglGetExtensionsStringARB is not available\n");
408             DestroyWindow(hwnd);
409             return;
410         }
411
412         wgl_extensions = pwglGetExtensionsStringARB(hdc);
413         if(wgl_extensions == NULL) skip("Skipping opengl32 tests because this OpenGL implementation doesn't support WGL extensions!\n");
414
415         if(strstr(wgl_extensions, "WGL_ARB_make_current_read"))
416             test_make_current_read(hdc);
417         else
418             trace("WGL_ARB_make_current_read not supported, skipping test\n");
419
420         if(strstr(wgl_extensions, "WGL_ARB_pbuffer"))
421             test_pbuffers(hdc);
422         else
423             trace("WGL_ARB_pbuffer not supported, skipping pbuffer test\n");
424
425         DestroyWindow(hwnd);
426     }
427 }