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