UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
ChaosVDRecording.h File Reference

Go to the source code of this file.

Classes

struct  FChaosVDCustomFrameData
 
struct  FChaosVDFrameStageData
 
struct  FChaosVDTrackedLocation
 
struct  FChaosVDTrackedTransform
 
struct  FChaosVDSolverFrameData
 
struct  FChaosVDGameFrameData
 
struct  FChaosVDGameFrameDataWrapper
 
struct  FChaosVDGameFrameDataWrapperContext
 
struct  FChaosVDRecording
 

Namespaces

namespace  Chaos
 
namespace  Chaos::VisualDebugger
 

Macros

#define UE_API   CHAOSVDDATA_API
 

Typedefs

typedef FChaosVDFrameStageData FChaosVDStepData
 
typedef TArray< FChaosVDFrameStageData, TInlineAllocator< 16 > > FChaosVDStepsContainer
 
typedef TArray< FChaosVDFrameStageData, TInlineAllocator< 16 > > FChaosVDFrameStagesContainer
 

Enumerations

enum class  EChaosVDSolverStageFlags : uint8 { None = 0 , Open = 1 << 0 , ExplicitStage = 1 << 1 }
 
enum class  EChaosVDNetworkSyncDataRequirements { None = 0 , InternalFrameNumber = 1 << 0 , NetworkTickOffset = 1 << 1 , All = InternalFrameNumber | NetworkTickOffset }
 
enum class  EChaosVDSolverFrameAttributes : uint16 { None = 0 , HasGTDataToReRoute = 1 << 0 }
 
enum class  EChaosVDRecordingAttributes : uint8 { None = 0 , Live = 1 << 0 , Merged = 1 << 1 }
 

Functions

 DECLARE_MULTICAST_DELEGATE_TwoParams (FChaosVDGeometryDataLoaded, const Chaos::FConstImplicitObjectPtr &, const uint32 GeometryID) struct FChaosVDCustomUserDataHandle
 

Macro Definition Documentation

◆ UE_API

#define UE_API   CHAOSVDDATA_API

Typedef Documentation

◆ FChaosVDFrameStagesContainer

◆ FChaosVDStepData

◆ FChaosVDStepsContainer

Enumeration Type Documentation

◆ EChaosVDNetworkSyncDataRequirements

Enumerator
None 
InternalFrameNumber 
NetworkTickOffset 
All 

◆ EChaosVDRecordingAttributes

Enumerator
None 
Live 

Set if this recording is being populated from a live session

Merged 

Set if this recording contains data from multiple recordings

◆ EChaosVDSolverFrameAttributes

Enumerator
None 
HasGTDataToReRoute 

◆ EChaosVDSolverStageFlags

Set of flags used to define characteristics of a loaded solver stage

Enumerator
None 
Open 

Set if the solver stage is open and can take new data

ExplicitStage 

Set if the solver stage was explicitly recorded - If not set, this stage was created on the fly during load

Function Documentation

◆ DECLARE_MULTICAST_DELEGATE_TwoParams()

DECLARE_MULTICAST_DELEGATE_TwoParams ( FChaosVDGeometryDataLoaded  ,
const Chaos::FConstImplicitObjectPtr ,
const uint32  GeometryID 
)

Handle to user-defined data types in a CVD recorded frame. These handles share ownership of the data

Creates a handle for the provided data instance. This handle will hold a reference to the data

Parameters
DataPtrShared ref pointer to the data we want to rpovide access to

Returns the FName of the UStruct type that this handle represents

Returns a raw ptr to the data this handle provides access to.

Returns a shared ptr to the data this handle provides access to

Checks if this handle is of another type, using the UStruct data we parsed on creation