Image.h

Go to the documentation of this file.

 
#ifndef LLUVIA_CORE_IMAGE_IMAGE_H_
#define LLUVIA_CORE_IMAGE_IMAGE_H_
 
#include "lluvia/core/Object.h"
#include "lluvia/core/image/ImageDescriptor.h"
#include "lluvia/core/image/ImageLayout.h"
#include "lluvia/core/image/ImageTiling.h"
#include "lluvia/core/image/ImageUsageFlags.h"
#include "lluvia/core/memory/MemoryAllocationInfo.h"
#include "lluvia/core/types.h"
 
#include "lluvia/core/vulkan/vulkan.hpp"
 
#include <array>
#include <cstdint>
#include <memory>
#include <string>
#include <tuple>
#include <vector>
 
namespace ll {
 
namespace vulkan {
    class Device;
} // namespace vulkan
 
class CommandBuffer;
class ComputeNode;
class ComputeGraph;
class ImageView;
class ImageViewDescriptor;
class Memory;
class Session;
 
class Image : public Object,
              public std::enable_shared_from_this<ll::Image> {
 
public:
    Image()             = delete;
    Image(const Image&) = delete;
    Image(Image&&)      = delete;
 
    ~Image();
 
    Image& operator=(const Image&) = delete;
    Image& operator=(Image&&)      = delete;
 
    ll::ObjectType getType() const noexcept override;
 
    ll::MemoryAllocationInfo getAllocationInfo() const noexcept;
 
    const std::shared_ptr<ll::Memory>& getMemory() const noexcept;
 
    uint64_t getSize() const noexcept;
 
    uint64_t getMinimumSize() const noexcept;
 
    const ll::ImageDescriptor& getDescriptor() const noexcept;
 
    ll::ImageUsageFlags getUsageFlags() const noexcept;
 
    uint32_t getUsageFlagsUnsafe() const noexcept;
 
    ll::ImageLayout getLayout() const noexcept;
 
    ll::ImageTiling getTiling() const noexcept;
 
    ll::ChannelType getChannelType() const noexcept;
 
    uint64_t getChannelTypeSize() const noexcept;
 
    template <typename T = ll::ChannelCount>
    T getChannelCount() const noexcept
    {
        return m_descriptor.getChannelCount<T>();
    }
 
    uint32_t getWidth() const noexcept;
 
    uint32_t getHeight() const noexcept;
 
    uint32_t getDepth() const noexcept;
 
    ll::vec3ui getShape() const noexcept;
 
    std::shared_ptr<ll::ImageView> createImageView(const ll::ImageViewDescriptor& tDescriptor);
 
    void changeImageLayout(const ll::ImageLayout newLayout);
 
    void clear();
 
    void copyTo(ll::Image& dst);
 
private:
    Image(const std::shared_ptr<ll::vulkan::Device>& device,
        const vk::Image&                             vkImage,
        const ll::ImageDescriptor&                   descriptor,
        const std::shared_ptr<ll::Memory>&           memory,
        const ll::MemoryAllocationInfo&              allocInfo,
        const ll::ImageLayout                        layout);
 
    std::shared_ptr<ll::vulkan::Device> m_device;
 
    ll::ImageDescriptor      m_descriptor;
    ll::MemoryAllocationInfo m_allocInfo;
 
    vk::Image       m_vkImage;
    ll::ImageLayout m_layout;
 
    // Shared pointer to the memory this image was created from
    // This will keep the memory alive until this image is deleted
    // avoiding reference to a corrupted memory location.
    std::shared_ptr<ll::Memory> m_memory;
 
    friend class ll::CommandBuffer;
    friend class ll::ComputeNode;
    friend class ll::ComputeGraph;
    friend class ll::ImageView;
    friend class ll::Memory;
    friend class ll::Session;
};
 
} // namespace ll
 
#endif /* LLUVIA_CORE_IMAGE_IMAGE_H_ */