Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Chaos > Framework > FPhysicsSceneGuard

Light Theme

Dark Theme

FPhysicsSceneGuard

Recursive Read/Write lock object for protecting external data accesses for physics scenes.

Windows

MacOS

Linux

References

Module	Chaos
Header	/Engine/Source/Runtime/Experimental/Chaos/Public/Framework/Threading.h
Include	#include "Framework/Threading.h"

Syntax

class FPhysicsSceneGuard

Remarks

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

Constructors

	Name	Description
	FPhysicsSceneGuard()
	FPhysicsSceneGuard ( const FPhysicsSceneGuard& InOther )
	FPhysicsSceneGuard ( FPhysicsSceneGuard&& InOther )

Destructors

	Name	Description
	~FPhysicsSceneGuard()

Functions

		Name	Description
	void	ReadLock()
	void	ReadUnlock()
	void	WriteLock()
	void	WriteUnlock()

Operators

		Name	Description
	FPhysicsScen...	operator= ( const FPhysicsSceneGuard& InOther )
	FPhysicsScen...	operator= ( FPhysicsSceneGuard&& InOther )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss