Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
The Tick/Render loops are decoupled from the actual desired output. In some cases we may render but not desire an output (such as filling temporal histories) or we may be accumulating the results into a target which does not produce an output. Finally, we may be running the Tick/Render loop but not wanting to do anything!
| Name | FMoviePipelineFrameOutputState |
| Type | struct |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MovieRenderPipelineDataTypes.h |
| Include Path | #include "MovieRenderPipelineDataTypes.h" |
Syntax
struct FMoviePipelineFrameOutputState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FMoviePipelineFrameOutputState() |
MovieRenderPipelineDataTypes.h |
Structs
| Name | Remarks |
|---|---|
| FTimeData |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCaptureRendering | bool | If true, and a IRenderCaptureProvider is available, trigger a capture of the rendering process of this frame. | MovieRenderPipelineDataTypes.h | |
| bDiscardRenderResult | bool | If this is true, then the frame will be rendered but the results discarded and not sent to the accumulator. | MovieRenderPipelineDataTypes.h | |
| bSkipRendering | bool | If true, then the rendering for this frame should be skipped (ie: nothing submitted to the gpu, and the output merger not told to expect this frame). | MovieRenderPipelineDataTypes.h | |
| CameraIndex | int32 | MovieRenderPipelineDataTypes.h | ||
| CameraName | FString | The name of the currently active camera being rendered. May be empty. | MovieRenderPipelineDataTypes.h | |
| CameraNameOverride | FString | Name used by the {camera_name} format tag. May be empty | MovieRenderPipelineDataTypes.h | |
| CurrentShotSourceFrameNumber | int32 | MovieRenderPipelineDataTypes.h | ||
| CurrentShotSourceTimeCode | FTimecode | MovieRenderPipelineDataTypes.h | ||
| EffectiveFrameNumber | int32 | The closest frame number (in Display Rate) on the Sequence adjusted for the effective output rate. | MovieRenderPipelineDataTypes.h | |
| EffectiveTimeCode | FTimecode | The closest time code version of the EffectiveFrameNumber. | MovieRenderPipelineDataTypes.h | |
| FileMetadata | TMap< FString, FString > | Metadata to attach to the output file (if supported by the output container) | MovieRenderPipelineDataTypes.h | |
| OutputFrameNumber | int32 | The expected output frame count that the render is working towards creating. | MovieRenderPipelineDataTypes.h | |
| ShotCount | int32 | How many shots total will we be outputting? | MovieRenderPipelineDataTypes.h | |
| ShotIndex | int32 | Which shot is this output state for? | MovieRenderPipelineDataTypes.h | |
| ShotName | FString | THe name of the currently active shot. May be empty if there is no shot track. | MovieRenderPipelineDataTypes.h | |
| ShotOutputFrameNumber | int32 | The expected output frame count for this current shot that we're working towards creating. | MovieRenderPipelineDataTypes.h | |
| ShotSamplesRendered | int32 | The total number of samples (including warm ups) that have been sent to the GPU for this shot. | MovieRenderPipelineDataTypes.h | |
| SourceFrameNumber | int32 | The closest frame number (in Display Rate) on the Sequence. | MovieRenderPipelineDataTypes.h | |
| SourceTimeCode | FTimecode | The closest time code version of the SourceFrameNumber on the Sequence. | MovieRenderPipelineDataTypes.h | |
| TemporalSampleCount | int32 | How many temporal samples do we add together to produce one Output Frame? | MovieRenderPipelineDataTypes.h | |
| TemporalSampleIndex | int32 | Which sub-frame are we on when using Accumulation Frame rendering. | MovieRenderPipelineDataTypes.h | |
| TimeData | FTimeData | What time data should this frame use? Can vary between samples when TemporalSampleCount > 1. | MovieRenderPipelineDataTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsFirstTemporalSample() |
Is this the first temporal sample for the output frame? | MovieRenderPipelineDataTypes.h | |
bool IsLastTemporalSample() |
MovieRenderPipelineDataTypes.h | ||
void ResetPerFrameData() |
INFORMATION BELOW HERE SHOULD NOT GET PERSISTED BETWEEN FRAMES | MovieRenderPipelineDataTypes.h | |
void ResetPerShotData() |
MovieRenderPipelineDataTypes.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FMoviePipelineFrameOutputState& InRHS |
MovieRenderPipelineDataTypes.h | ||
bool operator==
(
const FMoviePipelineFrameOutputState& InRHS |
MovieRenderPipelineDataTypes.h |