WICTextureLoader.h

//--------------------------------------------------------------------------------------
// File: WICTextureLoader.h
//
// Function for loading a WIC image and creating a Direct3D runtime texture for it
// (auto-generating mipmaps if possible)
//
// Note: Assumes application has already called CoInitializeEx
//
// Note these functions are useful for images created as simple 2D textures. For
// more complex resources, DDSTextureLoader is an excellent light-weight runtime loader.
// For a full-featured DDS file reader, writer, and texture processing pipeline see
// the 'Texconv' sample and the 'DirectXTex' library.
//
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
//
// http://go.microsoft.com/fwlink/?LinkID=615561
//--------------------------------------------------------------------------------------

#pragma once

#ifdef _GAMING_XBOX_SCARLETT
#include <d3d12_xs.h>
#elif (defined(_XBOX_ONE) && defined(_TITLE)) || defined(_GAMING_XBOX)
#include <d3d12_x.h>
#elif defined(USING_DIRECTX_HEADERS)
#include <directx/d3d12.h>
#include <dxguids/dxguids.h>
#else
#include <d3d12.h>
#endif

#include <cstddef>
#include <cstdint>
#include <memory>

#ifdef _MSC_VER
#pragma comment(lib,"uuid.lib")
#endif


namespace DirectX
{
    inline namespace DX12
    {
        enum WIC_LOADER_FLAGS : uint32_t
        {
            WIC_LOADER_DEFAULT = 0,
            WIC_LOADER_FORCE_SRGB = 0x1,
            WIC_LOADER_IGNORE_SRGB = 0x2,
            WIC_LOADER_SRGB_DEFAULT = 0x4,
            WIC_LOADER_MIP_AUTOGEN = 0x8,
            WIC_LOADER_MIP_RESERVE = 0x10,
            WIC_LOADER_FIT_POW2 = 0x20,
            WIC_LOADER_MAKE_SQUARE = 0x40,
            WIC_LOADER_FORCE_RGBA32 = 0x80,
        };
    }

    class ResourceUploadBatch;

    // Standard version
    HRESULT __cdecl LoadWICTextureFromMemory(
        _In_ ID3D12Device* device,
        _In_reads_bytes_(wicDataSize) const uint8_t* wicData,
        size_t wicDataSize,
        _Outptr_ ID3D12Resource** texture,
        std::unique_ptr<uint8_t[]>& decodedData,
        D3D12_SUBRESOURCE_DATA& subresource,
        size_t maxsize = 0) noexcept;

    HRESULT __cdecl LoadWICTextureFromFile(
        _In_ ID3D12Device* device,
        _In_z_ const wchar_t* szFileName,
        _Outptr_ ID3D12Resource** texture,
        std::unique_ptr<uint8_t[]>& decodedData,
        D3D12_SUBRESOURCE_DATA& subresource,
        size_t maxsize = 0) noexcept;

    // Standard version with resource upload
    HRESULT __cdecl CreateWICTextureFromMemory(
        _In_ ID3D12Device* device,
        ResourceUploadBatch& resourceUpload,
        _In_reads_bytes_(wicDataSize) const uint8_t* wicData,
        size_t wicDataSize,
        _Outptr_ ID3D12Resource** texture,
        bool generateMips = false,
        size_t maxsize = 0);

    HRESULT __cdecl CreateWICTextureFromFile(
        _In_ ID3D12Device* device,
        ResourceUploadBatch& resourceUpload,
        _In_z_ const wchar_t* szFileName,
        _Outptr_ ID3D12Resource** texture,
        bool generateMips = false,
        size_t maxsize = 0);

    // Extended version
    HRESULT __cdecl LoadWICTextureFromMemoryEx(
        _In_ ID3D12Device* device,
        _In_reads_bytes_(wicDataSize) const uint8_t* wicData,
        size_t wicDataSize,
        size_t maxsize,
        D3D12_RESOURCE_FLAGS resFlags,
        WIC_LOADER_FLAGS loadFlags,
        _Outptr_ ID3D12Resource** texture,
        std::unique_ptr<uint8_t[]>& decodedData,
        D3D12_SUBRESOURCE_DATA& subresource) noexcept;

    HRESULT __cdecl LoadWICTextureFromFileEx(
        _In_ ID3D12Device* device,
        _In_z_ const wchar_t* szFileName,
        size_t maxsize,
        D3D12_RESOURCE_FLAGS resFlags,
        WIC_LOADER_FLAGS loadFlags,
        _Outptr_ ID3D12Resource** texture,
        std::unique_ptr<uint8_t[]>& decodedData,
        D3D12_SUBRESOURCE_DATA& subresource) noexcept;

    // Extended version with resource upload
    HRESULT __cdecl CreateWICTextureFromMemoryEx(
        _In_ ID3D12Device* device,
        ResourceUploadBatch& resourceUpload,
        _In_reads_bytes_(wicDataSize) const uint8_t* wicData,
        size_t wicDataSize,
        size_t maxsize,
        D3D12_RESOURCE_FLAGS resFlags,
        WIC_LOADER_FLAGS loadFlags,
        _Outptr_ ID3D12Resource** texture);

    HRESULT __cdecl CreateWICTextureFromFileEx(
        _In_ ID3D12Device* device,
        ResourceUploadBatch& resourceUpload,
        _In_z_ const wchar_t* szFileName,
        size_t maxsize,
        D3D12_RESOURCE_FLAGS resFlags,
        WIC_LOADER_FLAGS loadFlags,
        _Outptr_ ID3D12Resource** texture);

#ifdef __cpp_lib_byte
    inline HRESULT __cdecl LoadWICTextureFromMemory(
        _In_ ID3D12Device* device,
        _In_reads_bytes_(wicDataSize) const std::byte* wicData,
        size_t wicDataSize,
        _Outptr_ ID3D12Resource** texture,
        std::unique_ptr<uint8_t[]>& decodedData,
        D3D12_SUBRESOURCE_DATA& subresource,
        size_t maxsize = 0) noexcept
    {
        return LoadWICTextureFromMemory(device, reinterpret_cast<const uint8_t*>(wicData), wicDataSize, texture, decodedData, subresource, maxsize);
    }

    inline HRESULT __cdecl CreateWICTextureFromMemory(
        _In_ ID3D12Device* device,
        ResourceUploadBatch& resourceUpload,
        _In_reads_bytes_(wicDataSize) const std::byte* wicData,
        size_t wicDataSize,
        _Outptr_ ID3D12Resource** texture,
        bool generateMips = false,
        size_t maxsize = 0)
    {
        return CreateWICTextureFromMemory(device, resourceUpload, reinterpret_cast<const uint8_t*>(wicData), wicDataSize, texture, generateMips, maxsize);
    }

    inline HRESULT __cdecl LoadWICTextureFromMemoryEx(
        _In_ ID3D12Device* device,
        _In_reads_bytes_(wicDataSize) const std::byte* wicData,
        size_t wicDataSize,
        size_t maxsize,
        D3D12_RESOURCE_FLAGS resFlags,
        WIC_LOADER_FLAGS loadFlags,
        _Outptr_ ID3D12Resource** texture,
        std::unique_ptr<uint8_t[]>& decodedData,
        D3D12_SUBRESOURCE_DATA& subresource) noexcept
    {
        return LoadWICTextureFromMemoryEx(device, reinterpret_cast<const uint8_t*>(wicData), wicDataSize, maxsize, resFlags, loadFlags, texture, decodedData, subresource);
    }

    inline HRESULT __cdecl CreateWICTextureFromMemoryEx(
        _In_ ID3D12Device* device,
        ResourceUploadBatch& resourceUpload,
        _In_reads_bytes_(wicDataSize) const std::byte* wicData,
        size_t wicDataSize,
        size_t maxsize,
        D3D12_RESOURCE_FLAGS resFlags,
        WIC_LOADER_FLAGS loadFlags,
        _Outptr_ ID3D12Resource** texture)
    {
        return CreateWICTextureFromMemoryEx(device, resourceUpload, reinterpret_cast<const uint8_t*>(wicData), wicDataSize, maxsize, resFlags, loadFlags, texture);
    }
#endif //  __cpp_lib_byte

#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-dynamic-exception-spec"
#endif

    inline namespace DX12
    {
        DEFINE_ENUM_FLAG_OPERATORS(WIC_LOADER_FLAGS)
    }

#ifdef __clang__
#pragma clang diagnostic pop
#endif
}