Chaos::FPhysicsSceneGuard Class Reference

#include <Threading.h>

Public Member Functions
	FPhysicsSceneGuard ()
	~FPhysicsSceneGuard ()
	FPhysicsSceneGuard (const FPhysicsSceneGuard &InOther)=delete
	FPhysicsSceneGuard (FPhysicsSceneGuard &&InOther)=delete
FPhysicsSceneGuard &	operator= (const FPhysicsSceneGuard &InOther)=delete
FPhysicsSceneGuard &	operator= (FPhysicsSceneGuard &&InOther)=delete
void	ReadLock ()
void	WriteLock ()
void	ReadUnlock ()
void	WriteUnlock ()

Detailed Description

Recursive Read/Write lock object for protecting external data accesses for physics scenes. This is a fairly heavy lock designed to allow scene queries and user code to safely access external physics data.

The lock also allows a thread to recursively lock data to avoid deadlocks on repeated writes or undefined behavior for nesting read locks.

Fairness is determined by the underlying platform FRWLock type as this lock uses FRWLock as it's internal primitive

Constructor & Destructor Documentation

FPhysicsSceneGuard() [1/3]

Chaos::FPhysicsSceneGuard::FPhysicsSceneGuard ( )

inline

~FPhysicsSceneGuard()

Chaos::FPhysicsSceneGuard::~FPhysicsSceneGuard ( )

inline

FPhysicsSceneGuard() [2/3]

Chaos::FPhysicsSceneGuard::FPhysicsSceneGuard ( const FPhysicsSceneGuard &  InOther )

delete

FPhysicsSceneGuard() [3/3]

Chaos::FPhysicsSceneGuard::FPhysicsSceneGuard ( FPhysicsSceneGuard &&  InOther )

delete

Member Function Documentation

operator=() [1/2]

FPhysicsSceneGuard & Chaos::FPhysicsSceneGuard::operator= ( const FPhysicsSceneGuard &  InOther )

delete

operator=() [2/2]

FPhysicsSceneGuard & Chaos::FPhysicsSceneGuard::operator= ( FPhysicsSceneGuard &&  InOther )

delete

ReadLock()

void Chaos::FPhysicsSceneGuard::ReadLock ( )

inline

ReadUnlock()

void Chaos::FPhysicsSceneGuard::ReadUnlock ( )

inline

WriteLock()

void Chaos::FPhysicsSceneGuard::WriteLock ( )

inline

WriteUnlock()

void Chaos::FPhysicsSceneGuard::WriteUnlock ( )

inline

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Framework/Threading.h