Detailed Description

Utility classes for multi-threading.

Classes
class	ImFusion::Threading::PlaybackTimer
	Recurring timer class that allows for playback over a range at given timestamps/intervals. More...
class	ImFusion::Threading::StoppableThread
	Extension of a std::thread to allow for signalling the thread to abort its execution. More...
class	ImFusion::Threading::ThreadPool
	Lightweight implementation of a thread pool for distributing work onto a fixed number of threads. More...

Functions
void	ImFusion::Threading::setCurrentThreadName (const std::string &threadName)
	Sets the current thread's name to the given string so that a debugger may show it as description.
std::optional< Priority >	ImFusion::Threading::currentThreadPriority ()
	Queries the current thread's priority from the operating system or std::nullopt if an error occurred.
bool	ImFusion::Threading::setCurrentThreadPriority (Priority priority)
	Sets the current thread's priority to the given value.
void	ImFusion::Threading::runAsyncAndForget (std::function< void()> func)
	Launches the given function in a background thread using std::thread This function will return immediately and there is no built-in way to know when func has completed.

Function Documentation

void ImFusion::Threading::setCurrentThreadName ( const std::string & threadName )

#include <ImFusion/Core/Threading.h>

Sets the current thread's name to the given string so that a debugger may show it as description.

This functionality is platform-dependent and may not reliably work on all platforms.

std::optional< Priority > ImFusion::Threading::currentThreadPriority ( )

#include <ImFusion/Core/Threading.h>

Queries the current thread's priority from the operating system or std::nullopt if an error occurred.

bool ImFusion::Threading::setCurrentThreadPriority ( Priority priority )

#include <ImFusion/Core/Threading.h>

Sets the current thread's priority to the given value.

It will not affect the scheduling of other threads or of the whole process.

Note: On Linux the main executable needs the CAP_SYS_NICE capability for the process to be able to modify its own priority, or an EACCES error will be reported.