UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FWorldAsyncTraceState Struct Reference

#include <World.h>

Public Member Functions

UE_API FWorldAsyncTraceState ()
 
AsyncTraceDataGetBufferForFrame (int32 Frame)
 
AsyncTraceDataGetBufferForCurrentFrame ()
 
AsyncTraceDataGetBufferForPreviousFrame ()
 

Public Attributes

AsyncTraceData DataBuffer [2]
 
int32 CurrentFrame
 

Detailed Description

This encapsulate World's async trace functionality. This contains two buffers of trace data buffer and alternates it for each tick.

You can use async trace using following APIs : AsyncLineTrace, AsyncSweep, AsyncOverlap When you use those APIs, it will be saved to AsyncTraceData FWorldAsyncTraceState contains two buffers to rotate each frame as you might need the result in the next frame However, if you do not get the result by next frame, the result will be discarded. Use Delegate if you would like to get the result right away when available.

Constructor & Destructor Documentation

◆ FWorldAsyncTraceState()

FWorldAsyncTraceState::FWorldAsyncTraceState ( )

Member Function Documentation

◆ GetBufferForCurrentFrame()

AsyncTraceData & FWorldAsyncTraceState::GetBufferForCurrentFrame ( )
inline

Get the Buffer for Current Frame

◆ GetBufferForFrame()

AsyncTraceData & FWorldAsyncTraceState::GetBufferForFrame ( int32  Frame)
inline

Get the Buffer for input Frame

◆ GetBufferForPreviousFrame()

AsyncTraceData & FWorldAsyncTraceState::GetBufferForPreviousFrame ( )
inline

Get the Buffer for Previous Frame

Member Data Documentation

◆ CurrentFrame

int32 FWorldAsyncTraceState::CurrentFrame

Used as counter for Buffer swap for DataBuffer. Right now it's only 2, but it can change.

◆ DataBuffer

AsyncTraceData FWorldAsyncTraceState::DataBuffer[2]

Async Trace Data Buffer Array. For now we only saves 2 frames.


The documentation for this struct was generated from the following files: