FImageInfo Struct Reference

#include <ImageCore.h>

Inheritance diagram for FImageInfo:

Public Member Functions
	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
int32	SizeX = 0
int32	SizeY = 0
int32	NumSlices = 0
ERawImageFormat::Type	Format = ERawImageFormat::BGRA8
EGammaSpace	GammaSpace = EGammaSpace::sRGB

Detailed Description

FImageInfo describes a 2d pixel surface it can be used by FImage or FImageView

Constructor & Destructor Documentation

FImageInfo() [1/2]

FImageInfo::FImageInfo ( )

inline

FImageInfo() [2/2]

FImageInfo::FImageInfo ( int32  InSizeX, int32  InSizeY, int32  InNumSlices, ERawImageFormat::Type  InFormat, EGammaSpace  InGammaSpace  )

inline

Member Function Documentation

GetBytesPerPixel()

int64 FImageInfo::GetBytesPerPixel ( ) const

inline

Gets the number of bytes per pixel.

Returns

Bytes per pixel.

GetGammaSpace()

EGammaSpace FImageInfo::GetGammaSpace ( ) const

inline

GetHeight()

int64 FImageInfo::GetHeight ( ) const

inline

GetImageSizeBytes()

int64 FImageInfo::GetImageSizeBytes ( ) const

inline

GetNumPixels()

int64 FImageInfo::GetNumPixels ( ) const

inline

GetPixelOffsetBytes()

int64 FImageInfo::GetPixelOffsetBytes ( int32  X, int32  Y, int32  Slice = 0  ) const

inline

GetSliceNumPixels()

int64 FImageInfo::GetSliceNumPixels ( ) const

inline

GetSliceSizeBytes()

int64 FImageInfo::GetSliceSizeBytes ( ) const

inline

GetStrideBytes()

int64 FImageInfo::GetStrideBytes ( ) const

inline

GetWidth()

int64 FImageInfo::GetWidth ( ) const

inline

ImageInfoFromCompactBinary()

bool FImageInfo::ImageInfoFromCompactBinary

(

const FCbObject &

InObject

)

ImageInfoToCompactBinary()

void FImageInfo::ImageInfoToCompactBinary

(

class FCbObject &

OutObject

)

const

IsGammaCorrected()

bool FImageInfo::IsGammaCorrected ( ) const

inline

IsImageInfoValid()

bool FImageInfo::IsImageInfoValid ( ) const

inline

operator==()

bool FImageInfo::operator== ( const FImageInfo &  rhs ) const

inline

Member Data Documentation

Format

ERawImageFormat::Type FImageInfo::Format = ERawImageFormat::BGRA8

Format in which the image is stored.

GammaSpace

EGammaSpace FImageInfo::GammaSpace = EGammaSpace::sRGB

The gamma space the image is stored in.

NumSlices

int32 FImageInfo::NumSlices = 0

Number of image slices.

SizeX

int32 FImageInfo::SizeX = 0

Width of the image.

SizeY

int32 FImageInfo::SizeY = 0

Height of the image.

---

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