FMipMapImage Struct Reference

#include <ImageCore.h>

Classes
struct	FMipInfo

Public Member Functions
IMAGECORE_API void	Init (ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
IMAGECORE_API void	Init (int32 MipZeroWidth, int32 MipZeroHeight, int32 NumMips, ERawImageFormat::Type InFormat, EGammaSpace InGammaSpace)
IMAGECORE_API void	CopyTo (FMipMapImage &DestImage, ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace)
void	CopyTo (FMipMapImage &DestImage)
IMAGECORE_API void	ChangeFormat (ERawImageFormat::Type DestFormat, EGammaSpace DestGammaSpace)
bool	IsValid () const
bool	GetMipDimensions (int32 MipLevel, int32 &OutWidth, int32 &OutHeight) const
int32	GetMipCount () const
FImageView	GetMipImage (int32 MipLevel)
void	AddMipImage (TArray64< uint8 > &&Buffer, int32 Width, int32 Height)
int64	GetNumPixels ()

Public Attributes
TArray64< uint8 >	RawData
TArray< FMipInfo >	SubImages
ERawImageFormat::Type	Format = ERawImageFormat::BGRA8
EGammaSpace	GammaSpace = EGammaSpace::sRGB

Detailed Description

Structure for raw image data used for Image formats that support Mip Maps.

Member Function Documentation

AddMipImage()

void FMipMapImage::AddMipImage ( TArray64< uint8 > &&  Buffer, int32  Width, int32  Height  )

inline

ChangeFormat()

void FMipMapImage::ChangeFormat	(	ERawImageFormat::Type	DestFormat,
		EGammaSpace	DestGammaSpace
	)

In - place format change does nothing if already in the desired format

CopyTo() [1/2]

void FMipMapImage::CopyTo ( FMipMapImage &  DestImage )

inline

CopyTo() [2/2]

void FMipMapImage::CopyTo	(	FMipMapImage &	DestImage,
		ERawImageFormat::Type	DestFormat,
		EGammaSpace	DestGammaSpace
	)

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

Parameters

DestImage	- The destination image. Will be allocated. Any existing contents are replaced.
DestFormat	- The destination image format.
DestSRGB	- Whether the destination image is in SRGB format.

GetMipCount()

int32 FMipMapImage::GetMipCount ( ) const

inline

GetMipDimensions()

bool FMipMapImage::GetMipDimensions ( int32  MipLevel, int32 &  OutWidth, int32 &  OutHeight  ) const

inline

GetMipImage()

FImageView FMipMapImage::GetMipImage ( int32  MipLevel )

inline

GetNumPixels()

int64 FMipMapImage::GetNumPixels ( )

inline

Init() [1/2]

void FMipMapImage::Init	(	ERawImageFormat::Type	InFormat,
		EGammaSpace	InGammaSpace
	)

Initializes the Mip Map Image with parameters with uninitialized SubImages.

Parameters

InFormat	Raw Image Format
InGammaSpace	Gamma Space

Init() [2/2]

void FMipMapImage::Init	(	int32	MipZeroWidth,
		int32	MipZeroHeight,
		int32	NumMips,
		ERawImageFormat::Type	InFormat,
		EGammaSpace	InGammaSpace
	)

Initializes the Mip Map Image with reserving space for mip maps.

Parameters

InFormat	Raw Image Format
InGammaSpace	Gamma Space

IsValid()

bool FMipMapImage::IsValid ( ) const

inline

Member Data Documentation

Format

ERawImageFormat::Type FMipMapImage::Format = ERawImageFormat::BGRA8

Format in which the images is stored.

GammaSpace

EGammaSpace FMipMapImage::GammaSpace = EGammaSpace::sRGB

The gamma space the image is stored in.

RawData

TArray64<uint8> FMipMapImage::RawData

Raw image data.

SubImages

TArray<FMipInfo> FMipMapImage::SubImages

Holds information about the sub images some image formats support.

---

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