UE::Geometry::FImageAdapter Class Reference

#include <ImageBuilder.h>

Public Types
enum class	EImageType { Float1 , Float3 , Float4 }

Public Member Functions
	FImageAdapter (TImageBuilder< float > *Image)
	FImageAdapter (TImageBuilder< FVector3f > *Image)
	FImageAdapter (TImageBuilder< FVector4f > *Image)
void	SetDimensions (FImageDimensions Dimensions)
FImageDimensions	GetDimensions () const
void	SetPixel (const FVector2i &PixelCoords, const FVector4f &FloatPixel)
void	SetPixel (const FVector2i &PixelCoords, const FLinearColor &FloatPixel)
FVector4f	GetPixel (int64 LinearIndex) const
FVector4f	GetPixel (const FVector2i &PixelCoords) const

Protected Attributes
EImageType	ImageType
TImageBuilder< float > *	Image1f = nullptr
TImageBuilder< FVector3f > *	Image3f = nullptr
TImageBuilder< FVector4f > *	Image4f = nullptr

Detailed Description

FImageAdapter is a wrapper around different types of TImageBuilder that provides a standard interface, which allows functions that don't need to know about the specific image type to operate on "any" image. For example to allow code that works on a 4-channel image to operate on a single-channel image (in which case the Adapter will expand/collapse the channels automatically).

Member Enumeration Documentation

EImageType

enum class UE::Geometry::FImageAdapter::EImageType

strong

Enumerator
Float1
Float3
Float4

Constructor & Destructor Documentation

FImageAdapter() [1/3]

UE::Geometry::FImageAdapter::FImageAdapter ( TImageBuilder< float > *  Image )

inline

FImageAdapter() [2/3]

UE::Geometry::FImageAdapter::FImageAdapter ( TImageBuilder< FVector3f > *  Image )

inline

FImageAdapter() [3/3]

UE::Geometry::FImageAdapter::FImageAdapter ( TImageBuilder< FVector4f > *  Image )

inline

Member Function Documentation

GetDimensions()

FImageDimensions UE::Geometry::FImageAdapter::GetDimensions ( ) const

inline

GetPixel() [1/2]

FVector4f UE::Geometry::FImageAdapter::GetPixel ( const FVector2i &  PixelCoords ) const

inline

GetPixel() [2/2]

FVector4f UE::Geometry::FImageAdapter::GetPixel ( int64  LinearIndex ) const

inline

SetDimensions()

void UE::Geometry::FImageAdapter::SetDimensions ( FImageDimensions  Dimensions )

inline

SetPixel() [1/2]

void UE::Geometry::FImageAdapter::SetPixel ( const FVector2i &  PixelCoords, const FLinearColor &  FloatPixel  )

inline

SetPixel() [2/2]

void UE::Geometry::FImageAdapter::SetPixel ( const FVector2i &  PixelCoords, const FVector4f &  FloatPixel  )

inline

Member Data Documentation

Image1f

TImageBuilder<float>* UE::Geometry::FImageAdapter::Image1f = nullptr

protected

Image3f

TImageBuilder<FVector3f>* UE::Geometry::FImageAdapter::Image3f = nullptr

protected

Image4f

TImageBuilder<FVector4f>* UE::Geometry::FImageAdapter::Image4f = nullptr

protected

ImageType

EImageType UE::Geometry::FImageAdapter::ImageType

protected

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/GeometryCore/Public/Image/ImageBuilder.h