EncodeDDSHeader

DirectXTex

Helper functions for creating your own 'magic value' + DDS_HEADER structure. The smallest valid header is 128 bytes. The "DX10" extended header is 148 bytes. If pDestination is nullptr, it will return the amount of memory required.

HRESULT EncodeDDSHeader( const TexMetadata& metadata, DDS_FLAGS flags,
    void* pDestination, size_t maxsize,
    size_t& required);

Parameters

The flags parameter is one of the DDS_FLAGS. By default use DDS_FLAGS_NONE. See DDS-I-O-Functions for more information about these flags.

maxsize is the amount of memory pointed to by pDestination. required is the returned as the amount of used space.

Returns

This function will succeed with an S_OK or will return a HRESULT error code (E_INVALIDARG, E_FAIL, HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED), HRESULT_FROM_WIN32(ERROR_CANNOT_MAKE), or HRESULT_FROM_WIN32(ERROR_ARITHMETIC_OVERFLOW)).

Exceptions

This function is marked noexcept, and does not throw C++ exceptions.

Further reading

The DDS File Format Lives

DDS Programmer's Guide