UE::DDS::FDDSFile Struct Reference

#include <DDSFile.h>

Public Member Functions
IMAGECORE_API EDDSError	WriteDDS (TArray64< uint8 > &OutDDS, EDDSFormatVersion InFormatVersion=EDDSFormatVersion::D3D10)
IMAGECORE_API EDDSError	Validate () const
IMAGECORE_API bool	IsValidTexture2D () const
IMAGECORE_API bool	IsValidTextureCube () const
IMAGECORE_API bool	IsValidTextureArray () const
IMAGECORE_API bool	IsValidTextureVolume () const
IMAGECORE_API void	ConvertChannelOrder (EChannelOrder InTargetOrder)
IMAGECORE_API void	ConvertRGBXtoRGBA ()
IMAGECORE_API bool	GetMipImage (const FImageView &ToImage, int MipIndex) const
IMAGECORE_API void	FillMip (const FImageView &FromImage, int MipIndex)

Static Public Member Functions
static IMAGECORE_API FDDSFile *	CreateEmpty (int32 InDimension, uint32 InWidth, uint32 InHeight, uint32 InDepth, uint32 InMipCount, uint32 InArraySize, EDXGIFormat InFormat, uint32 InCreateFlags, EDDSError *OutError=nullptr)
static IMAGECORE_API FDDSFile *	CreateEmpty2D (uint32 InWidth, uint32 InHeight, uint32 InMipCount, EDXGIFormat InFormat, uint32 InCreateFlags, EDDSError *OutError=nullptr)
static IMAGECORE_API FDDSFile *	CreateFromDDSInMemory (const uint8 *InDDS, int64 InDDSSize, EDDSError *OutError, bool bHeaderOnly)
static IMAGECORE_API FDDSFile *	CreateFromDDSInMemory (const uint8 *InDDS, int64 InDDSSize, EDDSError *OutError=nullptr, EDDSReadMipMode InMipReadMode=EDDSReadMipMode::Full)
static IMAGECORE_API bool	IsADDS (const uint8 *InDDS, int64 InDDSSize)

Public Attributes
int32	Dimension =0
uint32	Width =0
uint32	Height =0
uint32	Depth =0
uint32	MipCount =0
uint32	ArraySize =0
EDXGIFormat	DXGIFormat =EDXGIFormat::UNKNOWN
uint32	CreateFlags =0
TArray< FDDSMip >	Mips
TArray64< uint8 >	MipRawData

Static Public Attributes
static constexpr uint32	MAX_MIPS_SUPPORTED = 20
static constexpr uint32	CREATE_FLAG_NONE = 0
static constexpr uint32	CREATE_FLAG_CUBEMAP = 1
static constexpr uint32	CREATE_FLAG_NO_MIP_STORAGE_ALLOC = 2
static constexpr uint32	CREATE_FLAG_WAS_D3D9 = 4

Member Function Documentation

ConvertChannelOrder()

void UE::DDS::FDDSFile::ConvertChannelOrder

(

EChannelOrder

InTargetOrder

)

ConvertRGBXtoRGBA()

void UE::DDS::FDDSFile::ConvertRGBXtoRGBA

(

)

CreateEmpty()

FDDSFile * UE::DDS::FDDSFile::CreateEmpty ( int32  InDimension, uint32  InWidth, uint32  InHeight, uint32  InDepth, uint32  InMipCount, uint32  InArraySize, EDXGIFormat  InFormat, uint32  InCreateFlags, EDDSError *  OutError = nullptr  )

static

CreateEmpty2D()

FDDSFile * UE::DDS::FDDSFile::CreateEmpty2D ( uint32  InWidth, uint32  InHeight, uint32  InMipCount, EDXGIFormat  InFormat, uint32  InCreateFlags, EDDSError *  OutError = nullptr  )

static

CreateFromDDSInMemory() [1/2]

FDDSFile * UE::DDS::FDDSFile::CreateFromDDSInMemory ( const uint8 *  InDDS, int64  InDDSSize, EDDSError *  OutError, bool  bHeaderOnly  )

static

CreateFromDDSInMemory() [2/2]

FDDSFile * UE::DDS::FDDSFile::CreateFromDDSInMemory ( const uint8 *  InDDS, int64  InDDSSize, EDDSError *  OutError = nullptr, EDDSReadMipMode  InMipReadMode = EDDSReadMipMode::Full  )

static

FillMip()

void UE::DDS::FDDSFile::FillMip	(	const FImageView &	FromImage,
		int	MipIndex
	)

GetMipImage()

bool UE::DDS::FDDSFile::GetMipImage	(	const FImageView &	ToImage,
		int	MipIndex
	)		const

IsADDS()

bool UE::DDS::FDDSFile::IsADDS ( const uint8 *  InDDS, int64  InDDSSize  )

static

IsValidTexture2D()

bool UE::DDS::FDDSFile::IsValidTexture2D

(

)

const

IsValidTextureArray()

bool UE::DDS::FDDSFile::IsValidTextureArray

(

)

const

IsValidTextureCube()

bool UE::DDS::FDDSFile::IsValidTextureCube

(

)

const

IsValidTextureVolume()

bool UE::DDS::FDDSFile::IsValidTextureVolume

(

)

const

Validate()

EDDSError UE::DDS::FDDSFile::Validate

(

)

const

WriteDDS()

EDDSError UE::DDS::FDDSFile::WriteDDS	(	TArray64< uint8 > &	OutDDS,
		EDDSFormatVersion	InFormatVersion = EDDSFormatVersion::D3D10
	)

Member Data Documentation

ArraySize

uint32 UE::DDS::FDDSFile::ArraySize =0

CREATE_FLAG_CUBEMAP

constexpr uint32 UE::DDS::FDDSFile::CREATE_FLAG_CUBEMAP = 1

staticconstexpr

CREATE_FLAG_NO_MIP_STORAGE_ALLOC

constexpr uint32 UE::DDS::FDDSFile::CREATE_FLAG_NO_MIP_STORAGE_ALLOC = 2

staticconstexpr

CREATE_FLAG_NONE

constexpr uint32 UE::DDS::FDDSFile::CREATE_FLAG_NONE = 0

staticconstexpr

CREATE_FLAG_WAS_D3D9

constexpr uint32 UE::DDS::FDDSFile::CREATE_FLAG_WAS_D3D9 = 4

staticconstexpr

CreateFlags

uint32 UE::DDS::FDDSFile::CreateFlags =0

Depth

uint32 UE::DDS::FDDSFile::Depth =0

Dimension

int32 UE::DDS::FDDSFile::Dimension =0

DXGIFormat

EDXGIFormat UE::DDS::FDDSFile::DXGIFormat =EDXGIFormat::UNKNOWN

Height

uint32 UE::DDS::FDDSFile::Height =0

MAX_MIPS_SUPPORTED

constexpr uint32 UE::DDS::FDDSFile::MAX_MIPS_SUPPORTED = 20

staticconstexpr

MipCount

uint32 UE::DDS::FDDSFile::MipCount =0

MipRawData

TArray64<uint8> UE::DDS::FDDSFile::MipRawData

Mips

TArray<FDDSMip> UE::DDS::FDDSFile::Mips

Width

uint32 UE::DDS::FDDSFile::Width =0

---

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

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