1. Epic GamesDeveloper
  3. FDDSFile

FDDSFile

Metadata structure for a DDS file, with access pointers for the raw texture data (i.e. unconverted from the DXGI format).

API > API/Runtime > API/Runtime/ImageCore

References

   
Module ImageCore
Header /Engine/Source/Runtime/ImageCore/Public/DDSFile.h
Include #include "DDSFile.h"

Syntax

struct FDDSFile

Remarks

Metadata structure for a DDS file, with access pointers for the raw texture data (i.e. unconverted from the DXGI format).

Can be used for loading or saving a dds file.

For saving, general structure is: { dds = FDDSFile::CreateEmpty2D copy data for each mip/array: for (mips) memcpy(dds->mips[idx].data, mip_data, mip_size);

Ar = IFileManager::Get().CreateFileWriter(filename);

dds->Serialize(Ar); delete dds;

Ar->Close() delete Ar; }

Variables

  Type Name Description
Public variable uint32 ArraySize Array size here uses the conventions as in the D3D runtime, which means an array of N cubemaps has an array size of 6N (one element per face).
Public variable uint32 CreateFlags  
Public variable uint32 Depth  
Public variable int32 Dimension  
Public variable EDXGIFormat DXGIFormat  
Public variable uint32 Height  
Public variable uint32 MipCount  
Public variable TArray64< uint8 > MipRawData When we allocate the mips ourselves, we keep all storage together in a single allocation, namely this one, and the mips point into it.
Public variable TArray< FDDSMip > Mips Mips are ordered starting from mip 0 (full-size texture) decreasing in size; for arrays, we store the full mip chain for one array element before advancing to the next array element, and have (ArraySize * MipCount) mips total.
Public variable uint32 Width  

Functions

  Type Name Description
Public function void For 8-bit UNorm formats, both RGBA and BGRA channel order variants exist and are popular.
Public function void Convert X alpha to A and fill 255
Public function Static FDDSFile *

CreateEmpty ( int32 InDimension,
uint32 InWidth,
uint32 InHeight,
uint32 InDepth,
uint32 InMipCount,
uint32 InArraySize,
EDXGIFormat InFormat,
uint32 InCreateFlags,
EDDSError* OutError
)

 Create an empty DDS structure (for writing DDS files typically)
Public function Static FDDSFile *

CreateEmpty2D ( uint32 InWidth,
uint32 InHeight,
uint32 InMipCount,
EDXGIFormat InFormat,
uint32 InCreateFlags,
EDDSError* OutError
)

 Convenience version of the above to create a basic 2D texture with mip chain.
Public function Static FDDSFile *

CreateFromDDSInMemory ( const uint8* InDDS,
int64 InDDSSize,
EDDSError* OutError,
bool bHeaderOnly
)

 Used for loading from a DDS file image in memory.
Public function void

FillMip ( const FImageView& FromImage,
int MipIndex
)

 Fill DDS mip from ImageImage must be of format DXGIFormatFromRawFormat
Public function Const bool

GetMipImage ( const FImageView& ToImage,
int MipIndex
)

 Blit pixels from DDS mip to Image return false if no pixel format conversion is supported ToImage is not allocated, must be pre-allocated and sized correctly
Public function Static bool

IsADDS ( const uint8* InDDS,
int64 InDDSSize
)

 Is this buffer a DDS ?
Public function Const bool Check if this DDS is usable in Unreal Texture types:
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const EDDSError Sanity-check that all members make sense and return an error code.
Public function EDDSError

WriteDDS ( TArray64< uint8 >& OutDDS,
EDDSFormatVersion InFormatVersion
)

 Write DDS-format data to memory.

Constants

Name Description
CREATE_FLAG_CUBEMAP  
CREATE_FLAG_NO_MIP_STORAGE_ALLOC  
CREATE_FLAG_NONE Bit flags.
CREATE_FLAG_WAS_D3D9  
MAX_MIPS_SUPPORTED 20 mips means 512k x 512k pixels max, should be sufficient for now.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page