Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

IImageWriteQueue::Enqueue

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

Windows

MacOS

Linux

References

Module	ImageWriteQueue
Header	/Engine/Source/Runtime/ImageWriteQueue/Public/ImageWriteQueue.h
Include	#include "ImageWriteQueue.h"

Syntax

TFuture< bool > Enqueue
(
TUniquePtr< IImageWriteTaskBase > && InTask,
bool bInBlockIfAtCapacity
)

Remarks

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

Returns

A future to the completion state of the task (success or failure), or an invalid future in the case where the task could not be dispatched

Parameters

Parameter	Description
InTask	A unique pointer to a task to perform on a thread when available. Pass with MoveTemp().
bInBlockIfAtCapacity	Wait until the number of pending tasks does not exceed the queue capacity. If false and the number of pending tasks does exceed, the function will return and will not enqueue the task.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss