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 > ChaosSolvers > FChaosScopedPhysicsThreadLock

Light Theme

Dark Theme

FChaosScopedPhysicsThreadLock

Scoped locking object for physics thread.

Windows

MacOS

Linux

References

Module	ChaosSolvers
Header	/Engine/Source/Runtime/Experimental/ChaosSolvers/Public/ChaosSolversModule.h
Include	#include "ChaosSolversModule.h"

Syntax

class FChaosScopedPhysicsThreadLock

Remarks

Scoped locking object for physics thread. Currently this will stall out the persistent physics task if it is running. Use this in situations where another thread absolutely must read or write.

Will block on construction until the physics thread confirms it has stalled, then the constructor returns. Will let the physics thread continue post-destruction

Does a runtime check on the type of the dispatcher and will do nothing if we're not running the dedicated thread mode.

Constructors

	Name	Description
	FChaosScopedPhysicsThreadLock()
	FChaosScopedPhysicsThreadLock ( uint32 InMsToWait )

Destructors

	Name	Description
	~FChaosScopedPhysicsThreadLock()

Functions

		Name	Description
	bool	DidGetLock()

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

Take our survey

Dismiss