code cleanup: quiet some -Wshadow warnings, mix of obvious mistakes and harmless...
[blender-staging.git] / source / blender / windowmanager / intern / wm_subwindow.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): 2007 Blender Foundation (refactor)
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  *
26  * Subwindow opengl handling. 
27  * BTW: subwindows open/close in X11 are way too slow, tried it, and choose for my own system... (ton)
28  * 
29  */
30
31 /** \file blender/windowmanager/intern/wm_subwindow.c
32  *  \ingroup wm
33  */
34
35
36 #include <string.h>
37
38 #include "MEM_guardedalloc.h"
39
40 #include "DNA_windowmanager_types.h"
41 #include "DNA_screen_types.h"
42
43 #include "BLI_blenlib.h"
44 #include "BLI_math.h"
45 #include "BLI_utildefines.h"
46
47
48 #include "BKE_context.h"
49 #include "BKE_global.h"
50
51 #include "BIF_gl.h"
52
53 #include "GPU_extensions.h"
54
55 #include "WM_api.h"
56 #include "wm_subwindow.h"
57 #include "wm_window.h"
58
59 /* wmSubWindow stored in wmWindow... but not exposed outside this C file */
60 /* it seems a bit redundant (area regions can store it too, but we keep it
61  * because we can store all kind of future opengl fanciness here */
62
63 /* we use indices and array because:
64  * - index has safety, no pointers from this C file hanging around
65  * - fast lookups of indices with array, list would give overhead
66  * - old code used it this way...
67  * - keep option open to have 2 screens using same window
68  */
69
70 typedef struct wmSubWindow {
71         struct wmSubWindow *next, *prev;
72         
73         rcti winrct;
74         int swinid;
75 } wmSubWindow;
76
77
78 /* ******************* open, free, set, get data ******************** */
79
80 /* not subwindow itself */
81 static void wm_subwindow_free(wmSubWindow *UNUSED(swin))
82 {
83         /* future fancy stuff */
84 }
85
86 void wm_subwindows_free(wmWindow *win)
87 {
88         wmSubWindow *swin;
89         
90         for (swin = win->subwindows.first; swin; swin = swin->next)
91                 wm_subwindow_free(swin);
92         
93         BLI_freelistN(&win->subwindows);
94 }
95
96
97 int wm_subwindow_get(wmWindow *win)     
98 {
99         if (win->curswin)
100                 return win->curswin->swinid;
101         return 0;
102 }
103
104 static wmSubWindow *swin_from_swinid(wmWindow *win, int swinid)
105 {
106         wmSubWindow *swin;
107         
108         for (swin = win->subwindows.first; swin; swin = swin->next)
109                 if (swin->swinid == swinid)
110                         break;
111         return swin;
112 }
113
114 void wm_subwindow_getsize(wmWindow *win, int swinid, int *x, int *y) 
115 {
116         wmSubWindow *swin = swin_from_swinid(win, swinid);
117
118         if (swin) {
119                 *x = BLI_rcti_size_x(&swin->winrct) + 1;
120                 *y = BLI_rcti_size_y(&swin->winrct) + 1;
121         }
122 }
123
124 void wm_subwindow_getorigin(wmWindow *win, int swinid, int *x, int *y)
125 {
126         wmSubWindow *swin = swin_from_swinid(win, swinid);
127
128         if (swin) {
129                 *x = swin->winrct.xmin;
130                 *y = swin->winrct.ymin;
131         }
132 }
133
134 void wm_subwindow_getmatrix(wmWindow *win, int swinid, float mat[4][4])
135 {
136         wmSubWindow *swin = swin_from_swinid(win, swinid);
137
138         if (swin) {
139                 /* used by UI, should find a better way to get the matrix there */
140                 if (swinid == win->screen->mainwin) {
141                         int width, height;
142
143                         wm_subwindow_getsize(win, swin->swinid, &width, &height);
144                         orthographic_m4(mat, -GLA_PIXEL_OFS, (float)width - GLA_PIXEL_OFS, -GLA_PIXEL_OFS, (float)height - GLA_PIXEL_OFS, -100, 100);
145                 }
146                 else
147                         glGetFloatv(GL_PROJECTION_MATRIX, (float *)mat);
148         }
149 }
150
151 /* always sets pixel-precise 2D window/view matrices */
152 /* coords is in whole pixels. xmin = 15, xmax = 16: means window is 2 pix big */
153 int wm_subwindow_open(wmWindow *win, rcti *winrct)
154 {
155         wmSubWindow *swin;
156         int width, height;
157         int freewinid = 1;
158         
159         for (swin = win->subwindows.first; swin; swin = swin->next)
160                 if (freewinid <= swin->swinid)
161                         freewinid = swin->swinid + 1;
162
163         win->curswin = swin = MEM_callocN(sizeof(wmSubWindow), "swinopen");
164         BLI_addtail(&win->subwindows, swin);
165         
166         swin->swinid = freewinid;
167         swin->winrct = *winrct;
168
169         /* and we appy it all right away */
170         wmSubWindowSet(win, swin->swinid);
171         
172         /* extra service */
173         wm_subwindow_getsize(win, swin->swinid, &width, &height);
174         wmOrtho2(-GLA_PIXEL_OFS, (float)width - GLA_PIXEL_OFS, -GLA_PIXEL_OFS, (float)height - GLA_PIXEL_OFS);
175         glLoadIdentity();
176
177         return swin->swinid;
178 }
179
180
181 void wm_subwindow_close(wmWindow *win, int swinid)
182 {
183         wmSubWindow *swin = swin_from_swinid(win, swinid);
184
185         if (swin) {
186                 if (swin == win->curswin)
187                         win->curswin = NULL;
188                 wm_subwindow_free(swin);
189                 BLI_remlink(&win->subwindows, swin);
190                 MEM_freeN(swin);
191         }
192         else {
193                 printf("%s: Internal error, bad winid: %d\n", __func__, swinid);
194         }
195 }
196
197 /* pixels go from 0-99 for a 100 pixel window */
198 void wm_subwindow_position(wmWindow *win, int swinid, rcti *winrct)
199 {
200         wmSubWindow *swin = swin_from_swinid(win, swinid);
201         
202         if (swin) {
203                 int width, height;
204                 
205                 swin->winrct = *winrct;
206                 
207                 /* CRITICAL, this clamping ensures that
208                  * the viewport never goes outside the screen
209                  * edges (assuming the x, y coords aren't
210                  *        outside). This caused a hardware lock
211                  * on Matrox cards if it happens.
212                  *
213                  * Really Blender should never _ever_ try
214                  * to do such a thing, but just to be safe
215                  * clamp it anyway (or fix the bScreen
216                  * scaling routine, and be damn sure you
217                  * fixed it). - zr  (2001!)
218                  */
219                 
220                 if (swin->winrct.xmax > WM_window_pixels_x(win))
221                         swin->winrct.xmax = WM_window_pixels_x(win);
222                 if (swin->winrct.ymax > WM_window_pixels_y(win))
223                         swin->winrct.ymax = WM_window_pixels_y(win);
224                 
225                 /* extra service */
226                 wmSubWindowSet(win, swinid);
227                 wm_subwindow_getsize(win, swinid, &width, &height);
228                 wmOrtho2(-GLA_PIXEL_OFS, (float)width - GLA_PIXEL_OFS, -GLA_PIXEL_OFS, (float)height - GLA_PIXEL_OFS);
229         }
230         else {
231                 printf("%s: Internal error, bad winid: %d\n", __func__, swinid);
232         }
233 }
234
235 /* ---------------- WM versions of OpenGL style API calls ------------------------ */
236 /* ----------------- exported in WM_api.h ------------------------------------------------------ */
237
238 /* internal state, no threaded opengl! XXX */
239 static wmWindow *_curwindow = NULL;
240 static wmSubWindow *_curswin = NULL;
241
242 void wmSubWindowScissorSet(wmWindow *win, int swinid, rcti *srct)
243 {
244         int width, height;
245         _curswin = swin_from_swinid(win, swinid);
246         
247         if (_curswin == NULL) {
248                 printf("%s %d: doesn't exist\n", __func__, swinid);
249                 return;
250         }
251         
252         win->curswin = _curswin;
253         _curwindow = win;
254         
255         width  = BLI_rcti_size_x(&_curswin->winrct) + 1;
256         height = BLI_rcti_size_y(&_curswin->winrct) + 1;
257         glViewport(_curswin->winrct.xmin, _curswin->winrct.ymin, width, height);
258         
259         if (srct) {
260                 int scissor_width  = BLI_rcti_size_x(srct) + 1; /* only here */
261                 int scissor_height = BLI_rcti_size_y(srct) + 1;
262                 glScissor(srct->xmin, srct->ymin, scissor_width, scissor_height);
263         }
264         else
265                 glScissor(_curswin->winrct.xmin, _curswin->winrct.ymin, width, height);
266         
267         wmOrtho2(-GLA_PIXEL_OFS, (float)width - GLA_PIXEL_OFS, -GLA_PIXEL_OFS, (float)height - GLA_PIXEL_OFS);
268         glLoadIdentity();
269         
270         glFlush();
271 }
272
273 /* enable the WM versions of opengl calls */
274 void wmSubWindowSet(wmWindow *win, int swinid)
275 {
276         wmSubWindowScissorSet(win, swinid, NULL);
277 }
278
279 void wmFrustum(float x1, float x2, float y1, float y2, float n, float f)
280 {
281         glMatrixMode(GL_PROJECTION);
282         glLoadIdentity();
283         glFrustum(x1, x2, y1, y2, n, f);
284         glMatrixMode(GL_MODELVIEW);
285 }
286
287 void wmOrtho(float x1, float x2, float y1, float y2, float n, float f)
288 {
289         glMatrixMode(GL_PROJECTION);
290         glLoadIdentity();
291
292         glOrtho(x1, x2, y1, y2, n, f);
293
294         glMatrixMode(GL_MODELVIEW);
295 }
296
297 void wmOrtho2(float x1, float x2, float y1, float y2)
298 {
299         /* prevent opengl from generating errors */
300         if (x1 == x2) x2 += 1.0f;
301         if (y1 == y2) y2 += 1.0f;
302
303         wmOrtho(x1, x2, y1, y2, -100, 100);
304 }
305
306 /* *************************** Framebuffer color depth, for selection codes ********************** */
307
308 #ifdef __APPLE__
309
310 /* apple seems to round colors to below and up on some configs */
311
312 unsigned int index_to_framebuffer(int index)
313 {
314         unsigned int i = index;
315
316         switch (GPU_color_depth()) {
317                 case 12:
318                         i = ((i & 0xF00) << 12) + ((i & 0xF0) << 8) + ((i & 0xF) << 4);
319                         /* sometimes dithering subtracts! */
320                         i |= 0x070707;
321                         break;
322                 case 15:
323                 case 16:
324                         i = ((i & 0x7C00) << 9) + ((i & 0x3E0) << 6) + ((i & 0x1F) << 3);
325                         i |= 0x030303;
326                         break;
327                 case 24:
328                         break;
329                 default: /* 18 bits... */
330                         i = ((i & 0x3F000) << 6) + ((i & 0xFC0) << 4) + ((i & 0x3F) << 2);
331                         i |= 0x010101;
332                         break;
333         }
334
335         return i;
336 }
337
338 #else
339
340 /* this is the old method as being in use for ages.... seems to work? colors are rounded to lower values */
341
342 unsigned int index_to_framebuffer(int index)
343 {
344         unsigned int i = index;
345         
346         switch (GPU_color_depth()) {
347                 case 8:
348                         i = ((i & 48) << 18) + ((i & 12) << 12) + ((i & 3) << 6);
349                         i |= 0x3F3F3F;
350                         break;
351                 case 12:
352                         i = ((i & 0xF00) << 12) + ((i & 0xF0) << 8) + ((i & 0xF) << 4);
353                         /* sometimes dithering subtracts! */
354                         i |= 0x0F0F0F;
355                         break;
356                 case 15:
357                 case 16:
358                         i = ((i & 0x7C00) << 9) + ((i & 0x3E0) << 6) + ((i & 0x1F) << 3);
359                         i |= 0x070707;
360                         break;
361                 case 24:
362                         break;
363                 default:    /* 18 bits... */
364                         i = ((i & 0x3F000) << 6) + ((i & 0xFC0) << 4) + ((i & 0x3F) << 2);
365                         i |= 0x030303;
366                         break;
367         }
368         
369         return i;
370 }
371
372 #endif
373
374 void WM_framebuffer_index_set(int index)
375 {
376         const int col = index_to_framebuffer(index);
377         cpack(col);
378 }
379
380 int WM_framebuffer_to_index(unsigned int col)
381 {
382         if (col == 0) return 0;
383
384         switch (GPU_color_depth()) {
385                 case 8:
386                         return ((col & 0xC00000) >> 18) + ((col & 0xC000) >> 12) + ((col & 0xC0) >> 6);
387                 case 12:
388                         return ((col & 0xF00000) >> 12) + ((col & 0xF000) >> 8) + ((col & 0xF0) >> 4);
389                 case 15:
390                 case 16:
391                         return ((col & 0xF80000) >> 9) + ((col & 0xF800) >> 6) + ((col & 0xF8) >> 3);
392                 case 24:
393                         return col & 0xFFFFFF;
394                 default: // 18 bits...
395                         return ((col & 0xFC0000) >> 6) + ((col & 0xFC00) >> 4) + ((col & 0xFC) >> 2);
396         }
397 }
398
399
400 /* ********** END MY WINDOW ************** */
401