blob: 440fca0d54dea626dee2a911b74ff9e6f90dce71 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2018 Blender Foundation. All rights reserved. */
#pragma once
#include "BLI_sys_types.h"
/** \file
* \ingroup bli
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* \return A value of:
* - < 0: the timer will be removed.
* - >= 0: the timer will be called again in this number of seconds.
*/
typedef double (*BLI_timer_func)(uintptr_t uuid, void *user_data);
typedef void (*BLI_timer_data_free)(uintptr_t uuid, void *user_data);
/* `func(...) < 0`: The timer will be removed.
* `func(...) >= 0`: The function will be called again in that many seconds. */
void BLI_timer_register(uintptr_t uuid,
BLI_timer_func func,
void *user_data,
BLI_timer_data_free user_data_free,
double first_interval,
bool persistent);
bool BLI_timer_is_registered(uintptr_t uuid);
/** Returns False when the timer does not exist (anymore). */
bool BLI_timer_unregister(uintptr_t uuid);
/** Execute all registered functions that are due. */
void BLI_timer_execute(void);
void BLI_timer_free(void);
/* This function is to be called next to BKE_CB_EVT_LOAD_PRE, to make sure the module
* is properly configured for the new file. */
void BLI_timer_on_file_load(void);
#ifdef __cplusplus
}
#endif
|