Cleanup: commas at the end of enums
[blender.git] / source / blender / windowmanager / WM_api.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 #ifndef __WM_API_H__
27 #define __WM_API_H__
28
29 /** \file blender/windowmanager/WM_api.h
30  *  \ingroup wm
31  *
32  * \page wmpage windowmanager
33  * \section wmabout About windowmanager
34  * \ref wm handles events received from \ref GHOST and manages
35  * the screens, areas and input for Blender
36  * \section wmnote NOTE
37  * \todo document
38  */
39
40 /* dna-savable wmStructs here */
41 #include "DNA_windowmanager_types.h"
42 #include "WM_keymap.h"
43 #include "BLI_compiler_attrs.h"
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 struct bContext;
50 struct GHashIterator;
51 struct IDProperty;
52 struct wmEvent;
53 struct wmEventHandler;
54 struct wmGesture;
55 struct wmJob;
56 struct wmOperatorType;
57 struct wmOperator;
58 struct wmPaintCursor;
59 struct rcti;
60 struct PointerRNA;
61 struct PropertyRNA;
62 struct MenuType;
63 struct wmDropBox;
64 struct wmDrag;
65 struct ImBuf;
66 struct ImageFormatData;
67 struct ARegion;
68
69 #ifdef WITH_INPUT_NDOF
70 struct wmNDOFMotionData;
71 #endif
72
73 typedef struct wmJob wmJob;
74
75 /* general API */
76 void            WM_init_state_app_template_set(const char *app_template);
77 const char *WM_init_state_app_template_get(void);
78
79 void            WM_init_state_size_set          (int stax, int stay, int sizx, int sizy);
80 void            WM_init_state_fullscreen_set(void);
81 void            WM_init_state_normal_set(void);
82 void            WM_init_window_focus_set(bool do_it);
83 void            WM_init_native_pixels(bool do_it);
84
85 void            WM_init                         (struct bContext *C, int argc, const char **argv);
86 void            WM_exit_ext                     (struct bContext *C, const bool do_python);
87
88 void            WM_exit                         (struct bContext *C) ATTR_NORETURN;
89
90 void            WM_main                         (struct bContext *C) ATTR_NORETURN;
91
92 bool            WM_init_game            (struct bContext *C);
93 void            WM_init_splash          (struct bContext *C);
94
95
96 void            WM_check                        (struct bContext *C);
97
98 int                     WM_window_pixels_x              (struct wmWindow *win);
99 int                     WM_window_pixels_y              (struct wmWindow *win);
100 bool            WM_window_is_fullscreen (struct wmWindow *win);
101
102 /* defines for 'type' WM_window_open_temp */
103 enum {
104         WM_WINDOW_RENDER = 1,
105         WM_WINDOW_USERPREFS,
106         // WM_WINDOW_FILESEL // UNUSED
107 };
108
109 struct wmWindow *WM_window_open(struct bContext *C, const struct rcti *rect);
110 struct wmWindow *WM_window_open_temp(struct bContext *C, int x, int y, int sizex, int sizey, int type);
111 void             WM_window_set_dpi(wmWindow *win);
112
113                         /* returns true if draw method is triple buffer */
114 bool            WM_is_draw_triple(struct wmWindow *win);
115
116 bool            WM_stereo3d_enabled(struct wmWindow *win, bool only_fullscreen_test);
117
118
119                         /* files */
120 void            WM_file_autoexec_init(const char *filepath);
121 bool            WM_file_read(struct bContext *C, const char *filepath, struct ReportList *reports);
122 void            WM_autosave_init(struct wmWindowManager *wm);
123 void            WM_recover_last_session(struct bContext *C, struct ReportList *reports);
124 void            WM_file_tag_modified(void);
125
126 void        WM_lib_reload(struct Library *lib, struct bContext *C, struct ReportList *reports);
127
128                         /* mouse cursors */
129 void            WM_cursor_set(struct wmWindow *win, int curs);
130 void            WM_cursor_modal_set(struct wmWindow *win, int curs);
131 void            WM_cursor_modal_restore(struct wmWindow *win);
132 void            WM_cursor_wait          (bool val);
133 void            WM_cursor_grab_enable(struct wmWindow *win, bool wrap, bool hide, int bounds[4]);
134 void            WM_cursor_grab_disable(struct wmWindow *win, const int mouse_ungrab_xy[2]);
135 void            WM_cursor_time          (struct wmWindow *win, int nr);
136
137 struct wmPaintCursor *WM_paint_cursor_activate(
138         struct wmWindowManager *wm,
139         bool (*poll)(struct bContext *C),
140         void (*draw)(struct bContext *C, int, int, void *customdata),
141         void *customdata);
142
143 bool            WM_paint_cursor_end(struct wmWindowManager *wm, struct wmPaintCursor *handle);
144 void       *WM_paint_cursor_customdata_get(struct wmPaintCursor *pc);
145 void            WM_paint_cursor_tag_redraw(struct wmWindow *win, struct ARegion *ar);
146
147
148 void            WM_cursor_warp          (struct wmWindow *win, int x, int y);
149 void            WM_cursor_compatible_xy(wmWindow *win, int *x, int *y);
150 float           WM_cursor_pressure      (const struct wmWindow *win);
151
152                         /* event map */
153 int                     WM_userdef_event_map(int kmitype);
154 int                     WM_userdef_event_type_from_keymap_type(int kmitype);
155
156                         /* handlers */
157
158 struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
159                                                 /* boundbox, optional subwindow boundbox for offset */
160 struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb);
161                                                 /* priority not implemented, it adds in begin */
162 struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority);
163
164 void            WM_event_remove_keymap_handler(ListBase *handlers, wmKeyMap *keymap);
165
166 typedef int (*wmUIHandlerFunc)(struct bContext *C, const struct wmEvent *event, void *userdata);
167 typedef void (*wmUIHandlerRemoveFunc)(struct bContext *C, void *userdata);
168
169 struct wmEventHandler *WM_event_add_ui_handler(
170         const struct bContext *C, ListBase *handlers,
171         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
172         void *userdata, const char flag);
173 void WM_event_remove_ui_handler(
174         ListBase *handlers,
175         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove,
176         void *userdata, const bool postpone);
177 void WM_event_remove_area_handler(
178         struct ListBase *handlers, void *area);
179 void WM_event_free_ui_handler_all(
180         struct bContext *C, ListBase *handlers,
181         wmUIHandlerFunc ui_handle, wmUIHandlerRemoveFunc ui_remove);
182
183 struct wmEventHandler *WM_event_add_modal_handler(struct bContext *C, struct wmOperator *op);
184 void            WM_event_remove_handlers(struct bContext *C, ListBase *handlers);
185
186 /* handler flag */
187 enum {
188         WM_HANDLER_BLOCKING             = (1 << 0),  /* after this handler all others are ignored */
189         WM_HANDLER_ACCEPT_DBL_CLICK     = (1 << 1),  /* handler accepts double key press events */
190
191         /* internal */
192         WM_HANDLER_DO_FREE              = (1 << 7),  /* handler tagged to be freed in wm_handlers_do() */
193 };
194
195 struct wmEventHandler *WM_event_add_dropbox_handler(ListBase *handlers, ListBase *dropboxes);
196
197                         /* mouse */
198 void            WM_event_add_mousemove(const struct bContext *C);
199 bool            WM_event_is_modal_tweak_exit(const struct wmEvent *event, int tweak_event);
200 bool            WM_event_is_last_mousemove(const struct wmEvent *event);
201
202 #ifdef WITH_INPUT_NDOF
203                         /* 3D mouse */
204 void            WM_ndof_deadzone_set(float deadzone);
205 #endif
206                         /* notifiers */
207 void            WM_event_add_notifier(const struct bContext *C, unsigned int type, void *reference);
208 void            WM_main_add_notifier(unsigned int type, void *reference);
209 void            WM_main_remove_notifier_reference(const void *reference);
210 void            WM_main_remap_editor_id_reference(struct ID *old_id, struct ID *new_id);
211
212                         /* reports */
213 void        WM_report_banner_show(void);
214 void        WM_report(ReportType type, const char *message);
215 void        WM_reportf(ReportType type, const char *format, ...) ATTR_PRINTF_FORMAT(2, 3);
216
217 struct wmEvent *wm_event_add_ex(
218         struct wmWindow *win, const struct wmEvent *event_to_add,
219         const struct wmEvent *event_to_add_after)
220         ATTR_NONNULL(1, 2);
221 struct wmEvent *wm_event_add(
222         struct wmWindow *win, const struct wmEvent *event_to_add)
223         ATTR_NONNULL(1, 2);
224
225 void wm_event_init_from_window(struct wmWindow *win, struct wmEvent *event);
226
227
228                         /* at maximum, every timestep seconds it triggers event_type events */
229 struct wmTimer *WM_event_add_timer(struct wmWindowManager *wm, struct wmWindow *win, int event_type, double timestep);
230 struct wmTimer *WM_event_add_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, unsigned int type, double timestep);
231 void            WM_event_remove_timer(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
232 void            WM_event_remove_timer_notifier(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer);
233 void        WM_event_timer_sleep(struct wmWindowManager *wm, struct wmWindow *win, struct wmTimer *timer, bool do_sleep);
234
235                 /* operator api, default callbacks */
236                         /* invoke callback, uses enum property named "type" */
237 void            WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op);
238 int                     WM_operator_smooth_viewtx_get(const struct wmOperator *op);
239 int                     WM_menu_invoke_ex(struct bContext *C, struct wmOperator *op, int opcontext);
240 int                     WM_menu_invoke                  (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
241 void            WM_menu_name_call(struct bContext *C, const char *menu_name, short context);
242 int                     WM_enum_search_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
243                         /* invoke callback, confirm menu + exec */
244 int                     WM_operator_confirm             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
245                 /* invoke callback, file selector "filepath" unset + exec */
246 int                     WM_operator_filesel             (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
247 bool        WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format);
248                         /* poll callback, context checks */
249 bool                    WM_operator_winactive   (struct bContext *C);
250                         /* invoke callback, exec + redo popup */
251 int                     WM_operator_props_popup_confirm(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
252 int                     WM_operator_props_popup_call(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
253 int                     WM_operator_props_popup (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
254 int             WM_operator_props_dialog_popup(struct bContext *C, struct wmOperator *op, int width, int height);
255 int                     WM_operator_redo_popup  (struct bContext *C, struct wmOperator *op);
256 int                     WM_operator_ui_popup    (struct bContext *C, struct wmOperator *op, int width, int height);
257
258 int         WM_operator_confirm_message_ex(struct bContext *C, struct wmOperator *op,
259                                            const char *title, const int icon,
260                                            const char *message);
261 int         WM_operator_confirm_message(struct bContext *C, struct wmOperator *op,
262                                         const char *message);
263
264                 /* operator api */
265 void            WM_operator_free                (struct wmOperator *op);
266 void            WM_operator_free_all_after(wmWindowManager *wm, struct wmOperator *op);
267 void            WM_operator_type_set(struct wmOperator *op, struct wmOperatorType *ot);
268 void            WM_operator_stack_clear(struct wmWindowManager *wm);
269 void            WM_operator_handlers_clear(wmWindowManager *wm, struct wmOperatorType *ot);
270
271 bool        WM_operator_poll            (struct bContext *C, struct wmOperatorType *ot);
272 bool        WM_operator_poll_context(struct bContext *C, struct wmOperatorType *ot, short context);
273 int         WM_operator_call_ex(struct bContext *C, struct wmOperator *op, const bool store);
274 int                     WM_operator_call                (struct bContext *C, struct wmOperator *op);
275 int                     WM_operator_call_notest(struct bContext *C, struct wmOperator *op);
276 int                     WM_operator_repeat              (struct bContext *C, struct wmOperator *op);
277 bool        WM_operator_repeat_check(const struct bContext *C, struct wmOperator *op);
278 bool        WM_operator_is_repeat(const struct bContext *C, const struct wmOperator *op);
279 int         WM_operator_name_call_ptr(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties);
280 int                     WM_operator_name_call(struct bContext *C, const char *opstring, short context, struct PointerRNA *properties);
281 int                     WM_operator_call_py(struct bContext *C, struct wmOperatorType *ot, short context, struct PointerRNA *properties, struct ReportList *reports, const bool is_undo);
282
283 void            WM_operator_properties_alloc(struct PointerRNA **ptr, struct IDProperty **properties, const char *opstring); /* used for keymap and macro items */
284 void            WM_operator_properties_sanitize(struct PointerRNA *ptr, const bool no_context); /* make props context sensitive or not */
285 bool        WM_operator_properties_default(struct PointerRNA *ptr, const bool do_update);
286 void        WM_operator_properties_reset(struct wmOperator *op);
287 void            WM_operator_properties_create(struct PointerRNA *ptr, const char *opstring);
288 void            WM_operator_properties_create_ptr(struct PointerRNA *ptr, struct wmOperatorType *ot);
289 void        WM_operator_properties_clear(struct PointerRNA *ptr);
290 void            WM_operator_properties_free(struct PointerRNA *ptr);
291
292 bool        WM_operator_check_ui_enabled(const struct bContext *C, const char *idname);
293 wmOperator *WM_operator_last_redo(const struct bContext *C);
294 ID         *WM_operator_drop_load_path(struct bContext *C, struct wmOperator *op, const short idcode);
295
296 bool        WM_operator_last_properties_init(struct wmOperator *op);
297 bool        WM_operator_last_properties_store(struct wmOperator *op);
298
299
300 /* wm_operator_props.c */
301 void        WM_operator_properties_filesel(
302         struct wmOperatorType *ot, int filter, short type, short action,
303         short flag, short display, short sort);
304 void        WM_operator_properties_border(struct wmOperatorType *ot);
305 void        WM_operator_properties_border_to_rcti(struct wmOperator *op, struct rcti *rect);
306 void        WM_operator_properties_border_to_rctf(struct wmOperator *op, rctf *rect);
307 void        WM_operator_properties_gesture_border_ex(struct wmOperatorType *ot, bool deselect, bool extend);
308 void        WM_operator_properties_gesture_border(struct wmOperatorType *ot);
309 void        WM_operator_properties_gesture_border_select(struct wmOperatorType *ot);
310 void        WM_operator_properties_gesture_border_zoom(struct wmOperatorType *ot);
311 void        WM_operator_properties_gesture_lasso_ex(struct wmOperatorType *ot, bool deselect, bool extend);
312 void        WM_operator_properties_gesture_lasso(struct wmOperatorType *ot);
313 void        WM_operator_properties_gesture_lasso_select(struct wmOperatorType *ot);
314 void        WM_operator_properties_gesture_straightline(struct wmOperatorType *ot, int cursor);
315 void        WM_operator_properties_gesture_circle_ex(struct wmOperatorType *ot, bool deselect);
316 void        WM_operator_properties_gesture_circle(struct wmOperatorType *ot);
317 void        WM_operator_properties_gesture_circle_select(struct wmOperatorType *ot);
318 void        WM_operator_properties_mouse_select(struct wmOperatorType *ot);
319 void        WM_operator_properties_select_all(struct wmOperatorType *ot);
320 void        WM_operator_properties_select_action(struct wmOperatorType *ot, int default_action);
321 void        WM_operator_properties_select_action_simple(struct wmOperatorType *ot, int default_action);
322 void        WM_operator_properties_select_random(struct wmOperatorType *ot);
323 int         WM_operator_properties_select_random_seed_increment_get(wmOperator *op);
324 struct CheckerIntervalParams {
325         int nth;  /* bypass when set to zero */
326         int skip;
327         int offset;
328 };
329 void        WM_operator_properties_checker_interval(struct wmOperatorType *ot, bool nth_can_disable);
330 void        WM_operator_properties_checker_interval_from_op(
331         struct wmOperator *op, struct CheckerIntervalParams *op_params);
332 bool        WM_operator_properties_checker_interval_test(
333         const struct CheckerIntervalParams *op_params, int depth);
334
335
336 /* MOVE THIS SOMEWHERE ELSE */
337 #define SEL_TOGGLE              0
338 #define SEL_SELECT              1
339 #define SEL_DESELECT    2
340 #define SEL_INVERT              3
341
342
343 /* flags for WM_operator_properties_filesel */
344 #define WM_FILESEL_RELPATH              (1 << 0)
345
346 #define WM_FILESEL_DIRECTORY    (1 << 1)
347 #define WM_FILESEL_FILENAME             (1 << 2)
348 #define WM_FILESEL_FILEPATH             (1 << 3)
349 #define WM_FILESEL_FILES                (1 << 4)
350
351
352                 /* operator as a python command (resultuing string must be freed) */
353 char            *WM_operator_pystring_ex(struct bContext *C, struct wmOperator *op,
354                                      const bool all_args, const bool macro_args,
355                                      struct wmOperatorType *ot, struct PointerRNA *opptr);
356 char            *WM_operator_pystring(struct bContext *C, struct wmOperator *op,
357                                   const bool all_args, const bool macro_args);
358 bool         WM_operator_pystring_abbreviate(char *str, int str_len_max);
359 char            *WM_prop_pystring_assign(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, int index);
360 void            WM_operator_bl_idname(char *to, const char *from);
361 void            WM_operator_py_idname(char *to, const char *from);
362 bool        WM_operator_py_idname_ok_or_report(struct ReportList *reports, const char *classname, const char *idname);
363
364
365 /* wm_operator_type.c */
366 struct wmOperatorType *WM_operatortype_find(const char *idname, bool quiet);
367 void WM_operatortype_iter(struct GHashIterator *ghi);
368 void WM_operatortype_append(void (*opfunc)(struct wmOperatorType *));
369 void WM_operatortype_append_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
370 void WM_operatortype_append_macro_ptr(void (*opfunc)(struct wmOperatorType *, void *), void *userdata);
371 void WM_operatortype_remove_ptr(struct wmOperatorType *ot);
372 bool WM_operatortype_remove(const char *idname);
373 void WM_operatortype_last_properties_clear_all(void);
374
375 struct wmOperatorType *WM_operatortype_append_macro(const char *idname, const char *name, const char *description, int flag);
376 struct wmOperatorTypeMacro *WM_operatortype_macro_define(struct wmOperatorType *ot, const char *idname);
377
378 /* wm_uilist_type.c */
379 void                WM_uilisttype_init(void);
380 struct uiListType  *WM_uilisttype_find(const char *idname, bool quiet);
381 bool                WM_uilisttype_add(struct uiListType *ult);
382 void                WM_uilisttype_freelink(struct uiListType *ult);
383 void                WM_uilisttype_free(void);
384
385 /* wm_menu_type.c */
386 void                WM_menutype_init(void);
387 struct MenuType    *WM_menutype_find(const char *idname, bool quiet);
388 bool                WM_menutype_add(struct MenuType *mt);
389 void                WM_menutype_freelink(struct MenuType *mt);
390 void                WM_menutype_free(void);
391 bool                WM_menutype_poll(struct bContext *C, struct MenuType *mt);
392
393 /* wm_gesture_ops.c */
394 int                     WM_gesture_border_invoke        (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
395 int                     WM_gesture_border_modal (struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
396 void            WM_gesture_border_cancel(struct bContext *C, struct wmOperator *op);
397 int                     WM_gesture_circle_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
398 int                     WM_gesture_circle_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
399 void            WM_gesture_circle_cancel(struct bContext *C, struct wmOperator *op);
400 int                     WM_gesture_lines_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
401 int                     WM_gesture_lines_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
402 void            WM_gesture_lines_cancel(struct bContext *C, struct wmOperator *op);
403 int                     WM_gesture_lasso_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
404 int                     WM_gesture_lasso_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
405 void            WM_gesture_lasso_cancel(struct bContext *C, struct wmOperator *op);
406 const int (*WM_gesture_lasso_path_to_array(struct bContext *C, struct wmOperator *op, int *mcords_tot))[2];
407 int                     WM_gesture_straightline_invoke(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
408 int                     WM_gesture_straightline_modal(struct bContext *C, struct wmOperator *op, const struct wmEvent *event);
409 void            WM_gesture_straightline_cancel(struct bContext *C, struct wmOperator *op);
410
411                         /* Gesture manager API */
412 struct wmGesture *WM_gesture_new(struct bContext *C, const struct wmEvent *event, int type);
413 void            WM_gesture_end(struct bContext *C, struct wmGesture *gesture);
414 void            WM_gestures_remove(struct bContext *C);
415
416                         /* fileselecting support */
417 void            WM_event_add_fileselect(struct bContext *C, struct wmOperator *op);
418 void            WM_event_fileselect_event(struct wmWindowManager *wm, void *ophandle, int eventval);
419 void            WM_event_print(const struct wmEvent *event);
420
421 void            WM_operator_region_active_win_set(struct bContext *C);
422
423                         /* drag and drop */
424 struct wmDrag           *WM_event_start_drag(struct bContext *C, int icon, int type, void *poin, double value, unsigned int flags);
425 void                            WM_event_drag_image(struct wmDrag *, struct ImBuf *, float scale, int sx, int sy);
426 void                WM_drag_free(struct wmDrag *drag);
427 void                WM_drag_free_list(struct ListBase *lb);
428
429 struct wmDropBox        *WM_dropbox_add(
430         ListBase *lb, const char *idname, bool (*poll)(struct bContext *, struct wmDrag *, const struct wmEvent *event),
431         void (*copy)(struct wmDrag *, struct wmDropBox *));
432 ListBase        *WM_dropboxmap_find(const char *idname, int spaceid, int regionid);
433
434                         /* Set a subwindow active in pixelspace view, with optional scissor subset */
435 void            wmSubWindowSet                  (struct wmWindow *win, int swinid);
436 void            wmSubWindowScissorSet   (struct wmWindow *win, int swinid, const struct rcti *srct, bool srct_pad);
437
438                         /* OpenGL utilities with safety check + working in modelview matrix mode */
439 void            wmFrustum                       (float x1, float x2, float y1, float y2, float n, float f);
440 void            wmOrtho                         (float x1, float x2, float y1, float y2, float n, float f);
441 void            wmOrtho2                        (float x1, float x2, float y1, float y2);
442                         /* use for conventions (avoid hard-coded offsets all over) */
443 void            wmOrtho2_region_pixelspace(const struct ARegion *ar);
444 void            wmOrtho2_pixelspace(const float x, const float y);
445
446                         /* threaded Jobs Manager */
447 enum {
448         WM_JOB_PRIORITY     = (1 << 0),
449         WM_JOB_EXCL_RENDER  = (1 << 1),
450         WM_JOB_PROGRESS     = (1 << 2),
451         WM_JOB_SUSPEND      = (1 << 3),
452 };
453
454 /* identifying jobs by owner alone is unreliable, this isnt saved, order can change (keep 0 for 'any') */
455 enum {
456         WM_JOB_TYPE_ANY = 0,
457         WM_JOB_TYPE_COMPOSITE,
458         WM_JOB_TYPE_RENDER,
459         WM_JOB_TYPE_RENDER_PREVIEW,  /* UI preview */
460         WM_JOB_TYPE_OBJECT_SIM_OCEAN,
461         WM_JOB_TYPE_OBJECT_SIM_FLUID,
462         WM_JOB_TYPE_OBJECT_BAKE_TEXTURE,
463         WM_JOB_TYPE_OBJECT_BAKE,
464         WM_JOB_TYPE_FILESEL_READDIR,
465         WM_JOB_TYPE_CLIP_BUILD_PROXY,
466         WM_JOB_TYPE_CLIP_TRACK_MARKERS,
467         WM_JOB_TYPE_CLIP_SOLVE_CAMERA,
468         WM_JOB_TYPE_CLIP_PREFETCH,
469         WM_JOB_TYPE_SEQ_BUILD_PROXY,
470         WM_JOB_TYPE_SEQ_BUILD_PREVIEW,
471         WM_JOB_TYPE_POINTCACHE,
472         WM_JOB_TYPE_DPAINT_BAKE,
473         WM_JOB_TYPE_ALEMBIC,
474         /* add as needed, seq proxy build
475          * if having hard coded values is a problem */
476 };
477
478 struct wmJob *WM_jobs_get(struct wmWindowManager *wm, struct wmWindow *win, void *owner, const char *name, int flag, int job_type);
479
480 bool        WM_jobs_test(struct wmWindowManager *wm, void *owner, int job_type);
481 float           WM_jobs_progress(struct wmWindowManager *wm, void *owner);
482 char       *WM_jobs_name(struct wmWindowManager *wm, void *owner);
483 double      WM_jobs_starttime(struct wmWindowManager *wm, void *owner);
484 void       *WM_jobs_customdata(struct wmWindowManager *wm, void *owner);
485 void       *WM_jobs_customdata_from_type(struct wmWindowManager *wm, int job_type);
486
487 bool        WM_jobs_is_running(struct wmJob *);
488 bool            WM_jobs_is_stopped(wmWindowManager *wm, void *owner);
489 void       *WM_jobs_customdata_get(struct wmJob *);
490 void        WM_jobs_customdata_set(struct wmJob *, void *customdata, void (*free)(void *));
491 void        WM_jobs_timer(struct wmJob *, double timestep, unsigned int note, unsigned int endnote);
492 void        WM_jobs_callbacks(struct wmJob *,
493                               void (*startjob)(void *, short *, short *, float *),
494                               void (*initjob)(void *),
495                               void (*update)(void *),
496                               void (*endjob)(void *));
497
498 void            WM_jobs_start(struct wmWindowManager *wm, struct wmJob *);
499 void            WM_jobs_stop(struct wmWindowManager *wm, void *owner, void *startjob);
500 void            WM_jobs_kill(struct wmWindowManager *wm, void *owner, void (*)(void *, short int *, short int *, float *));
501 void            WM_jobs_kill_all(struct wmWindowManager *wm);
502 void            WM_jobs_kill_all_except(struct wmWindowManager *wm, void *owner);
503 void            WM_jobs_kill_type(struct wmWindowManager *wm, void *owner, int job_type);
504
505 bool        WM_jobs_has_running(struct wmWindowManager *wm);
506
507 void            WM_job_main_thread_lock_acquire(struct wmJob *job);
508 void            WM_job_main_thread_lock_release(struct wmJob *job);
509
510                         /* clipboard */
511 char       *WM_clipboard_text_get(bool selection, int *r_len);
512 char       *WM_clipboard_text_get_firstline(bool selection, int *r_len);
513 void        WM_clipboard_text_set(const char *buf, bool selection);
514
515                         /* progress */
516 void            WM_progress_set(struct wmWindow *win, float progress);
517 void            WM_progress_clear(struct wmWindow *win);
518
519                         /* Draw (for screenshot) */
520 void        *WM_draw_cb_activate(
521                     struct wmWindow *win,
522                     void(*draw)(const struct wmWindow *, void *),
523                     void *customdata);
524 void        WM_draw_cb_exit(struct wmWindow *win, void *handle);
525 void            WM_redraw_windows(struct bContext *C);
526
527 void        WM_main_playanim(int argc, const char **argv);
528
529 /* debugging only, convenience function to write on crash */
530 bool write_crash_blend(void);
531
532                         /* Lock the interface for any communication */
533 void        WM_set_locked_interface(struct wmWindowManager *wm, bool lock);
534
535 #ifdef WITH_INPUT_NDOF
536 void        WM_event_ndof_pan_get(const struct wmNDOFMotionData *ndof, float r_pan[3], const bool use_zoom);
537 void        WM_event_ndof_rotate_get(const struct wmNDOFMotionData *ndof, float r_rot[3]);
538
539 float       WM_event_ndof_to_axis_angle(const struct wmNDOFMotionData *ndof, float axis[3]);
540 void        WM_event_ndof_to_quat(const struct wmNDOFMotionData *ndof, float q[4]);
541 #endif /* WITH_INPUT_NDOF */
542
543 float       WM_event_tablet_data(const struct wmEvent *event, int *pen_flip, float tilt[2]);
544 bool        WM_event_is_tablet(const struct wmEvent *event);
545
546 #ifdef WITH_INPUT_IME
547 bool        WM_event_is_ime_switch(const struct wmEvent *event);
548 #endif
549
550 /* wm_tooltip.c */
551 typedef struct ARegion *(*wmTooltipInitFn)(struct bContext *, struct ARegion *, bool *);
552
553 void WM_tooltip_timer_init(
554         struct bContext *C, struct wmWindow *win, struct ARegion *ar,
555         wmTooltipInitFn init);
556 void WM_tooltip_timer_clear(struct bContext *C, struct wmWindow *win);
557 void WM_tooltip_clear(struct bContext *C, struct wmWindow *win);
558 void WM_tooltip_init(struct bContext *C, struct wmWindow *win);
559 void WM_tooltip_refresh(struct bContext *C, struct wmWindow *win);
560
561 #ifdef __cplusplus
562 }
563 #endif
564
565 #endif /* __WM_API_H__ */