foray_imageloader.hpp

Go to the documentation of this file.

#pragma once
#include "../core/foray_commandbuffer.hpp"
#include "../core/foray_managedimage.hpp"
#include "../foray_basics.hpp"
#include "../foray_vulkan.hpp"
#include "../osi/foray_env.hpp"
#include "foray_imageformattraits.hpp"
#include <functional>
 
namespace foray::util {
 
    enum class EImageChannel
    {
        Unknown = -1,
        R       = 0,
        G,
        B,
        A,
        Y
    };
 
    template <VkFormat FORMAT>
    class ImageLoader
    {
      public:
        using FORMAT_TRAITS = ImageFormatTraits<FORMAT>;
 
        class ImageInfo : public NoMoveDefaults
        {
          public:
            bool                       Valid = false;
            osi::Utf8Path              Utf8Path;
            std::string                Extension = "";
            std::string                Name      = "";
            std::vector<EImageChannel> Channels;
            VkExtent2D                 Extent = VkExtent2D{};
        };
 
        inline ImageLoader() {}
 
        inline bool Init(const osi::Utf8Path& utf8path);
 
        inline static bool sFormatSupported(core::Context* context);
 
        inline bool Load();
 
        inline void Destroy();
 
        virtual inline ~ImageLoader() { Destroy(); }
 
        FORAY_GETTER_CR(Info)
        FORAY_GETTER_CR(RawData)
 
        inline void InitManagedImage(core::Context*                  context,
                                     core::ManagedImage*             image,
                                     core::ManagedImage::CreateInfo& ci,
                                     VkImageLayout                   afterwrite = VkImageLayout::VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) const;
        inline void InitManagedImage(core::Context*                  context,
                                     core::HostSyncCommandBuffer&        cmdBuffer,
                                     core::ManagedImage*             image,
                                     core::ManagedImage::CreateInfo& ci,
                                     VkImageLayout                   afterwrite = VkImageLayout::VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) const;
        inline void UpdateManagedImageCI(core::ManagedImage::CreateInfo& ci) const;
        inline void WriteManagedImageData(core::ManagedImage* image, VkImageLayout afterwrite) const;
        inline void WriteManagedImageData(core::HostSyncCommandBuffer& cmdBuffer, core::ManagedImage* image, VkImageLayout afterwrite) const;
 
      protected:
        ImageInfo                  mInfo;
        std::vector<uint8_t>       mRawData;
        void*                      mCustomLoaderInfo        = nullptr;
        std::function<void(void*)> mCustomLoaderInfoDeleter = {};
 
        bool PopulateImageInfo_TinyExr();
        bool PopulateImageInfo_Stb();
        bool Load_TinyExr();
        bool Load_Stb();
    };
 
}  // namespace foray::util
 
#include "foray_imageloader.inl"