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