FImagePixelPipe Struct Reference

#include <ImageWriteStream.h>

Public Member Functions
	FImagePixelPipe ()
	FImagePixelPipe (const TFunction< void(TUniquePtr< FImagePixelData > &&)> &InEndpoint)
IMAGEWRITEQUEUE_API void	Push (TUniquePtr< FImagePixelData > &&InImagePixelData)
IMAGEWRITEQUEUE_API void	AddEndpoint (TUniquePtr< FImageStreamEndpoint > &&InEndpoint)
IMAGEWRITEQUEUE_API void	AddEndpoint (const TFunction< void(TUniquePtr< FImagePixelData > &&)> &InHandler)
TArrayView< const TUniquePtr< FImageStreamEndpoint > >	GetEndPoints () const

Public Attributes
std::atomic_bool	bIsExpecting32BitPixelData = false

Detailed Description

A pipe that receives image data and forwards it onto 0 or more end points, copying the buffer as few times as possible

Constructor & Destructor Documentation

FImagePixelPipe() [1/2]

FImagePixelPipe::FImagePixelPipe ( )

inline

Default constructor (an empty pipe)

FImagePixelPipe() [2/2]

FImagePixelPipe::FImagePixelPipe ( const TFunction< void(TUniquePtr< FImagePixelData > &&)> &  InEndpoint )

inline

Define a new pipe with a single initial endpoint

Member Function Documentation

AddEndpoint() [1/2]

void FImagePixelPipe::AddEndpoint

(

const TFunction< void(TUniquePtr< FImagePixelData > &&)> &

InHandler

)

Add a new end point handler to this pipe as a functor.

Parameters

InHandler

A handler function implemented as an anonymous functor. Potentially called on any thread.

AddEndpoint() [2/2]

void FImagePixelPipe::AddEndpoint

(

TUniquePtr< FImageStreamEndpoint > &&

InEndpoint

)

Add a new end point handler to this pipe.

Parameters

InEndpoint

The new endpoint to add. Potentially used on any thread.

GetEndPoints()

TArrayView< const TUniquePtr< FImageStreamEndpoint > > FImagePixelPipe::GetEndPoints ( ) const

inline

Access this pipe's current set of end points. Warning: Not thread-safe - should only be called where no other modification to the end points can be happening.

Push()

void FImagePixelPipe::Push

(

TUniquePtr< FImagePixelData > &&

InImagePixelData

)

Push the specified pixel data onto this pipe

Parameters

InImagePixelData

The data to push through this pipe

Member Data Documentation

bIsExpecting32BitPixelData

std::atomic_bool FImagePixelPipe::bIsExpecting32BitPixelData = false

Boolean flag used to request 32-bit image pixel data, false by default.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/ImageWriteQueue/Public/ImageWriteStream.h
• Engine/Source/Runtime/ImageWriteQueue/Private/ImageWriteStream.cpp