Add Hello world example. (#1797)

1 files changed, 132 insertions, 0 deletions

diff --git a/examples/hello-world/vulkan-api.h b/examples/hello-world/vulkan-api.h
new file mode 100644
index 000000000..17d0465a6
--- /dev/null
+++ b/examples/hello-world/vulkan-api.h
@@ -0,0 +1,132 @@
+#pragma once
+
+#define VK_NO_PROTOTYPES
+#include "vulkan/vulkan.h"
+
+// This file provides basic loading and helper functions for using
+// the Vulkan API.
+
+// The Vulkan function pointers we will use in this example.
+#define VK_API_GLOBAL_PROCS(x) \
+    x(vkGetInstanceProcAddr) \
+    x(vkCreateInstance) \
+    x(vkEnumerateInstanceLayerProperties) \
+    x(vkDestroyInstance) \
+    /* */
+
+#define VK_API_INSTANCE_PROCS_OPT(x) \
+    x(vkGetPhysicalDeviceFeatures2) \
+    x(vkGetPhysicalDeviceProperties2) \
+    x(vkCreateDebugReportCallbackEXT) \
+    x(vkDestroyDebugReportCallbackEXT) \
+    x(vkDebugReportMessageEXT) \
+    /* */
+
+#define VK_API_INSTANCE_PROCS(x) \
+    x(vkCreateDevice) \
+    x(vkDestroyDevice) \
+    x(vkEnumeratePhysicalDevices) \
+    x(vkGetPhysicalDeviceProperties) \
+    x(vkGetPhysicalDeviceFeatures) \
+    x(vkGetPhysicalDeviceMemoryProperties) \
+    x(vkGetPhysicalDeviceQueueFamilyProperties) \
+    x(vkGetPhysicalDeviceFormatProperties) \
+    x(vkGetDeviceProcAddr) \
+    /* */
+
+#define VK_API_DEVICE_PROCS(x) \
+    x(vkCreateDescriptorPool) \
+    x(vkDestroyDescriptorPool) \
+    x(vkGetDeviceQueue) \
+    x(vkQueueSubmit) \
+    x(vkQueueWaitIdle) \
+    x(vkCreateBuffer) \
+    x(vkAllocateMemory) \
+    x(vkMapMemory) \
+    x(vkUnmapMemory) \
+    x(vkCmdCopyBuffer) \
+    x(vkDestroyBuffer) \
+    x(vkFreeMemory) \
+    x(vkCreateDescriptorSetLayout) \
+    x(vkDestroyDescriptorSetLayout) \
+    x(vkAllocateDescriptorSets) \
+    x(vkUpdateDescriptorSets) \
+    x(vkCreatePipelineLayout) \
+    x(vkDestroyPipelineLayout) \
+    x(vkCreateComputePipelines) \
+    x(vkDestroyPipeline) \
+    x(vkCreateShaderModule) \
+    x(vkDestroyShaderModule) \
+    x(vkCreateCommandPool) \
+    x(vkDestroyCommandPool) \
+    \
+    x(vkGetBufferMemoryRequirements) \
+    \
+    x(vkCmdBindPipeline) \
+    x(vkCmdBindDescriptorSets) \
+    x(vkCmdDispatch) \
+    \
+    x(vkFreeCommandBuffers) \
+    x(vkAllocateCommandBuffers) \
+    x(vkBeginCommandBuffer) \
+    x(vkEndCommandBuffer) \
+    x(vkBindBufferMemory) \
+    /* */
+
+#define VK_API_ALL_GLOBAL_PROCS(x) \
+    VK_API_GLOBAL_PROCS(x)
+
+#define VK_API_ALL_INSTANCE_PROCS(x) \
+    VK_API_INSTANCE_PROCS(x) \
+
+#define VK_API_ALL_PROCS(x) \
+    VK_API_ALL_GLOBAL_PROCS(x) \
+    VK_API_ALL_INSTANCE_PROCS(x) \
+    VK_API_DEVICE_PROCS(x) \
+    VK_API_INSTANCE_PROCS_OPT(x) \
+    /* */
+
+#define VK_API_DECLARE_PROC(NAME) PFN_##NAME NAME = nullptr;
+
+struct VulkanAPI
+{
+    VkInstance instance = VK_NULL_HANDLE;
+    VkDevice device = VK_NULL_HANDLE;
+    VkPhysicalDevice physicalDevice = VK_NULL_HANDLE;
+    VkDebugReportCallbackEXT debugReportCallback = VK_NULL_HANDLE;
+    void* vulkanLibraryHandle = nullptr;
+    VkPhysicalDeviceProperties deviceProperties;
+    VkPhysicalDeviceFeatures deviceFeatures;
+    VkPhysicalDeviceMemoryProperties deviceMemoryProperties;
+    int queueFamilyIndex = -1;
+
+    VK_API_ALL_PROCS(VK_API_DECLARE_PROC)
+
+    /// Initialize the instance functions
+    int initInstanceProcs();
+
+    /// Called before initDevice
+    int initPhysicalDevice(VkPhysicalDevice physicalDevice);
+
+    /// Initialize the device functions
+    int initDeviceProcs();
+
+    /// Finds the proper memory type index for a given requirement.
+    int findMemoryTypeIndex(uint32_t typeBits, VkMemoryPropertyFlags properties);
+
+    /// Clean up and frees device and instance.
+    ~VulkanAPI();
+};
+
+#define RETURN_ON_FAIL(x) \
+    {                           \
+        auto _res = x;          \
+        if (_res != 0)          \
+        {                       \
+            return -1;          \
+        }                       \
+    }
+
+// Loads Vulkan library and creates a VkDevice.
+// Returns 0 if successful.
+int initializeVulkanDevice(VulkanAPI& api);