FMutex | Unreal Engine 5.7 Documentation | Epic Developer Community

A one-byte mutex that is not fair and does not support recursive locking.


Name	FMutex
Type	class
Header File	/Engine/Source/Runtime/Core/Public/Async/Mutex.h
Include Path	#include "Async/Mutex.h"

Syntax

class FMutex

Name	Remarks	Include Path
constexpr FMutex ()		Async/Mutex.h
FMutex ( FAcquireLock )	Construct in a locked state. Avoids an expensive compare-and-swap at creation time.	Async/Mutex.h
FMutex ( const FMutex& )		Async/Mutex.h

Name	Remarks
FParams

Name	Type	Remarks	Include Path
IsLockedFlag	uint8		Async/Mutex.h
MayHaveWaitingLockFlag	uint8		Async/Mutex.h

Name	Type	Remarks	Include Path	Unreal Specifiers
State	std::atomic< uint8 >		Async/Mutex.h

Name	Remarks	Include Path	Unreal Specifiers
bool IsLocked()		Async/Mutex.h
void Lock()		Async/Mutex.h
bool TryLock()		Async/Mutex.h
void Unlock()		Async/Mutex.h

Name	Remarks	Include Path	Unreal Specifiers
FMutex & operator= ( const FMutex& )		Async/Mutex.h