Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_timer.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) 2018 Blender Foundation.
19  * All rights reserved.
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 #ifndef __BLI_TIMER_H__
25 #define __BLI_TIMER_H__
26
27 #include "BLI_sys_types.h"
28
29 /** \file BLI_timer.h
30  *  \ingroup BLI
31  */
32
33 /* ret < 0: the timer will be removed.
34  * ret >= 0: the timer will be called again in ret seconds */
35 typedef double (*BLI_timer_func)(uintptr_t uuid, void *user_data);
36 typedef void (*BLI_timer_data_free)(uintptr_t uuid, void *user_data);
37
38 /* `func(...) < 0`: The timer will be removed.
39  * `func(...) >= 0`: The function will be called again in that many seconds. */
40 void BLI_timer_register(
41         uintptr_t uuid,
42         BLI_timer_func func,
43         void *user_data,
44         BLI_timer_data_free user_data_free,
45         double first_interval,
46         bool persistent);
47
48 bool BLI_timer_is_registered(uintptr_t uuid);
49
50 /* Returns False when the timer does not exist (anymore). */
51 bool BLI_timer_unregister(uintptr_t uuid);
52
53 /* Execute all registered functions that are due. */
54 void BLI_timer_execute(void);
55
56 void BLI_timer_free(void);
57
58 #endif  /* __BLI_TIMER_H__ */