Up to date
This page is up to date for Godot
If you still find outdated information, please open an issue.
A synchronization mutex (mutual exclusion). This is used to synchronize multiple Threads, and is equivalent to a binary Semaphore. It guarantees that only one thread can access a critical section at a time.
This is a reentrant mutex, meaning that it can be locked multiple times by one thread, provided it also unlocks it as many times.
Warning: Mutexes must be used carefully to avoid deadlocks.
Warning: To ensure proper cleanup without crashes or deadlocks, the following conditions must be met:
When a Mutex's reference count reaches zero and it is therefore destroyed, no threads (including the one on which the destruction will happen) must have it locked.
When a Thread's reference count reaches zero and it is therefore destroyed, it must not have any mutex locked.
lock ( )
try_lock ( )
unlock ( )
void lock ( )
Locks this Mutex, blocks until it is unlocked by the current owner.
Note: This function returns without blocking if the thread already has ownership of the mutex.
bool try_lock ( )
Tries locking this Mutex, but does not block. Returns
true on success,
Note: This function returns
true if the thread already has ownership of the mutex.
void unlock ( )
Unlocks this Mutex, leaving it to other threads.