Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
| Name | UMoviePipelineBase |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineBase.h |
| Include Path | #include "MoviePipelineBase.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Abstract)
class UMoviePipelineBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineBase
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnMoviePipelineShotWorkFinishedDelegate | FMoviePipelineWorkFinished | This callback will not be called by default due to performance reasons. | MoviePipelineBase.h |
|
| OnMoviePipelineWorkFinishedDelegate | FMoviePipelineWorkFinished | Called when we have completely finished this pipeline. | MoviePipelineBase.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EMovieRenderPipelineState GetPipelineState() |
MoviePipelineBase.h |
|
|
bool IsShutdownRequested() |
Has RequestShutdown() been called? | MoviePipelineBase.h |
|
FMoviePipelineWorkFinishedNative & OnMoviePipelineShotWorkFinished () |
Only called if `IsFlushDiskWritesPerShot()_ is set! Called after each shot is finished and files have been flushed to disk. | MoviePipelineBase.h | |
FMoviePipelineWorkFinishedNative & OnMoviePipelineWorkFinished () |
Called when we have completely finished this pipeline. | MoviePipelineBase.h | |
void RequestShutdown
(
bool bIsError |
Request the movie pipeline to shut down at the next available time. | MoviePipelineBase.h |
|
void Shutdown
(
bool bIsError |
Abandons any future work on this Movie Pipeline and runs through the shutdown flow to ensure already completed work is written to disk. | MoviePipelineBase.h |
|
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMovieRenderPipelineState GetPipelineStateImpl() |
MoviePipelineBase.h | ||
virtual bool IsPostShotCallbackNeeded() |
MoviePipelineBase.h | ||
virtual bool IsShutdownRequestedImpl() |
MoviePipelineBase.h | ||
virtual FMoviePipelineWorkFinishedNative & OnMoviePipelineShotWorkFinishedImpl() |
MoviePipelineBase.h | ||
virtual FMoviePipelineWorkFinishedNative & OnMoviePipelineWorkFinishedImpl() |
MoviePipelineBase.h | ||
virtual void RequestShutdownImpl
(
bool bIsError |
MoviePipelineBase.h | ||
virtual void ShutdownImpl
(
bool bIsError |
MoviePipelineBase.h |