Navigation
API > API/Runtime > API/Runtime/ImageWriteQueue
A pipe that receives image data and forwards it onto 0 or more end points, copying the buffer as few times as possible
| Name | FImagePixelPipe |
| Type | struct |
| Header File | /Engine/Source/Runtime/ImageWriteQueue/Public/ImageWriteStream.h |
| Include Path | #include "ImageWriteStream.h" |
Syntax
struct FImagePixelPipe
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor (an empty pipe) | ImageWriteStream.h | ||
FImagePixelPipe
(
const TFunction< void(TUniquePtr< FImagePixelData >&&)>& InEndpoint |
Define a new pipe with a single initial endpoint | ImageWriteStream.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsExpecting32BitPixelData | std::atomic_bool | Boolean flag used to request 32-bit image pixel data, false by default. | ImageWriteStream.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| EndPointLock | FCriticalSection | A lock to protect the end points array | ImageWriteStream.h | |
| EndPoints | TArray< TUniquePtr< FImageStreamEndpoint > > | Array of endpoints to be called in order | ImageWriteStream.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddEndpoint
(
TUniquePtr< FImageStreamEndpoint >&& InEndpoint |
Add a new end point handler to this pipe. | ImageWriteStream.h | |
void AddEndpoint
(
const TFunction< void(TUniquePtr< FImagePixelData >&&)>& InHandler |
Add a new end point handler to this pipe as a functor. | ImageWriteStream.h | |
TArrayView< const TUniquePtr< FImageStreamEndpoint > > GetEndPoints () |
Access this pipe's current set of end points. | ImageWriteStream.h | |
void Push
(
TUniquePtr< FImagePixelData >&& InImagePixelData |
Push the specified pixel data onto this pipe | ImageWriteStream.h |