IImageWriteQueue

Public interface for an asynchronous queue of work dedicated to writing images to disk

Windows
MacOS
Linux

References

Module

ImageWriteQueue

Header

/Engine/Source/Runtime/ImageWriteQueue/Public/ImageWriteQueue.h

Include

#include "ImageWriteQueue.h"

Syntax

class IImageWriteQueue

Remarks

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

Destructors

Name Description

Public function Virtual

~IImageWriteQueue()

Functions

Name Description

Public function

TFuture< voi...

 

CreateFence

(
    const TFunction< void()>& InOnFenc...
)

(thread-safe) Create a fence at the current position in the queue.

Public function

TFuture< boo...

 

Enqueue

(
    TUniquePtr< IImageWriteTaskBase >&...,
    bool bInBlockIfAtCapacity
)

(thread-safe) Enqueue a new asynchronous image write task.

Public function Const

int32

 

GetNumPendingTasks()

(thread-safe) Query the number of tasks currently pending or in progress

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback