UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Enumerations | Functions | Variables
UE::DDS Namespace Reference

Classes

struct  FBitmaskToDXGI
 
struct  FDDSFile
 
struct  FDDSHeaderDX10
 
struct  FDDSHeaderWithMagic
 
struct  FDDSMip
 
struct  FDDSPixelFormat
 
struct  FDXGIFormatInfo
 
struct  FDXGIFormatName
 
struct  FDXGIFormatRawFormatMapping
 
struct  FFOURCCToDXGI
 

Enumerations

enum class  EDXGIFormat { RGBFMT , BCNFMT , ODDFMT , UE_DXGI_FORMAT_LIST }
 
enum class  EDDSFormatVersion { Auto , D3D9 , D3D10 }
 
enum class  EDDSReadMipMode { Full , HeaderOnly , HeaderWithMipInfo }
 
enum class  EDDSError {
  OK , Ok = OK , OutOfMemory , NotADds ,
  NotADDS = NotADds , BadResourceDimension , BadPixelFormat , BadImageDimension ,
  BadMipmapCount , BadCubemap , IoError
}
 
enum class  EChannelOrder { RGBA , BGRA }
 

Functions

constexpr uint32 MakeFOURCC (uint32 a, uint32 b, uint32 c, uint32 d)
 
const TCHAR * DXGIFormatGetName (EDXGIFormat fmt)
 
bool DXGIFormatIsSRGB (EDXGIFormat Format)
 
bool DXGIFormatHasLinearAndSRGBForm (EDXGIFormat Format)
 
EDXGIFormat DXGIFormatRemoveSRGB (EDXGIFormat fmt)
 
EDXGIFormat DXGIFormatAddSRGB (EDXGIFormat fmt)
 
int64 GetDDSHeaderMaximalSize ()
 
int64 GetDDSHeaderMinimalSize ()
 
ERawImageFormat::Type DXGIFormatGetClosestRawFormat (EDXGIFormat fmt, bool *pIsExactMatch)
 
EDXGIFormat DXGIFormatFromRawFormat (ERawImageFormat::Type RawFormat, EGammaSpace GammaSpace)
 

Variables

constexpr uint32 DDSD_CAPS = 0x00000001
 
constexpr uint32 DDSD_HEIGHT = 0x00000002
 
constexpr uint32 DDSD_WIDTH = 0x00000004
 
constexpr uint32 DDSD_PITCH = 0x00000008
 
constexpr uint32 DDSD_PIXELFORMAT = 0x00001000
 
constexpr uint32 DDSD_MIPMAPCOUNT = 0x00020000
 
constexpr uint32 DDSD_DEPTH = 0x00800000
 
constexpr uint32 DDPF_ALPHA = 0x00000002
 
constexpr uint32 DDPF_FOURCC = 0x00000004
 
constexpr uint32 DDPF_RGB = 0x00000040
 
constexpr uint32 DDPF_LUMINANCE = 0x00020000
 
constexpr uint32 DDPF_BUMPDUDV = 0x00080000
 
constexpr uint32 DDSCAPS_COMPLEX = 0x00000008
 
constexpr uint32 DDSCAPS_TEXTURE = 0x00001000
 
constexpr uint32 DDSCAPS_MIPMAP = 0x00400000
 
constexpr uint32 DDSCAPS2_CUBEMAP = 0x00000200
 
constexpr uint32 DDSCAPS2_VOLUME = 0x00200000
 
constexpr uint32 RESOURCE_DIMENSION_UNKNOWN = 0
 
constexpr uint32 RESOURCE_DIMENSION_BUFFER = 1
 
constexpr uint32 RESOURCE_DIMENSION_TEXTURE1D = 2
 
constexpr uint32 RESOURCE_DIMENSION_TEXTURE2D = 3
 
constexpr uint32 RESOURCE_DIMENSION_TEXTURE3D = 4
 
constexpr uint32 RESOURCE_MISC_TEXTURECUBE = 0x00000004
 
constexpr uint32 DDS_MAGIC = MakeFOURCC('D', 'D', 'S', ' ')
 
constexpr uint32 DX10_MAGIC = MakeFOURCC('D', 'X', '1', '0')
 
FDXGIFormatRawFormatMapping DXGIRawFormatMap []
 

Enumeration Type Documentation

◆ EChannelOrder

enum class UE::DDS::EChannelOrder
strong
Enumerator
RGBA 
BGRA 

◆ EDDSError

enum class UE::DDS::EDDSError
strong
Enumerator
OK 
Ok 
OutOfMemory 
NotADds 
NotADDS 
BadResourceDimension 
BadPixelFormat 
BadImageDimension 
BadMipmapCount 
BadCubemap 
IoError 

◆ EDDSFormatVersion

enum class UE::DDS::EDDSFormatVersion
strong
Enumerator
Auto 
D3D9 
D3D10 

◆ EDDSReadMipMode

enum class UE::DDS::EDDSReadMipMode
strong
Enumerator
Full 
HeaderOnly 
HeaderWithMipInfo 

◆ EDXGIFormat

enum class UE::DDS::EDXGIFormat
strong
Enumerator
RGBFMT 
BCNFMT 
ODDFMT 
UE_DXGI_FORMAT_LIST 

Function Documentation

◆ DXGIFormatAddSRGB()

IMAGECORE_API EDXGIFormat UE::DDS::DXGIFormatAddSRGB ( EDXGIFormat  fmt)

◆ DXGIFormatFromRawFormat()

IMAGECORE_API EDXGIFormat UE::DDS::DXGIFormatFromRawFormat ( ERawImageFormat::Type  RawFormat,
EGammaSpace  GammaSpace 
)

◆ DXGIFormatGetClosestRawFormat()

IMAGECORE_API ERawImageFormat::Type UE::DDS::DXGIFormatGetClosestRawFormat ( EDXGIFormat  fmt,
bool *  pIsExactMatch 
)

◆ DXGIFormatGetName()

IMAGECORE_API const TCHAR * UE::DDS::DXGIFormatGetName ( EDXGIFormat  fmt)

◆ DXGIFormatHasLinearAndSRGBForm()

IMAGECORE_API bool UE::DDS::DXGIFormatHasLinearAndSRGBForm ( EDXGIFormat  Format)

◆ DXGIFormatIsSRGB()

IMAGECORE_API bool UE::DDS::DXGIFormatIsSRGB ( EDXGIFormat  Format)

◆ DXGIFormatRemoveSRGB()

IMAGECORE_API EDXGIFormat UE::DDS::DXGIFormatRemoveSRGB ( EDXGIFormat  fmt)

◆ GetDDSHeaderMaximalSize()

IMAGECORE_API int64 UE::DDS::GetDDSHeaderMaximalSize ( )

◆ GetDDSHeaderMinimalSize()

IMAGECORE_API int64 UE::DDS::GetDDSHeaderMinimalSize ( )

◆ MakeFOURCC()

constexpr uint32 UE::DDS::MakeFOURCC ( uint32  a,
uint32  b,
uint32  c,
uint32  d 
)
constexpr

Variable Documentation

◆ DDPF_ALPHA

constexpr uint32 UE::DDS::DDPF_ALPHA = 0x00000002
constexpr

◆ DDPF_BUMPDUDV

constexpr uint32 UE::DDS::DDPF_BUMPDUDV = 0x00080000
constexpr

◆ DDPF_FOURCC

constexpr uint32 UE::DDS::DDPF_FOURCC = 0x00000004
constexpr

◆ DDPF_LUMINANCE

constexpr uint32 UE::DDS::DDPF_LUMINANCE = 0x00020000
constexpr

◆ DDPF_RGB

constexpr uint32 UE::DDS::DDPF_RGB = 0x00000040
constexpr

◆ DDS_MAGIC

constexpr uint32 UE::DDS::DDS_MAGIC = MakeFOURCC('D', 'D', 'S', ' ')
constexpr

◆ DDSCAPS2_CUBEMAP

constexpr uint32 UE::DDS::DDSCAPS2_CUBEMAP = 0x00000200
constexpr

◆ DDSCAPS2_VOLUME

constexpr uint32 UE::DDS::DDSCAPS2_VOLUME = 0x00200000
constexpr

◆ DDSCAPS_COMPLEX

constexpr uint32 UE::DDS::DDSCAPS_COMPLEX = 0x00000008
constexpr

◆ DDSCAPS_MIPMAP

constexpr uint32 UE::DDS::DDSCAPS_MIPMAP = 0x00400000
constexpr

◆ DDSCAPS_TEXTURE

constexpr uint32 UE::DDS::DDSCAPS_TEXTURE = 0x00001000
constexpr

◆ DDSD_CAPS

constexpr uint32 UE::DDS::DDSD_CAPS = 0x00000001
constexpr

◆ DDSD_DEPTH

constexpr uint32 UE::DDS::DDSD_DEPTH = 0x00800000
constexpr

◆ DDSD_HEIGHT

constexpr uint32 UE::DDS::DDSD_HEIGHT = 0x00000002
constexpr

◆ DDSD_MIPMAPCOUNT

constexpr uint32 UE::DDS::DDSD_MIPMAPCOUNT = 0x00020000
constexpr

◆ DDSD_PITCH

constexpr uint32 UE::DDS::DDSD_PITCH = 0x00000008
constexpr

◆ DDSD_PIXELFORMAT

constexpr uint32 UE::DDS::DDSD_PIXELFORMAT = 0x00001000
constexpr

◆ DDSD_WIDTH

constexpr uint32 UE::DDS::DDSD_WIDTH = 0x00000004
constexpr

◆ DX10_MAGIC

constexpr uint32 UE::DDS::DX10_MAGIC = MakeFOURCC('D', 'X', '1', '0')
constexpr

◆ DXGIRawFormatMap

FDXGIFormatRawFormatMapping UE::DDS::DXGIRawFormatMap[]

◆ RESOURCE_DIMENSION_BUFFER

constexpr uint32 UE::DDS::RESOURCE_DIMENSION_BUFFER = 1
constexpr

◆ RESOURCE_DIMENSION_TEXTURE1D

constexpr uint32 UE::DDS::RESOURCE_DIMENSION_TEXTURE1D = 2
constexpr

◆ RESOURCE_DIMENSION_TEXTURE2D

constexpr uint32 UE::DDS::RESOURCE_DIMENSION_TEXTURE2D = 3
constexpr

◆ RESOURCE_DIMENSION_TEXTURE3D

constexpr uint32 UE::DDS::RESOURCE_DIMENSION_TEXTURE3D = 4
constexpr

◆ RESOURCE_DIMENSION_UNKNOWN

constexpr uint32 UE::DDS::RESOURCE_DIMENSION_UNKNOWN = 0
constexpr

◆ RESOURCE_MISC_TEXTURECUBE

constexpr uint32 UE::DDS::RESOURCE_MISC_TEXTURECUBE = 0x00000004
constexpr