FNiagaraSimCacheCaptureParameters Struct Reference

Public Member Functions
Functions
void	SetbCaptureFixedNumberOfFrames (bool Value)
	When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.
bool	GetbAppendToSimCache () const
	When enabled we will append to the existing simulation cache rather than destroying the existing contents.
void	SetbAppendToSimCache (bool Value)
	When enabled we will append to the existing simulation cache rather than destroying the existing contents.
bool	GetbCaptureFixedNumberOfFrames () const
	When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.
FNiagaraSimCacheCaptureParameters &	opAssign (FNiagaraSimCacheCaptureParameters Other)
bool	GetbUseTimeout () const
	When enabled the capture will time out if we reach the defined number of frames without anything new to capture.
void	SetbUseTimeout (bool Value)
	When enabled the capture will time out if we reach the defined number of frames without anything new to capture.
bool	GetbCaptureAllFramesImmediatly () const
	When enabled we will capture all the requested frames immediatly. This will capture the simulation outside of the main work tick, i.e. if you request a 10 frame capture we will loop capturing 10 frames on the capture call rather than over 10 world ticks.
void	SetbCaptureAllFramesImmediatly (bool Value)
	When enabled we will capture all the requested frames immediatly. This will capture the simulation outside of the main work tick, i.e. if you request a 10 frame capture we will loop capturing 10 frames on the capture call rather than over 10 world ticks.

Public Attributes
SimCache
int	CaptureRate
	Allows for reducing the frequency of captured frames in relation to the simulation's frames. The ratio is 1 / CaptureRate, so a CaptureRate of 2 would captures frames 0, 2, 4, etc.
int	TimeoutFrameCount
	When we fail to capture a new frame after this many frames the capture will complete automatically.
float32	ImmediateCaptureDeltaTime
	The delta time in seconds to use when manually advancing the simulation.Defaults to 1 / 60th of a second(0.01666).
int	NumFrames
	The max number of frames to capture. The capture will stop when the simulation completes or we have rendered this many frames, whichever happens first. Set to 0 to capture until simulation completes.
Variables
bool	bCaptureFixedNumberOfFrames
bool	bUseTimeout
bool	bCaptureAllFramesImmediatly
bool	bAppendToSimCache

Member Function Documentation

GetbAppendToSimCache()

bool GetbAppendToSimCache

(

)

const

When enabled we will append to the existing simulation cache rather than destroying the existing contents.

GetbCaptureAllFramesImmediatly()

bool GetbCaptureAllFramesImmediatly

(

)

const

When enabled we will capture all the requested frames immediatly. This will capture the simulation outside of the main work tick, i.e. if you request a 10 frame capture we will loop capturing 10 frames on the capture call rather than over 10 world ticks.

GetbCaptureFixedNumberOfFrames()

bool GetbCaptureFixedNumberOfFrames

(

)

const

When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.

GetbUseTimeout()

bool GetbUseTimeout

(

)

const

When enabled the capture will time out if we reach the defined number of frames without anything new to capture.

opAssign()

FNiagaraSimCacheCaptureParameters & opAssign

(

FNiagaraSimCacheCaptureParameters

Other

)

SetbAppendToSimCache()

void SetbAppendToSimCache

(

bool

Value

)

When enabled we will append to the existing simulation cache rather than destroying the existing contents.

SetbCaptureAllFramesImmediatly()

void SetbCaptureAllFramesImmediatly

(

bool

Value

)

When enabled we will capture all the requested frames immediatly. This will capture the simulation outside of the main work tick, i.e. if you request a 10 frame capture we will loop capturing 10 frames on the capture call rather than over 10 world ticks.

SetbCaptureFixedNumberOfFrames()

void SetbCaptureFixedNumberOfFrames

(

bool

Value

)

When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete.

SetbUseTimeout()

void SetbUseTimeout

(

bool

Value

)

When enabled the capture will time out if we reach the defined number of frames without anything new to capture.

Member Data Documentation

bAppendToSimCache

bool bAppendToSimCache

bCaptureAllFramesImmediatly

bool bCaptureAllFramesImmediatly

bCaptureFixedNumberOfFrames

bool bCaptureFixedNumberOfFrames

bUseTimeout

bool bUseTimeout

CaptureRate

int CaptureRate

Allows for reducing the frequency of captured frames in relation to the simulation's frames. The ratio is 1 / CaptureRate, so a CaptureRate of 2 would captures frames 0, 2, 4, etc.

ImmediateCaptureDeltaTime

float32 ImmediateCaptureDeltaTime

The delta time in seconds to use when manually advancing the simulation.Defaults to 1 / 60th of a second(0.01666).

NumFrames

int NumFrames

The max number of frames to capture. The capture will stop when the simulation completes or we have rendered this many frames, whichever happens first. Set to 0 to capture until simulation completes.

TimeoutFrameCount

int TimeoutFrameCount

When we fail to capture a new frame after this many frames the capture will complete automatically.