evictable.h

Go to the documentation of this file.

#pragma once
 
#include <cstdint>
 
namespace gfx
{
 
enum class evict_state : std::uint8_t
{
    resident, 
    evicted,  
};
 
enum class evict_class : std::uint8_t
{
    non_evictable, 
    evictable,     
};
 
namespace detail
{
extern std::uint64_t g_eviction_frame;
} // namespace detail
 
class eviction_registry;
 
class ievictable
{
public:
    ievictable() = default;
    ievictable(const ievictable&) = delete;
    auto operator=(const ievictable&) -> ievictable& = delete;
    ievictable(ievictable&&) = delete;
    auto operator=(ievictable&&) -> ievictable& = delete;
    virtual ~ievictable() = default;
 
    virtual auto on_evict() -> std::uint64_t = 0;
 
    virtual auto on_restore() -> bool = 0;
 
    [[nodiscard]] virtual auto gpu_size() const -> std::uint64_t = 0;
 
    [[nodiscard]] auto get_evict_class() const -> evict_class
    {
        return evict_class_;
    }
 
    [[nodiscard]] auto get_evict_state() const -> evict_state
    {
        return evict_state_;
    }
 
    [[nodiscard]] auto get_last_use_frame() const -> std::uint64_t
    {
        return last_use_frame_;
    }
 
    [[nodiscard]] auto get_use_count() const -> std::uint64_t
    {
        return use_count_;
    }
 
    void touch() const noexcept
    {
        last_use_frame_ = detail::g_eviction_frame;
        ++use_count_;
    }
 
protected:
    mutable std::uint64_t last_use_frame_{0};
    mutable std::uint64_t use_count_{0};
    evict_state evict_state_{evict_state::resident};
    evict_class evict_class_{evict_class::non_evictable};
 
private:
    std::uint32_t evict_slot_{UINT32_MAX};
    std::uint64_t evict_frame_{0};
 
    friend class eviction_registry;
};
 
} // namespace gfx