Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
A queue is a list of jobs that have been executed, are executing and are waiting to be executed. These can be saved to specific assets to allow
| Name | UMoviePipelineQueue |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueue.h |
| Include Path | #include "MoviePipelineQueue.h" |
Syntax
UCLASS (BlueprintType)
class UMoviePipelineQueue : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineQueue
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelineQueue() |
MoviePipelineQueue.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsDirty | bool | Dirty state is tracked explicitly so transient queues, which are based on a transient package, know when modifications have been made. | MoviePipelineQueue.h | |
| Jobs | TArray< TObjectPtr< UMoviePipelineExecutorJob > > | MoviePipelineQueue.h |
|
|
| QueueOrigin | TSoftObjectPtr< UMoviePipelineQueue > | The queue that this queue originated from. | MoviePipelineQueue.h | |
| QueueSerialNumber | int32 | MoviePipelineQueue.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelineExecutorJob * AllocateNewJob
(
TSubclassOf< UMoviePipelineExecutorJob > InJobType |
Allocates a new Job in this Queue. | MoviePipelineQueue.h |
|
UMoviePipelineQueue * CopyFrom
(
UMoviePipelineQueue* InQueue |
Replace the contents of this queue with a copy of the contents from another queue. | MoviePipelineQueue.h |
|
void DeleteAllJobs() |
Delete all jobs from the Queue. | MoviePipelineQueue.h |
|
void DeleteJob
(
UMoviePipelineExecutorJob* InJob |
Deletes the specified job from the Queue. | MoviePipelineQueue.h |
|
UMoviePipelineExecutorJob * DuplicateJob
(
UMoviePipelineExecutorJob* InJob |
Duplicate the specific job and return the duplicate. Configurations are duplicated and not shared. | MoviePipelineQueue.h |
|
TArray< UMoviePipelineExecutorJob * > GetJobs() |
Get all of the Jobs contained in this Queue. | MoviePipelineQueue.h |
|
| Gets the queue that this queue was originally based on (if any). | MoviePipelineQueue.h |
|
|
uint32 GetQueueSerialNumber () |
Retrieve the serial number that is incremented when a job is added or removed from this list. | MoviePipelineQueue.h | |
void InvalidateSerialNumber() |
MoviePipelineQueue.h | ||
bool IsDirty () |
Gets the dirty state of this queue. | MoviePipelineQueue.h |
|
void SetIsDirty
(
const bool bNewDirtyState |
Sets the dirty state of this queue. | MoviePipelineQueue.h |
|
void SetJobIndex
(
UMoviePipelineExecutorJob* InJob, |
Set the index of the given job | MoviePipelineQueue.h |
|
void SetQueueOrigin
(
UMoviePipelineQueue* InConfig |
Sets the queue that this queue originated from (if any). | MoviePipelineQueue.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PreSave
(
FObjectPreSaveContext ObjectSaveContext |
MoviePipelineQueue.h |