UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::FMutex Class Referencefinal

#include <Mutex.h>

Classes

struct  FParams
 

Public Member Functions

constexpr FMutex ()=default
 
 FMutex (FAcquireLock)
 
 FMutex (const FMutex &)=delete
 
FMutexoperator= (const FMutex &)=delete
 
bool IsLocked () const
 
bool TryLock ()
 
void Lock ()
 
void Unlock ()
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FMutex() [1/3]

constexpr UE::FMutex::FMutex ( )
constexprdefault

◆ FMutex() [2/3]

UE::FMutex::FMutex ( FAcquireLock  )
inlineexplicit

Construct in a locked state. Avoids an expensive compare-and-swap at creation time.

◆ FMutex() [3/3]

UE::FMutex::FMutex ( const FMutex )
delete

Member Function Documentation

◆ IsLocked()

bool UE::FMutex::IsLocked ( ) const
inline

◆ Lock()

void UE::FMutex::Lock ( )
inline

◆ operator=()

FMutex & UE::FMutex::operator= ( const FMutex )
delete

◆ TryLock()

bool UE::FMutex::TryLock ( )
inline

◆ Unlock()

void UE::FMutex::Unlock ( )
inline

The documentation for this class was generated from the following files: