UMoviePipelineOutputBase

A base class for different output containers for the data generated by the Movie Pipeline, i.e: image sequences, video containers, etc.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MovieRenderPipelineCore

Header

/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineOutputBase.h

Include

#include "MoviePipelineOutputBase.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Blueprintable, Abstract)
class UMoviePipelineOutputBase : public UMoviePipelineSetting

Remarks

A base class for different output containers for the data generated by the Movie Pipeline, i.e: image sequences, video containers, etc.

Functions

Name Description

Public function

void

 

BeginFinalize()

Called once when all frames have been produced for the pipeline.

Protected function Virtual

void

 

BeginFinalizeImpl()

Public function

void

 

Finalize()

Called after all output containers have reported that they are done processing.

Protected function Virtual

void

 

FinalizeImpl()

Public function

bool

 

HasFinishedProcessing()

Called each frame to check to see if this output container has finished processing.

Protected function Virtual

bool

 

HasFinishedProcessingImpl()

Public function

void

 

OnPipelineFinished()

This is called during the Shutdown process of the Pipeline. This is after finalization.

Protected function Virtual

void

 

OnPipelineFinishedImpl()

Public function

void

 

OnPostTick()

Called at the end of the frame, before rendering has happened for that frame.

Protected function Virtual

void

 

OnPostTickImpl()

Public function

void

 

OnReceiveImageData

Called when a frame is ready for output.

Protected function Virtual

void

 

OnReceiveImageDataImpl

Public function

void

 

OnShotFinished

(
    const UMoviePipelineExecutorShot&#...,
    const bool bFlushToDisk
)

This is called when a shot ends, right after the last frame is rendered.

Protected function Virtual

void

 

OnShotFinishedImpl

(
    const UMoviePipelineExecutorShot&#...,
    const bool bFlushToDisk
)

Overridden from UMoviePipelineSetting

Name Description

Protected function Virtual Const

FText

 

GetCategoryText()

Warning: This gets called on the CDO of the object

Protected function Virtual Const

bool

 

IsValidOnMaster()

Can this configuration setting be added to the master configuration? If not, it will throw an error when trying to add it to the master configuration.

Protected function Virtual Const

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss