1. Epic GamesDeveloper
  3. UMoviePipelineQueueEngineSubsystem

UMoviePipelineQueueEngineSubsystem

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

This subsystem is intended for use when rendering in a shipping game (but can also be used in PIE during development/testing). See UMoviePipelineQueueSubsystem for the Editor-only queue which is bound to the Movie Render Queue UI. To do simple renders at runtime, call AllocateJob(...) with the Level Sequence you want to render, then call FindOrAddSettingByClass on the job to add the settings (such as render pass, output type, and output directory) that you want for the job. Finally, call RenderJob with the job you just configured. Register a delegate to OnRenderFinished to be notified when the render finished. You can optionally call SetConfiguration(...) before RenderJob to configure some advanced options.

   
Name UMoviePipelineQueueEngineSubsystem
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueueEngineSubsystem.h
Include Path #include "MoviePipelineQueueEngineSubsystem.h"

Syntax

UCLASS (BlueprintType, Meta=(DisplayName="MoviePipeline Runtime Subsystem"))  
class UMoviePipelineQueueEngineSubsystem : public UEngineSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMoviePipelineQueueEngineSubsystem()

   MoviePipelineQueueEngineSubsystem.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnRenderFinished FMoviePipelineWorkFinished Assign a function to this delegate to get notified when each individual job is finished. MoviePipelineQueueEngineSubsystem.h
  • BlueprintAssignable

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveExecutor TObjectPtr< UMoviePipelineExecutorBase >   MoviePipelineQueueEngineSubsystem.h
  • Transient
bCachedRenderPlayerViewport bool   MoviePipelineQueueEngineSubsystem.h  
CachedProgressWidgetClass TSubclassOf< UMovieRenderDebugWidget >   MoviePipelineQueueEngineSubsystem.h  
CachedRenderJobResults TOptional< FMoviePipelineOutputData >   MoviePipelineQueueEngineSubsystem.h  
CurrentQueue TObjectPtr< UMoviePipelineQueue >   MoviePipelineQueueEngineSubsystem.h
  • Transient
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers
Convenience function for creating a UMoviePipelineExecutorJob out of the given Level Sequence asset. MoviePipelineQueueEngineSubsystem.h
  • BlueprintCallable
  • Category="Movie Render Pipeline|Rendering"
Returns the active executor (if there is one). MoviePipelineQueueEngineSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

UMoviePipelineQueue * GetQueue()

 Returns the queue of Movie Pipelines that need to be rendered. MoviePipelineQueueEngineSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

bool IsRendering ()

 Returns true if there is an active executor working on producing a movie. MoviePipelineQueueEngineSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline|Rendering"
Convenience function for rendering the specified job. MoviePipelineQueueEngineSubsystem.h
  • BlueprintCallable
  • Category="Movie Render Pipeline|Rendering"
Starts processing the current queue with the supplied executor class. MoviePipelineQueueEngineSubsystem.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="InExecutorType")
  • Category="Movie Render Pipeline|Rendering"
Starts processing the current queue with the supplied executor. MoviePipelineQueueEngineSubsystem.h
  • BlueprintCallable
  • Category="Movie Render Pipeline|Rendering"

void SetConfiguration ( TSubclassOf< UMovieRenderDebugWidget > InProgressWidgetClass,
const bool bRenderPlayerViewport
)

 Sets some advanced configuration options that are used only occasionally to have better control over integrating it into your game/application. MoviePipelineQueueEngineSubsystem.h
  • BlueprintCallable
  • Category="Movie Render Pipeline|Rendering"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page