Navigation
API > API/Plugins > API/Plugins/Niagara
References
| Module | Niagara |
| Header | /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraSimCacheCapture.h |
| Include | #include "NiagaraSimCacheCapture.h" |
Syntax
USTRUCT&40;BlueprintType&41;
struct FNiagaraSimCacheCaptureParameters
Variables
| Type | Name | Description | |
|---|---|---|---|
| uint32: 1 | bAppendToSimCache | When enabled we will append to the existing simulation cache rather than destroying the existing contents. | |
| uint32: 1 | bCaptureAllFramesImmediatly | When enabled we will capture all the requested frames immediatly. | |
| uint32: 1 | bCaptureFixedNumberOfFrames | When enabled we capture NumFrames number of frames, otherwise the capture will continue until cancelled or the simulation is complete. | |
| uint32: 1 | bUseTimeout | When enabled the capture will time out if we reach the defined number of frames without anything new to capture. | |
| int32 | CaptureRate | Allows for reducing the frequency of captured frames in relation to the simulation's frames. | |
| float | ImmediateCaptureDeltaTime | The delta time in seconds to use when manually advancing the simulation.Defaults to 1 / 60th of a second(0.01666). | |
| int32 | NumFrames | The max number of frames to capture. | |
| int32 | TimeoutFrameCount | When we fail to capture a new frame after this many frames the capture will complete automatically. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Sanitize () |