init

samples/api/hello_triangle/CMakeLists.txt

@@ -0,0 +1,37 @@
+# Copyright (c) 2019-2025, Arm Limited and Contributors
+# Copyright (c) 2025, Sascha Willems
+#
+# 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.
+#
+
+get_filename_component(FOLDER_NAME ${CMAKE_CURRENT_LIST_DIR} NAME)
+get_filename_component(PARENT_DIR ${CMAKE_CURRENT_LIST_DIR} PATH)
+get_filename_component(CATEGORY_NAME ${PARENT_DIR} NAME)
+
+add_sample(
+    ID ${FOLDER_NAME}
+    CATEGORY ${CATEGORY_NAME}
+    AUTHOR "Arm"
+    NAME "Hello Triangle"
+    DESCRIPTION "An introduction into Vulkan and its respective objects."
+    SHADER_FILES_GLSL
+        "hello_triangle/glsl/triangle.vert"
+        "hello_triangle/glsl/triangle.frag"
+    SHADER_FILES_HLSL
+        "hello_triangle/hlsl/triangle.vert.hlsl"
+        "hello_triangle/hlsl/triangle.frag.hlsl"
+    SHADER_FILES_SLANG
+        "hello_triangle/slang/triangle.vert.slang"
+        "hello_triangle/slang/triangle.frag.slang")

samples/api/hello_triangle/README.adoc

@@ -0,0 +1,27 @@
+////
+- Copyright (c) 2019-2023, The Khronos Group
+-
+- 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.
+-
+////
+
+= Hello Triangle
+
+ifdef::site-gen-antora[]
+TIP: The source for this sample can be found in the https://github.com/KhronosGroup/Vulkan-Samples/tree/main/samples/api/hello_triangle[Khronos Vulkan samples github repository].
+endif::[]
+
+
+A self-contained (minimal use of framework) sample that illustrates the rendering of a triangle.

samples/api/hello_triangle/hello_triangle.h

@@ -0,0 +1,179 @@
+/* Copyright (c) 2018-2025, Arm Limited and Contributors
+ * Copyright (c) 2025, Sascha Willems
+ *
+ * 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/instance.h"
+#include "platform/application.h"
+
+/**
+ * @brief A self-contained (minimal use of framework) sample that illustrates
+ * the rendering of a triangle
+ */
+class HelloTriangle : public vkb::Application
+{
+	/**
+	 * @brief Swapchain state
+	 */
+	struct SwapchainDimensions
+	{
+		/// Width of the swapchain.
+		uint32_t width = 0;
+
+		/// Height of the swapchain.
+		uint32_t height = 0;
+
+		/// Pixel format of the swapchain.
+		VkFormat format = VK_FORMAT_UNDEFINED;
+	};
+
+	/**
+	 * @brief Per-frame data
+	 */
+	struct PerFrame
+	{
+		VkFence         queue_submit_fence          = VK_NULL_HANDLE;
+		VkCommandPool   primary_command_pool        = VK_NULL_HANDLE;
+		VkCommandBuffer primary_command_buffer      = VK_NULL_HANDLE;
+		VkSemaphore     swapchain_acquire_semaphore = VK_NULL_HANDLE;
+		VkSemaphore     swapchain_release_semaphore = VK_NULL_HANDLE;
+	};
+
+	/**
+	 * @brief Vulkan objects and global state
+	 */
+	struct Context
+	{
+		/// The Vulkan instance.
+		VkInstance instance = VK_NULL_HANDLE;
+
+		/// The Vulkan physical device.
+		VkPhysicalDevice gpu = VK_NULL_HANDLE;
+
+		/// The Vulkan device.
+		VkDevice device = VK_NULL_HANDLE;
+
+		/// The Vulkan device queue.
+		VkQueue queue = VK_NULL_HANDLE;
+
+		/// The swapchain.
+		VkSwapchainKHR swapchain = VK_NULL_HANDLE;
+
+		/// The swapchain dimensions.
+		SwapchainDimensions swapchain_dimensions;
+
+		/// The surface we will render to.
+		VkSurfaceKHR surface = VK_NULL_HANDLE;
+
+		/// The queue family index where graphics work will be submitted.
+		int32_t graphics_queue_index = -1;
+
+		/// The image view for each swapchain image.
+		std::vector<VkImageView> swapchain_image_views;
+
+		/// The framebuffer for each swapchain image view.
+		std::vector<VkFramebuffer> swapchain_framebuffers;
+
+		/// The renderpass description.
+		VkRenderPass render_pass = VK_NULL_HANDLE;
+
+		/// The graphics pipeline.
+		VkPipeline pipeline = VK_NULL_HANDLE;
+
+		/**
+		 * The pipeline layout for resources.
+		 * Not used in this sample, but we still need to provide a dummy one.
+		 */
+		VkPipelineLayout pipeline_layout = VK_NULL_HANDLE;
+
+		/// The debug utility callback.
+		VkDebugUtilsMessengerEXT debug_callback = VK_NULL_HANDLE;
+
+		/// A set of semaphores that can be reused.
+		std::vector<VkSemaphore> recycled_semaphores;
+
+		/// A set of per-frame data.
+		std::vector<PerFrame> per_frame;
+
+		VmaAllocator vma_allocator = VK_NULL_HANDLE;
+	};
+
+	/// Properties of the vertices used in this sample.
+	struct Vertex
+	{
+		glm::vec3 position;
+		glm::vec3 color;
+	};
+
+	/// The Vulkan buffer object that holds the vertex data for the triangle.
+	VkBuffer vertex_buffer = VK_NULL_HANDLE;
+
+	/// The device memory allocated for the vertex buffer.
+	VkDeviceMemory vertex_buffer_memory = VK_NULL_HANDLE;
+
+	/// Vulkan Memory Allocator (VMA) allocation info for the vertex buffer.
+	VmaAllocation vertex_buffer_allocation = VK_NULL_HANDLE;
+
+  public:
+	HelloTriangle();
+
+	virtual ~HelloTriangle();
+
+	virtual bool prepare(const vkb::ApplicationOptions &options) override;
+
+	virtual void update(float delta_time) override;
+
+	virtual bool resize(const uint32_t width, const uint32_t height) override;
+
+	bool validate_extensions(const std::vector<const char *>          &required,
+	                         const std::vector<VkExtensionProperties> &available);
+
+	void init_instance();
+
+	void init_device();
+
+	void init_vertex_buffer();
+
+	void init_per_frame(PerFrame &per_frame);
+
+	void teardown_per_frame(PerFrame &per_frame);
+
+	void init_swapchain();
+
+	void init_render_pass();
+
+	VkShaderModule load_shader_module(const std::string &path);
+
+	void init_pipeline();
+
+	VkResult acquire_next_image(uint32_t *image);
+
+	void render_triangle(uint32_t swapchain_index);
+
+	VkResult present_image(uint32_t index);
+
+	void init_framebuffers();
+
+  private:
+	Context context;
+
+	std::unique_ptr<vkb::core::InstanceC> vk_instance;
+};
+
+std::unique_ptr<vkb::Application> create_hello_triangle();