Navigation
API > API/Runtime > API/Runtime/ImageWriteQueue
Public interface for an asynchronous queue of work dedicated to writing images to disk
Concurrency metrics are controllable by ImageWriteQueue.MaxConcurrency and ImageWriteQueue.MaxQueueSize Dispatched tasks can contain callbacks that are called on the main thread when completed. It is possible to wait on completion of the current queue state by creating a 'fence' that can be waited upon
| Name | IImageWriteQueue |
| Type | class |
| Header File | /Engine/Source/Runtime/ImageWriteQueue/Public/ImageWriteQueue.h |
| Include Path | #include "ImageWriteQueue.h" |
Syntax
class IImageWriteQueue
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IImageWriteQueue() |
ImageWriteQueue.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TFuture< void > CreateFence
(
const TFunction< void()>& InOnFenceReached |
(thread-safe) Create a fence at the current position in the queue. | ImageWriteQueue.h | |
TFuture< bool > Enqueue
(
TUniquePtr< IImageWriteTaskBase >&& InTask, |
(thread-safe) Enqueue a new asynchronous image write task. | ImageWriteQueue.h | |
int32 GetNumPendingTasks() |
(thread-safe) Query the number of tasks currently pending or in progress | ImageWriteQueue.h |