Merge branch 'blender-v2.81-release'
[blender.git] / source / blender / blenlib / BLI_timer.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2018 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_TIMER_H__
21 #define __BLI_TIMER_H__
22
23 #include "BLI_sys_types.h"
24
25 /** \file
26  * \ingroup BLI
27  */
28
29 /* ret < 0: the timer will be removed.
30  * ret >= 0: the timer will be called again in ret seconds */
31 typedef double (*BLI_timer_func)(uintptr_t uuid, void *user_data);
32 typedef void (*BLI_timer_data_free)(uintptr_t uuid, void *user_data);
33
34 /* `func(...) < 0`: The timer will be removed.
35  * `func(...) >= 0`: The function will be called again in that many seconds. */
36 void BLI_timer_register(uintptr_t uuid,
37                         BLI_timer_func func,
38                         void *user_data,
39                         BLI_timer_data_free user_data_free,
40                         double first_interval,
41                         bool persistent);
42
43 bool BLI_timer_is_registered(uintptr_t uuid);
44
45 /* Returns False when the timer does not exist (anymore). */
46 bool BLI_timer_unregister(uintptr_t uuid);
47
48 /* Execute all registered functions that are due. */
49 void BLI_timer_execute(void);
50
51 void BLI_timer_free(void);
52
53 /* This function is to be called next to BKE_CB_EVT_LOAD_PRE, to make sure the module
54  * is properly configured for the new file. */
55 void BLI_timer_on_file_load(void);
56
57 #endif /* __BLI_TIMER_H__ */