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

#include <WordMutex.h>

Public Member Functions

constexpr FWordMutex ()=default
 
 FWordMutex (const FWordMutex &)=delete
 
FWordMutexoperator= (const FWordMutex &)=delete
 
bool TryLock ()
 
void Lock ()
 
void Unlock ()
 

Detailed Description

A mutex that is the size of a pointer and does not depend on ParkingLot.

Prefer FMutex to FWordMutex whenever possible. This mutex is not fair and does not support recursive locking.

Constructor & Destructor Documentation

◆ FWordMutex() [1/2]

constexpr UE::FWordMutex::FWordMutex ( )
constexprdefault

◆ FWordMutex() [2/2]

UE::FWordMutex::FWordMutex ( const FWordMutex )
delete

Member Function Documentation

◆ Lock()

void UE::FWordMutex::Lock ( )
inline

◆ operator=()

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

◆ TryLock()

bool UE::FWordMutex::TryLock ( )
inline

◆ Unlock()

void UE::FWordMutex::Unlock ( )
inline

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