FImageView Struct Reference

#include <ImageCore.h>

Inheritance diagram for FImageView:

Public Member Functions
	FImageView ()
	FImageView (const FImageInfo &InInfo, void *InRawData)
	FImageView (const FColor *InColors, int32 InSizeX, int32 InSizeY, EGammaSpace InGammaSpace=EGammaSpace::sRGB)
	FImageView (const FLinearColor *InColors, int32 InSizeX, int32 InSizeY)
	FImageView (const FFloat16Color *InColors, int32 InSizeX, int32 InSizeY)
	FImageView (void *InData, int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
	FImageView (void *InData, int32 InSizeX, int32 InSizeY, ERawImageFormat::Type InFormat)
IMAGECORE_API FImageView	GetSlice (int32 SliceIndex) const
IMAGECORE_API void	CopyTo (FImage &DestImage, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace) const
void	CopyTo (FImage &DestImage) const
void *	GetPixelPointer (int32 X, int32 Y, int32 Slice=0) const
const FLinearColor	GetOnePixelLinear (int32 X, int32 Y, int32 Slice=0) const
TArrayView64< uint8 >	AsG8 () const
TArrayView64< uint16 >	AsG16 () const
TArrayView64< FColor >	AsBGRA8 () const
TArrayView64< FColor >	AsBGRE8 () const
TArrayView64< uint16 >	AsRGBA16 () const
TArrayView64< FFloat16Color >	AsRGBA16F () const
TArrayView64< FLinearColor >	AsRGBA32F () const
TArrayView64< FFloat16 >	AsR16F () const
TArrayView64< float >	AsR32F () const
Public Member Functions inherited from FImageInfo
	FImageInfo ()
	FImageInfo (int32 InSizeX, int32 InSizeY, int32 InNumSlices, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
bool	operator== (const FImageInfo &rhs) const
bool	IsImageInfoValid () const
bool	IsGammaCorrected () const
int64	GetBytesPerPixel () const
int64	GetNumPixels () const
int64	GetImageSizeBytes () const
int64	GetSliceNumPixels () const
int64	GetSliceSizeBytes () const
int64	GetWidth () const
int64	GetHeight () const
int64	GetStrideBytes () const
EGammaSpace	GetGammaSpace () const
int64	GetPixelOffsetBytes (int32 X, int32 Y, int32 Slice=0) const
IMAGECORE_API void	ImageInfoToCompactBinary (class FCbObject &OutObject) const
IMAGECORE_API bool	ImageInfoFromCompactBinary (const FCbObject &InObject)

Public Attributes
void *	RawData = nullptr
Public Attributes inherited from FImageInfo
int32	SizeX = 0
int32	SizeY = 0
int32	NumSlices = 0
ERawImageFormat::Type	Format = ERawImageFormat::BGRA8
EGammaSpace	GammaSpace = EGammaSpace::sRGB

Constructor & Destructor Documentation

FImageView() [1/7]

FImageView::FImageView ( )

inline

FImageView() [2/7]

FImageView::FImageView ( const FImageInfo &  InInfo, void *  InRawData  )

inline

FImageView() [3/7]

FImageView::FImageView ( const FColor *  InColors, int32  InSizeX, int32  InSizeY, EGammaSpace  InGammaSpace = EGammaSpace::sRGB  )

inline

FImageView() [4/7]

FImageView::FImageView ( const FLinearColor *  InColors, int32  InSizeX, int32  InSizeY  )

inline

FImageView() [5/7]

FImageView::FImageView ( const FFloat16Color *  InColors, int32  InSizeX, int32  InSizeY  )

inline

FImageView() [6/7]

FImageView::FImageView ( void *  InData, int32  InSizeX, int32  InSizeY, int32  InNumSlices, ERawImageFormat::Type  InFormat, EGammaSpace  InGammaSpace  )

inline

FImageView() [7/7]

FImageView::FImageView ( void *  InData, int32  InSizeX, int32  InSizeY, ERawImageFormat::Type  InFormat  )

inline

Member Function Documentation

AsBGRA8()

TArrayView64< FColor > FImageView::AsBGRA8 ( ) const

inline

AsBGRE8()

TArrayView64< FColor > FImageView::AsBGRE8 ( ) const

inline

AsG16()

TArrayView64< uint16 > FImageView::AsG16 ( ) const

inline

AsG8()

TArrayView64< uint8 > FImageView::AsG8 ( ) const

inline

AsR16F()

TArrayView64< FFloat16 > FImageView::AsR16F ( ) const

inline

AsR32F()

TArrayView64< float > FImageView::AsR32F ( ) const

inline

AsRGBA16()

TArrayView64< uint16 > FImageView::AsRGBA16 ( ) const

inline

AsRGBA16F()

TArrayView64< FFloat16Color > FImageView::AsRGBA16F ( ) const

inline

AsRGBA32F()

TArrayView64< FLinearColor > FImageView::AsRGBA32F ( ) const

inline

CopyTo() [1/2]

void FImageView::CopyTo ( FImage &  DestImage ) const

inline

CopyTo() [2/2]

void FImageView::CopyTo	(	FImage &	DestImage,
		ERawImageFormat::Type	DestFormat,
		EGammaSpace	DestGammaSpace
	)		const

Copies the image to a destination image with the specified format.

Parameters

DestImage	- The destination image.
DestFormat	- The destination image format.
DestSRGB	- Whether the destination image is in SRGB format.

GetOnePixelLinear()

const FLinearColor FImageView::GetOnePixelLinear ( int32  X, int32  Y, int32  Slice = 0  ) const

inline

GetPixelPointer()

void * FImageView::GetPixelPointer ( int32  X, int32  Y, int32  Slice = 0  ) const

inline

GetSlice()

IMAGECORE_API FImageView FImageView::GetSlice

(

int32

SliceIndex

)

const

Member Data Documentation

RawData

void* FImageView::RawData = nullptr

---

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

• Engine/Source/Runtime/ImageCore/Public/ImageCore.h
• Engine/Source/Runtime/ImageCore/Private/ImageCore.cpp