Cleanup: use r_* prefix for return args
[blender.git] / source / blender / windowmanager / wm_window.h
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) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * 
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/windowmanager/wm_window.h
28  *  \ingroup wm
29  */
30
31
32 #ifndef __WM_WINDOW_H__
33 #define __WM_WINDOW_H__
34
35 struct wmOperator;
36
37 /* *************** internal api ************** */
38 void            wm_ghost_init                   (bContext *C);
39 void            wm_ghost_exit(void);
40
41 void wm_get_screensize(int *r_width, int *r_height);
42 void wm_get_desktopsize(int *r_width, int *r_height);
43
44 wmWindow        *wm_window_new                  (bContext *C);
45 void            wm_window_free                  (bContext *C, wmWindowManager *wm, wmWindow *win);
46 void            wm_window_close                 (bContext *C, wmWindowManager *wm, wmWindow *win);
47
48 void            wm_window_title                         (wmWindowManager *wm, wmWindow *win);
49 void            wm_window_add_ghostwindows      (wmWindowManager *wm);
50 void            wm_window_process_events        (const bContext *C);
51 void            wm_window_process_events_nosleep(void);
52
53 void            wm_window_make_drawable(wmWindowManager *wm, wmWindow *win);
54
55 void            wm_window_raise                 (wmWindow *win);
56 void            wm_window_lower                 (wmWindow *win);
57 void            wm_window_set_size              (wmWindow *win, int width, int height);
58 void            wm_window_get_position  (wmWindow *win, int *r_pos_x, int *r_pos_y);
59 void            wm_window_swap_buffers  (wmWindow *win);
60 void            wm_window_set_swap_interval(wmWindow *win, int interval);
61 bool            wm_window_get_swap_interval(wmWindow *win, int *intervalOut);
62
63 float           wm_window_pixelsize(wmWindow *win);
64
65 void            wm_get_cursor_position  (wmWindow *win, int *x, int *y);
66
67 wmWindow        *wm_window_copy                 (bContext *C, wmWindow *winorig);
68
69 void            wm_window_testbreak             (void);
70
71 #ifdef WITH_INPUT_IME
72 void            wm_window_IME_begin     (wmWindow *win, int x, int y, int w, int h, bool complete);
73 void            wm_window_IME_end       (wmWindow *win);
74 #endif
75
76 /* *************** window operators ************** */
77 int                     wm_window_duplicate_exec(bContext *C, struct wmOperator *op);
78 int                     wm_window_fullscreen_toggle_exec(bContext *C, struct wmOperator *op);
79
80 /* Initial (unmaximized) size to start with for
81  * systems that can't find it for themselves (X11).
82  * Clamped by real desktop limits */
83 #define WM_WIN_INIT_SIZE_X 1800
84 #define WM_WIN_INIT_SIZE_Y 1000
85 #define WM_WIN_INIT_PAD 40
86
87 #endif /* __WM_WINDOW_H__ */
88