Navigation
| Name | ImageWriteQueue |
| Type | Runtime |
| Location | /Engine/Source/Runtime/ImageWriteQueue/ |
| Module Build Rules | ImageWriteQueue.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FImageWriteTask | |
| FOnImageWriteComplete | |
| UImageWriteBlueprintLibrary | Function library containing utility methods for writing images on a global async queue |
Structs
| Name | Remarks |
|---|---|
| FImagePixelData | |
| FImagePixelPipe | A pipe that receives image data and forwards it onto 0 or more end points, copying the buffer as few times as possible |
| FImageStreamEndpoint | Stream end-point that receives a copy of image data from a thread |
| FImageWriteOptions | Options specific to writing image files to disk |
| IImagePixelDataPayload | |
| TAsyncAlphaInvert | A pixel preprocessor for use with FImageWriteTask::PixelPreProcessor that inverts the alpha channel as part of the threaded work |
| TAsyncAlphaWrite | A pixel preprocessor for use with FImageWriteTask::PixelPreProcessor that overwrites the alpha channel with a fixed value as part of the threaded work |
| TImageDataTraits | |
| TImagePixelData | Templated pixel data - currently supports FColor, FFloat16Color and FLinearColor |
| TImagePixelDataTraits |
Interfaces
| Name | Remarks |
|---|---|
| IImageWriteQueue | Public interface for an asynchronous queue of work dedicated to writing images to disk |
| IImageWriteQueueModule | Module implementation that returns a write queue. |
| IImageWriteTaskBase | Interface that is implemented in order to be able to asynchronously write images to disk |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FImagePixelPayloadPtr | TSharedPtr< IImagePixelDataPayload, ESPMode::ThreadSafe > | ImagePixelData.h | |
| FOnPixelsReady | TFunction< void(TUniquePtr< FImagePixelData > &&)> | ImageWriteBlueprintLibrary.h | |
| FPixelPreProcessor | TUniqueFunction< void(FImagePixelData *)> | ImageWriteTask.h |
Enums
Public
| Name | Remarks |
|---|---|
| EDesiredImageFormat | |
| EImagePixelType | Todo : use ImageCore ERawImageFormat instead |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EImageFormat ImageFormatFromDesired
(
EDesiredImageFormat In |
ImageWriteTypes.h |