UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDataflowImage Struct Reference

#include <DataflowImage.h>

Public Member Functions

DATAFLOWCORE_API int32 GetWidth () const
 
DATAFLOWCORE_API int32 GetHeight () const
 
DATAFLOWCORE_API const FImageGetImage () const
 
DATAFLOWCORE_API void CreateR32F (EDataflowImageResolution Resolution)
 
DATAFLOWCORE_API void CreateR32F (int32 Width, int32 Height)
 
DATAFLOWCORE_API void CreateRGBA32F (EDataflowImageResolution Resolution)
 
DATAFLOWCORE_API void CreateRGBA32F (int32 Width, int32 Height)
 
DATAFLOWCORE_API void CreateFromColor (EDataflowImageResolution Resolution, FLinearColor Color)
 
DATAFLOWCORE_API void CreateFromColor (int32 Width, int32 Height, FLinearColor Color)
 
DATAFLOWCORE_API bool CopyRGBAPixels (TArrayView64< FVector4f > Pixels)
 
DATAFLOWCORE_API void ConvertToRGBA32F ()
 
DATAFLOWCORE_API bool Serialize (FArchive &Ar)
 
DATAFLOWCORE_API void ReadChannel (EDataflowImageChannel Channel, FDataflowImage &OutImage) const
 
DATAFLOWCORE_API void WriteChannel (EDataflowImageChannel Channel, const FDataflowImage &SrcImage)
 

Detailed Description

Represents image for dataflow type is constrained to Float32 with 1 or 4 channels

Member Function Documentation

◆ ConvertToRGBA32F()

void FDataflowImage::ConvertToRGBA32F ( )

Convert the current image to a 4 channel float pixel format previous data is kept

◆ CopyRGBAPixels()

bool FDataflowImage::CopyRGBAPixels ( TArrayView64< FVector4f Pixels)

Copy RGBA32F pixels to the image Number of pixels must match and format must be RGBA32F return false if the copy could not be done

◆ CreateFromColor() [1/2]

void FDataflowImage::CreateFromColor ( EDataflowImageResolution  Resolution,
FLinearColor  Color 
)

Create a four channels float format image filled with a specific color

◆ CreateFromColor() [2/2]

void FDataflowImage::CreateFromColor ( int32  Width,
int32  Height,
FLinearColor  Color 
)

Create a four channels float format image filled with a specific color

◆ CreateR32F() [1/2]

void FDataflowImage::CreateR32F ( EDataflowImageResolution  Resolution)

Create a single channel float format image

◆ CreateR32F() [2/2]

void FDataflowImage::CreateR32F ( int32  Width,
int32  Height 
)

Create a single channel float format image

◆ CreateRGBA32F() [1/2]

void FDataflowImage::CreateRGBA32F ( EDataflowImageResolution  Resolution)

Create a four channels float format image

◆ CreateRGBA32F() [2/2]

void FDataflowImage::CreateRGBA32F ( int32  Width,
int32  Height 
)

Create a four channels float format image

◆ GetHeight()

int32 FDataflowImage::GetHeight ( ) const

◆ GetImage()

const FImage & FDataflowImage::GetImage ( ) const

get the readonly underlying image object

◆ GetWidth()

int32 FDataflowImage::GetWidth ( ) const

◆ ReadChannel()

void FDataflowImage::ReadChannel ( EDataflowImageChannel  Channel,
FDataflowImage OutImage 
) const

Get a specific color channel and copy it to an image Warning : the outImage will be resized to the size of the current image and any previously store data will be lost

◆ Serialize()

bool FDataflowImage::Serialize ( FArchive Ar)

◆ WriteChannel()

void FDataflowImage::WriteChannel ( EDataflowImageChannel  Channel,
const FDataflowImage SrcImage 
)

write to a sepcific channel from an existing image if the source image is not the same size it will be resized to adapt the size of the current image if the source image is not a greyscale image it will be converted to greyscale before copy the data to the channel


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