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 = swin->winrct.xmax - swin->winrct.xmin + 1;
 120                 *y = swin->winrct.ymax - swin->winrct.ymin + 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])
 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, -0.375f, (float)width - 0.375f, -0.375f, (float)height - 0.375f, -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         if (G.debug & G_DEBUG_EVENTS) {
 167                 printf("%s: swin %d added\n", __func__, freewinid);
 168         }
 169
 170         swin->swinid = freewinid;
 171         swin->winrct = *winrct;
 172
 173         /* and we appy it all right away */
 174         wmSubWindowSet(win, swin->swinid);
 175
 176         /* extra service */
 177         wm_subwindow_getsize(win, swin->swinid, &width, &height);
 178         wmOrtho2(-0.375f, (float)width - 0.375f, -0.375f, (float)height - 0.375f);
 179         glLoadIdentity();
 180
 181         return swin->swinid;
 182 }
 183
 184
 185 void wm_subwindow_close(wmWindow *win, int swinid)
 186 {
 187         wmSubWindow *swin = swin_from_swinid(win, swinid);
 188
 189         if (swin) {
 190                 if (swin == win->curswin)
 191                         win->curswin = NULL;
 192                 wm_subwindow_free(swin);
 193                 BLI_remlink(&win->subwindows, swin);
 194                 MEM_freeN(swin);
 195         }
 196         else {
 197                 printf("wm_subwindow_close: Internal error, bad winid: %d\n", swinid);
 198         }
 199
 200 }
 201
 202 /* pixels go from 0-99 for a 100 pixel window */
 203 void wm_subwindow_position(wmWindow *win, int swinid, rcti *winrct)
 204 {
 205         wmSubWindow *swin = swin_from_swinid(win, swinid);
 206
 207         if (swin) {
 208                 int width, height;
 209
 210                 swin->winrct = *winrct;
 211
 212                 /* CRITICAL, this clamping ensures that
 213                  * the viewport never goes outside the screen
 214                  * edges (assuming the x, y coords aren't
 215                  *        outside). This caused a hardware lock
 216                  * on Matrox cards if it happens.
 217                  *
 218                  * Really Blender should never _ever_ try
 219                  * to do such a thing, but just to be safe
 220                  * clamp it anyway (or fix the bScreen
 221                  * scaling routine, and be damn sure you
 222                  * fixed it). - zr  (2001!)
 223                  */
 224
 225                 if (swin->winrct.xmax > win->sizex)
 226                         swin->winrct.xmax = win->sizex;
 227                 if (swin->winrct.ymax > win->sizey)
 228                         swin->winrct.ymax = win->sizey;
 229
 230                 /* extra service */
 231                 wmSubWindowSet(win, swinid);
 232                 wm_subwindow_getsize(win, swinid, &width, &height);
 233                 wmOrtho2(-0.375f, (float)width - 0.375f, -0.375f, (float)height - 0.375f);
 234         }
 235         else {
 236                 printf("wm_subwindow_position: Internal error, bad winid: %d\n", swinid);
 237         }
 238 }
 239
 240 /* ---------------- WM versions of OpenGL style API calls ------------------------ */
 241 /* ----------------- exported in WM_api.h ------------------------------------------------------ */
 242
 243 /* internal state, no threaded opengl! XXX */
 244 static wmWindow *_curwindow = NULL;
 245 static wmSubWindow *_curswin = NULL;
 246
 247 void wmSubWindowScissorSet(wmWindow *win, int swinid, rcti *srct)
 248 {
 249         int width, height;
 250         _curswin = swin_from_swinid(win, swinid);
 251
 252         if (_curswin == NULL) {
 253                 printf("wmSubWindowSet %d: doesn't exist\n", swinid);
 254                 return;
 255         }
 256
 257         win->curswin = _curswin;
 258         _curwindow = win;
 259
 260         width = _curswin->winrct.xmax - _curswin->winrct.xmin + 1;
 261         height = _curswin->winrct.ymax - _curswin->winrct.ymin + 1;
 262         glViewport(_curswin->winrct.xmin, _curswin->winrct.ymin, width, height);
 263
 264         if (srct) {
 265                 width = srct->xmax - srct->xmin + 1;
 266                 height = srct->ymax - srct->ymin + 1;
 267                 glScissor(srct->xmin, srct->ymin, width, height);
 268         }
 269         else
 270                 glScissor(_curswin->winrct.xmin, _curswin->winrct.ymin, width, height);
 271
 272         wmOrtho2(-0.375f, (float)width - 0.375f, -0.375f, (float)height - 0.375f);
 273         glLoadIdentity();
 274
 275         glFlush();
 276 }
 277
 278
 279 /* enable the WM versions of opengl calls */
 280 void wmSubWindowSet(wmWindow *win, int swinid)
 281 {
 282         wmSubWindowScissorSet(win, swinid, NULL);
 283 }
 284
 285 void wmFrustum(float x1, float x2, float y1, float y2, float n, float f)
 286 {
 287         glMatrixMode(GL_PROJECTION);
 288         glLoadIdentity();
 289         glFrustum(x1, x2, y1, y2, n, f);
 290         glMatrixMode(GL_MODELVIEW);
 291 }
 292
 293 void wmOrtho(float x1, float x2, float y1, float y2, float n, float f)
 294 {
 295         glMatrixMode(GL_PROJECTION);
 296         glLoadIdentity();
 297
 298         glOrtho(x1, x2, y1, y2, n, f);
 299
 300         glMatrixMode(GL_MODELVIEW);
 301 }
 302
 303 void wmOrtho2(float x1, float x2, float y1, float y2)
 304 {
 305         /* prevent opengl from generating errors */
 306         if (x1 == x2) x2 += 1.0f;
 307         if (y1 == y2) y2 += 1.0f;
 308
 309         wmOrtho(x1, x2, y1, y2, -100, 100);
 310 }
 311
 312 /* *************************** Framebuffer color depth, for selection codes ********************** */
 313
 314 #ifdef __APPLE__
 315
 316 /* apple seems to round colors to below and up on some configs */
 317
 318 unsigned int index_to_framebuffer(int index)
 319 {
 320         unsigned int i = index;
 321
 322         switch (GPU_color_depth()) {
 323                 case 12:
 324                         i = ((i & 0xF00) << 12) + ((i & 0xF0) << 8) + ((i & 0xF) << 4);
 325                         /* sometimes dithering subtracts! */
 326                         i |= 0x070707;
 327                         break;
 328                 case 15:
 329                 case 16:
 330                         i = ((i & 0x7C00) << 9) + ((i & 0x3E0) << 6) + ((i & 0x1F) << 3);
 331                         i |= 0x030303;
 332                         break;
 333                 case 24:
 334                         break;
 335                 default: // 18 bits...
 336                         i = ((i & 0x3F000) << 6) + ((i & 0xFC0) << 4) + ((i & 0x3F) << 2);
 337                         i |= 0x010101;
 338                         break;
 339         }
 340
 341         return i;
 342 }
 343
 344 #else
 345
 346 /* this is the old method as being in use for ages.... seems to work? colors are rounded to lower values */
 347
 348 unsigned int index_to_framebuffer(int index)
 349 {
 350         unsigned int i = index;
 351
 352         switch (GPU_color_depth()) {
 353                 case 8:
 354                         i = ((i & 48) << 18) + ((i & 12) << 12) + ((i & 3) << 6);
 355                         i |= 0x3F3F3F;
 356                         break;
 357                 case 12:
 358                         i = ((i & 0xF00) << 12) + ((i & 0xF0) << 8) + ((i & 0xF) << 4);
 359                         /* sometimes dithering subtracts! */
 360                         i |= 0x0F0F0F;
 361                         break;
 362                 case 15:
 363                 case 16:
 364                         i = ((i & 0x7C00) << 9) + ((i & 0x3E0) << 6) + ((i & 0x1F) << 3);
 365                         i |= 0x070707;
 366                         break;
 367                 case 24:
 368                         break;
 369                 default:    // 18 bits...
 370                         i = ((i & 0x3F000) << 6) + ((i & 0xFC0) << 4) + ((i & 0x3F) << 2);
 371                         i |= 0x030303;
 372                         break;
 373         }
 374
 375         return i;
 376 }
 377
 378 #endif
 379
 380 void WM_set_framebuffer_index_color(int index)
 381 {
 382         const int col = index_to_framebuffer(index);
 383         cpack(col);
 384 }
 385
 386 int WM_framebuffer_to_index(unsigned int col)
 387 {
 388         if (col == 0) return 0;
 389
 390         switch (GPU_color_depth()) {
 391                 case 8:
 392                         return ((col & 0xC00000) >> 18) + ((col & 0xC000) >> 12) + ((col & 0xC0) >> 6);
 393                 case 12:
 394                         return ((col & 0xF00000) >> 12) + ((col & 0xF000) >> 8) + ((col & 0xF0) >> 4);
 395                 case 15:
 396                 case 16:
 397                         return ((col & 0xF80000) >> 9) + ((col & 0xF800) >> 6) + ((col & 0xF8) >> 3);
 398                 case 24:
 399                         return col & 0xFFFFFF;
 400                 default: // 18 bits...
 401                         return ((col & 0xFC0000) >> 6) + ((col & 0xFC00) >> 4) + ((col & 0xFC) >> 2);
 402         }
 403 }
 404
 405
 406 /* ********** END MY WINDOW ************** */
 407