UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Private::FOutputDevicesPrimaryScopeLock Class Reference

Public Member Functions

 FOutputDevicesPrimaryScopeLock (FOutputDeviceRedirectorState &InState)
 
FORCEINLINE ~FOutputDevicesPrimaryScopeLock ()
 
FORCEINLINE bool IsLocked () const
 

Detailed Description

A scoped lock for exclusive access to the state of the primary log thread.

The primary lock has the same access as the read lock, and:

  • Must not be entered when the thread holds a write lock or primary lock.
  • Must check IsLocked() before performing restricted operations.
  • Must be locked to write to buffered output devices.
  • Must be locked while calling FlushBufferedItems().
  • May be locked when the thread holds a read lock.
  • When a panic thread is active, locking will only succeed from the panic thread.

Constructor & Destructor Documentation

◆ FOutputDevicesPrimaryScopeLock()

UE::Private::FOutputDevicesPrimaryScopeLock::FOutputDevicesPrimaryScopeLock ( FOutputDeviceRedirectorState InState)
inlineexplicit

◆ ~FOutputDevicesPrimaryScopeLock()

FORCEINLINE UE::Private::FOutputDevicesPrimaryScopeLock::~FOutputDevicesPrimaryScopeLock ( )
inline

Member Function Documentation

◆ IsLocked()

FORCEINLINE bool UE::Private::FOutputDevicesPrimaryScopeLock::IsLocked ( ) const
inline

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