BLI_timer.cc File Reference

#include "BLI_timer.h"
#include "BLI_listbase.h"
#include "BLI_time.h"
#include "MEM_guardedalloc.h"

Go to the source code of this file.

Classes
struct	TimedFunction
struct	TimerContainer

Macros
#define	GET_TIME()

Functions
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)
static void	clear_user_data (TimedFunction *timed_func)
bool	BLI_timer_unregister (uintptr_t uuid)
bool	BLI_timer_is_registered (uintptr_t uuid)
static void	execute_functions_if_necessary ()
static void	remove_tagged_functions ()
void	BLI_timer_execute ()
void	BLI_timer_free ()
static void	remove_non_persistent_functions ()
void	BLI_timer_on_file_load ()

Variables
static TimerContainer	GlobalTimer = {{nullptr}}

Macro Definition Documentation

GET_TIME

#define GET_TIME

(

)

Value:

BLI_time_now_seconds()

Definition at line 15 of file BLI_timer.cc.

Referenced by BLI_timer_register(), and execute_functions_if_necessary().

Function Documentation

BLI_timer_execute()

void BLI_timer_execute

(

void

)

Execute all registered functions that are due.

Definition at line 120 of file BLI_timer.cc.

References BLI_timer_execute(), execute_functions_if_necessary(), and remove_tagged_functions().

Referenced by BLI_timer_execute(), and wm_event_timers_execute().

BLI_timer_free()

void BLI_timer_free

(

void

)

Definition at line 126 of file BLI_timer.cc.

References BLI_timer_free(), TimerContainer::funcs, GlobalTimer, LISTBASE_FOREACH, and remove_tagged_functions().

Referenced by BLI_timer_free(), and WM_exit_ex().

BLI_timer_is_registered()

bool BLI_timer_is_registered

(

uintptr_t

uuid

)

Definition at line 73 of file BLI_timer.cc.

References BLI_timer_is_registered(), TimerContainer::funcs, GlobalTimer, and LISTBASE_FOREACH.

Referenced by BLI_timer_is_registered(), and bpy_app_timers_is_registered().

BLI_timer_on_file_load()

void BLI_timer_on_file_load

(

void

)

Definition at line 144 of file BLI_timer.cc.

References BLI_timer_on_file_load(), and remove_non_persistent_functions().

Referenced by BLI_timer_on_file_load(), and wm_file_read_pre().

BLI_timer_register()

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 )

Definition at line 34 of file BLI_timer.cc.

References BLI_addtail(), BLI_timer_register(), TimedFunction::func, TimerContainer::funcs, GET_TIME, GlobalTimer, MEM_callocN(), TimedFunction::next_time, TimedFunction::persistent, TimedFunction::tag_removal, TimedFunction::user_data, TimedFunction::user_data_free, and TimedFunction::uuid.

Referenced by BLI_timer_register(), and bpy_app_timers_register().

BLI_timer_unregister()

bool BLI_timer_unregister

(

uintptr_t

uuid

)

Returns False when the timer does not exist (anymore).

Definition at line 61 of file BLI_timer.cc.

References BLI_timer_unregister(), clear_user_data(), TimerContainer::funcs, GlobalTimer, and LISTBASE_FOREACH.

Referenced by BLI_timer_unregister(), and bpy_app_timers_unregister().

clear_user_data()

void clear_user_data ( TimedFunction * timed_func )

static

Definition at line 53 of file BLI_timer.cc.

References clear_user_data(), TimedFunction::user_data, TimedFunction::user_data_free, and TimedFunction::uuid.

Referenced by BLI_timer_unregister(), clear_user_data(), and remove_tagged_functions().

execute_functions_if_necessary()

void execute_functions_if_necessary ( )

static

Definition at line 83 of file BLI_timer.cc.

References execute_functions_if_necessary(), TimerContainer::funcs, GET_TIME, GlobalTimer, LISTBASE_FOREACH, and ret.

Referenced by BLI_timer_execute(), and execute_functions_if_necessary().

remove_non_persistent_functions()

void remove_non_persistent_functions ( )

static

Definition at line 135 of file BLI_timer.cc.

References TimerContainer::funcs, GlobalTimer, LISTBASE_FOREACH, and remove_non_persistent_functions().

Referenced by BLI_timer_on_file_load(), and remove_non_persistent_functions().

remove_tagged_functions()

void remove_tagged_functions ( )

static

Definition at line 106 of file BLI_timer.cc.

References BLI_freelinkN(), clear_user_data(), ListBase::first, TimerContainer::funcs, GlobalTimer, TimedFunction::next, and remove_tagged_functions().

Referenced by BLI_timer_execute(), BLI_timer_free(), and remove_tagged_functions().

Variable Documentation

GlobalTimer

TimerContainer GlobalTimer = {{nullptr}}

static

Definition at line 32 of file BLI_timer.cc.

Referenced by BLI_timer_free(), BLI_timer_is_registered(), BLI_timer_register(), BLI_timer_unregister(), execute_functions_if_necessary(), remove_non_persistent_functions(), and remove_tagged_functions().