vk_resource_tracker.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_utility_mixins.hh"
#include "BLI_vector.hh"
 
#include "vk_common.hh"
 
namespace blender::gpu {
namespace render_graph {
class VKRenderGraph;
}
class VKContext;
 
#if (defined(__GNUC__) && __GNUC__ >= 14 && !defined(__clang__))
#  pragma GCC diagnostic push
/* CPP20 compiler warnings in GCC14+.
 * Must be resolved before upgrading to a newer C++, avoid noisy warnings for now. */
#  pragma GCC diagnostic ignored "-Wtemplate-id-cdtor"
#endif
 
struct VKSubmissionID {
  friend class render_graph::VKRenderGraph;
 
 private:
  int64_t id_ = -1;
 
 public:
  VKSubmissionID() = default;
 
 private:
  void reset()
  {
    id_ = 0;
  }
 
  void next()
  {
    id_++;
  }
 
 public:
  const VKSubmissionID &operator=(const VKSubmissionID &other)
  {
    id_ = other.id_;
    return *this;
  }
 
  bool operator==(const VKSubmissionID &other)
  {
    return id_ == other.id_;
  }
 
  bool operator!=(const VKSubmissionID &other)
  {
    return id_ != other.id_;
  }
};
 
class VKSubmissionTracker {
  VKSubmissionID last_known_id_;
 
 public:
  bool is_changed(const VKContext &context);
};
 
template<typename Resource> class VKResourceTracker : NonCopyable {
  VKSubmissionTracker submission_tracker_;
  Vector<std::unique_ptr<Resource>> tracked_resources_;
 
 protected:
  VKResourceTracker<Resource>() = default;
  VKResourceTracker<Resource>(VKResourceTracker<Resource> &&other)
      : submission_tracker_(other.submission_tracker_),
        tracked_resources_(std::move(other.tracked_resources_))
  {
  }
 
  VKResourceTracker<Resource> &operator=(VKResourceTracker<Resource> &&other)
  {
    submission_tracker_ = other.submission_tracker_;
    tracked_resources_ = std::move(other.tracked_resources_);
    return *this;
  }
 
  virtual ~VKResourceTracker()
  {
    free_tracked_resources();
  }
 
  std::unique_ptr<Resource> &tracked_resource_for(VKContext &context, const bool is_dirty)
  {
    if (submission_tracker_.is_changed(context)) {
      free_tracked_resources();
      tracked_resources_.append(create_resource(context));
    }
    else if (is_dirty || tracked_resources_.is_empty()) {
      tracked_resources_.append(create_resource(context));
    }
    return active_resource();
  }
 
  virtual std::unique_ptr<Resource> create_resource(VKContext &context) = 0;
 
  bool has_active_resource()
  {
    return !tracked_resources_.is_empty();
  }
 
  std::unique_ptr<Resource> &active_resource()
  {
    BLI_assert(!tracked_resources_.is_empty());
    return tracked_resources_.last();
  }
 
 private:
  void free_tracked_resources()
  {
    tracked_resources_.clear();
  }
};
 
#if (defined(__GNUC__) && __GNUC__ >= 14 && !defined(__clang__))
#  pragma GCC diagnostic pop
#endif
 
}  // namespace blender::gpu