Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
A base class for different output containers for the data generated by the Movie Pipeline, i.e: image sequences, video containers, etc.
| Name | UMoviePipelineOutputBase |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineOutputBase.h |
| Include Path | #include "MoviePipelineOutputBase.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, Abstract)
class UMoviePipelineOutputBase : public UMoviePipelineSetting
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineSetting → UMoviePipelineOutputBase
Derived Classes
UMoviePipelineOutputBase derived class hierarchy
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginFinalize () |
Called once when all frames have been produced for the pipeline. | MoviePipelineOutputBase.h | |
void Finalize() |
Called after all output containers have reported that they are done processing. | MoviePipelineOutputBase.h | |
bool HasFinishedProcessing () |
Called each frame to check to see if this output container has finished processing. | MoviePipelineOutputBase.h | |
void OnPipelineFinished() |
This is called during the Shutdown process of the Pipeline. This is after finalization. | MoviePipelineOutputBase.h | |
void OnPostTick() |
Called at the end of the frame, before rendering has happened for that frame. | MoviePipelineOutputBase.h | |
void OnReceiveImageData
(
FMoviePipelineMergerOutputFrame* InMergedOutputFrame |
Called when a frame is ready for output. | MoviePipelineOutputBase.h | |
void OnShotFinished
(
const UMoviePipelineExecutorShot* InShot, |
This is called when a shot ends, right after the last frame is rendered. | MoviePipelineOutputBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginFinalizeImpl() |
MoviePipelineOutputBase.h | ||
virtual void FinalizeImpl() |
MoviePipelineOutputBase.h | ||
virtual bool HasFinishedProcessingImpl() |
MoviePipelineOutputBase.h | ||
virtual void OnPipelineFinishedImpl() |
MoviePipelineOutputBase.h | ||
virtual void OnPostTickImpl() |
MoviePipelineOutputBase.h | ||
virtual void OnReceiveImageDataImpl
(
FMoviePipelineMergerOutputFrame* InMergedOutputFrame |
MoviePipelineOutputBase.h | ||
virtual void OnShotFinishedImpl
(
const UMoviePipelineExecutorShot* InShot, |
MoviePipelineOutputBase.h | ||
virtual bool ShouldCropOverscanImpl() |
Returns whether any overscan should be automatically cropped from the image before compositing and output | MoviePipelineOutputBase.h |
Overridden from UMoviePipelineSetting
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FText GetCategoryText() |
Warning: This gets called on the CDO of the object | MoviePipelineOutputBase.h | |
virtual bool IsValidOnPrimary() |
Can this configuration setting be added to the primary configuration? If not, it will throw an error when trying to add it to the primary configuration. | MoviePipelineOutputBase.h | |
virtual bool IsValidOnShots() |
Can this configuration setting be added to shots? If not, it will throw an error when trying to add it to a shot config. | MoviePipelineOutputBase.h |