init

2025-09-04 10:54:47 +08:00
commit 6bc8f61b18
1808 changed files with 208268 additions and 0 deletions
@@ -0,0 +1,143 @@
+/* Copyright (c) 2021, 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 "core/image.h"
+#include "core/sampler.h"
+#include <memory>
+
+namespace vkb
+{
+class RenderTarget;
+
+namespace core
+{
+/**
+* @brief A reference to a vkb::core::ImageView, plus an optional sampler for it
+*        - either coming from a vkb::RenderTarget or from a user-created Image.
+*/
+class SampledImage
+{
+  public:
+	/**
+	* @brief Constructs a SampledImage referencing the given image and with the given sampler.
+	* @remarks If the sampler is null, a default sampler will be used.
+	*/
+	SampledImage(const ImageView &image_view, Sampler *sampler = nullptr);
+
+	/**
+	* @brief Constructs a SampledImage referencing a certain attachment of a render target.
+	* @remarks If the render target is null, the default is assumed.
+	*          If the sampler is null, a default sampler is used.
+	*/
+	SampledImage(uint32_t target_attachment, RenderTarget *render_target = nullptr, Sampler *sampler = nullptr, bool isDepthResolve = false);
+
+	SampledImage(const SampledImage &to_copy);
+	SampledImage &operator=(const SampledImage &to_copy);
+
+	SampledImage(SampledImage &&to_move);
+	SampledImage &operator=(SampledImage &&to_move);
+
+	~SampledImage() = default;
+
+	/**
+	 * @brief Replaces the current image view with the given one.
+	 */
+	inline void set_image_view(const ImageView &new_view)
+	{
+		image_view = &new_view;
+	}
+
+	/**
+	 * @brief Replaces the image view with an attachment of the PostProcessingPipeline's render target.
+	 */
+	inline void set_image_view(uint32_t new_attachment)
+	{
+		image_view        = nullptr;
+		target_attachment = new_attachment;
+	}
+
+	/**
+	 * @brief If this view refers to a render target attachment, returns a pointer to its index;
+	 *        otherwise, returns `null`.
+	 * @remarks The lifetime of the returned pointer matches that of this `SampledImage`.
+	 */
+	const uint32_t *get_target_attachment() const;
+
+	/**
+	 * @brief Returns either the ImageView, if set, or the image view for the set target attachment.
+	 *        If the view has no render target associated with it, default_target is used.
+	 */
+	const ImageView &get_image_view(const vkb::RenderTarget &default_target) const;
+
+	/**
+	 * @brief Returns the currently-set sampler, if any.
+	 */
+	inline Sampler *get_sampler() const
+	{
+		return sampler;
+	}
+
+	/**
+	 * @brief Sets the sampler for this SampledImage.
+	 */
+	inline void set_sampler(Sampler *new_sampler)
+	{
+		sampler = new_sampler;
+	}
+
+	/**
+	 * @brief Returns the RenderTarget, if set.
+	 */
+	inline RenderTarget *get_render_target() const
+	{
+		return render_target;
+	}
+
+	/**
+	 * @brief Returns either the RenderTarget, if set, or - if not - the given fallback render target.
+	 */
+	inline RenderTarget &get_render_target(RenderTarget &fallback) const
+	{
+		return render_target ? *render_target : fallback;
+	}
+
+	/**
+	 * @brief Sets the sampler for this SampledImage.
+	 *        Setting it to null will make it use the default instead.
+	 */
+	inline void set_render_target(RenderTarget *new_render_target)
+	{
+		render_target = std::move(new_render_target);
+	}
+
+	inline bool is_depth_resolve() const
+	{
+		return isDepthResolve;
+	}
+
+  private:
+	const ImageView *image_view;
+	uint32_t         target_attachment;
+	RenderTarget *   render_target;
+	Sampler *        sampler;
+	bool             isDepthResolve;
+};
+
+}        // namespace core
+}        // namespace vkb