init

framework/resource_binding_state.h

@@ -0,0 +1,120 @@
+/* Copyright (c) 2019-2025, Arm Limited and Contributors
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Licensed under the Apache License, Version 2.0 the "License";
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "common/vk_common.h"
+#include "core/buffer.h"
+
+namespace vkb
+{
+namespace core
+{
+template <vkb::BindingType bindingType>
+class Buffer;
+using BufferC = Buffer<vkb::BindingType::C>;
+
+class ImageView;
+class Sampler;
+}        // namespace core
+
+/**
+ * @brief A resource info is a struct containing the actual resource data.
+ *
+ * This will be referenced by a buffer info or image info descriptor inside a descriptor set.
+ */
+struct ResourceInfo
+{
+	bool dirty{false};
+
+	const vkb::core::BufferC *buffer{nullptr};
+
+	VkDeviceSize offset{0};
+
+	VkDeviceSize range{0};
+
+	const core::ImageView *image_view{nullptr};
+
+	const core::Sampler *sampler{nullptr};
+};
+
+/**
+ * @brief A resource set is a set of bindings containing resources that were bound
+ *        by a command buffer.
+ *
+ * The ResourceSet has a one to one mapping with a DescriptorSet.
+ */
+class ResourceSet
+{
+  public:
+	void reset();
+
+	bool is_dirty() const;
+
+	void clear_dirty();
+
+	void clear_dirty(uint32_t binding, uint32_t array_element);
+
+	void bind_buffer(const vkb::core::BufferC &buffer, VkDeviceSize offset, VkDeviceSize range, uint32_t binding, uint32_t array_element);
+
+	void bind_image(const core::ImageView &image_view, const core::Sampler &sampler, uint32_t binding, uint32_t array_element);
+
+	void bind_image(const core::ImageView &image_view, uint32_t binding, uint32_t array_element);
+
+	void bind_input(const core::ImageView &image_view, uint32_t binding, uint32_t array_element);
+
+	const BindingMap<ResourceInfo> &get_resource_bindings() const;
+
+  private:
+	bool dirty{false};
+
+	BindingMap<ResourceInfo> resource_bindings;
+};
+
+/**
+ * @brief The resource binding state of a command buffer.
+ *
+ * Keeps track of all the resources bound by the command buffer. The ResourceBindingState is used by
+ * the command buffer to create the appropriate descriptor sets when it comes to draw.
+ */
+class ResourceBindingState
+{
+  public:
+	void reset();
+
+	bool is_dirty();
+
+	void clear_dirty();
+
+	void clear_dirty(uint32_t set);
+
+	void bind_buffer(const vkb::core::BufferC &buffer, VkDeviceSize offset, VkDeviceSize range, uint32_t set, uint32_t binding, uint32_t array_element);
+
+	void bind_image(const core::ImageView &image_view, const core::Sampler &sampler, uint32_t set, uint32_t binding, uint32_t array_element);
+
+	void bind_image(const core::ImageView &image_view, uint32_t set, uint32_t binding, uint32_t array_element);
+
+	void bind_input(const core::ImageView &image_view, uint32_t set, uint32_t binding, uint32_t array_element);
+
+	const std::unordered_map<uint32_t, ResourceSet> &get_resource_sets();
+
+  private:
+	bool dirty{false};
+
+	std::unordered_map<uint32_t, ResourceSet> resource_sets;
+};
+}        // namespace vkb