UMoviePipelineBlueprintLibrary::GetEstimatedTimeRemaining

Get the estimated amount of time remaining for the current pipeline.

Windows
MacOS
Linux

References

Module

MovieRenderPipelineCore

Header

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

Include

#include "MoviePipelineBlueprintLibrary.h"

Source

/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Private/MoviePipelineBlueprintLibrary.cpp

Syntax

[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Movie Render Pipeline")
static bool GetEstimatedTimeRemaining
(
    const UMoviePipeline * InPipeline,
    FTimespan & OutEstimate
)

Remarks

Get the estimated amount of time remaining for the current pipeline. Based on looking at the total amount of samples to render vs. how many have been completed so far. Inaccurate when Time Dilation is used, and gets more accurate over the course of the render.

Returns

True if a valid estimate can be calculated, or false if it is not ready yet (ie: not enough samples rendered)

Parameters

Parameter

Description

InPipeline

The pipeline to get the time estimate from.

OutEstimate

The resulting estimate, or FTimespan() if estimate is not valid.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss