1. Epic GamesDeveloper
  3. UMoviePipelineQueueSubsystem

UMoviePipelineQueueSubsystem

API > API/Plugins > API/Plugins/MovieRenderPipelineEditor

   
Name UMoviePipelineQueueSubsystem
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineEditor/Public/MoviePipelineQueueSubsystem.h
Include Path #include "MoviePipelineQueueSubsystem.h"

Syntax

UCLASS (BlueprintType)  
class UMoviePipelineQueueSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMoviePipelineQueueSubsystem()

   MoviePipelineQueueSubsystem.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnQueueLoaded FOnMoviePipelineQueueLoaded Called when a queue is loaded into the system. MoviePipelineQueueSubsystem.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveExecutor TObjectPtr< UMoviePipelineExecutorBase >   MoviePipelineQueueSubsystem.h
  • Transient
CurrentQueue TObjectPtr< UMoviePipelineQueue >   MoviePipelineQueueSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Returns the active executor (if there is one). MoviePipelineQueueSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

UMoviePipelineQueue * GetQueue()

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

bool IsQueueDirty ()

 Returns true if the current queue has been modified since it was loaded, else returns false. MoviePipelineQueueSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

bool IsRendering ()

 Returns true if there is an active executor working on producing a movie. MoviePipelineQueueSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline|Rendering"

bool LoadQueue ( UMoviePipelineQueue* QueueToLoad,
const bool bPromptOnReplacingDirtyQueue
)

 Loads a new queue by copying it into the queue subsystem's current transient queue (the one returned by GetQueue()). MoviePipelineQueueSubsystem.h
  • BlueprintPure
  • Category="Movie Render Pipeline"

UMoviePipelineExecutorBase * RenderQueueInstanceWithExecutor ( UMoviePipelineQueue* InQueue,
TSubclassOf< UMoviePipelineExecutorBase > InExecutorType
)

 Like RenderQueueWithExecutor(), but a specific queue instance is used rather than the current queue. MoviePipelineQueueSubsystem.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="InExecutorType")
  • Category="Movie Render Pipeline|Rendering"

void RenderQueueInstanceWithExecutorInstance ( UMoviePipelineQueue* InQueue,
UMoviePipelineExecutorBase* InExecutor
)

 Like RenderQueueWithExecutorInstance(), but a specific queue instance is used rather than the current queue. MoviePipelineQueueSubsystem.h
  • BlueprintCallable
  • Category="Movie Render Pipeline|Rendering"
Starts processing the current queue with the supplied executor class. MoviePipelineQueueSubsystem.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="InExecutorType")
  • Category="Movie Render Pipeline|Rendering"
Starts processing the current queue with the supplied executor. MoviePipelineQueueSubsystem.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