aboutsummaryrefslogtreecommitdiff
path: root/vcpkg/ports/vulkan-memory-allocator/usage
diff options
context:
space:
mode:
Diffstat (limited to 'vcpkg/ports/vulkan-memory-allocator/usage')
-rw-r--r--vcpkg/ports/vulkan-memory-allocator/usage19
1 files changed, 19 insertions, 0 deletions
diff --git a/vcpkg/ports/vulkan-memory-allocator/usage b/vcpkg/ports/vulkan-memory-allocator/usage
new file mode 100644
index 0000000..ac6bca6
--- /dev/null
+++ b/vcpkg/ports/vulkan-memory-allocator/usage
@@ -0,0 +1,19 @@
+VulkanMemoryAllocator provides official find_package support. However, it requires the user to provide the include directory containing `vulkan/vulkan.h`. There are multiple ways to achieve this and VulkanMemoryAllocator is compatible with all of them.
+
+ find_package(Vulkan) # https://cmake.org/cmake/help/latest/module/FindVulkan.html, CMake 3.21+
+ find_package(VulkanMemoryAllocator CONFIG REQUIRED)
+ target_link_libraries(main PRIVATE Vulkan::Vulkan GPUOpen::VulkanMemoryAllocator)
+
+or
+
+ find_package(Vulkan) # CMake 3.21+
+ find_package(VulkanMemoryAllocator CONFIG REQUIRED)
+ target_link_libraries(main PRIVATE Vulkan::Headers GPUOpen::VulkanMemoryAllocator)
+
+or
+
+ find_package(VulkanHeaders CONFIG) # From the vulkan-headers port
+ find_package(VulkanMemoryAllocator CONFIG REQUIRED)
+ target_link_libraries(main PRIVATE Vulkan::Headers GPUOpen::VulkanMemoryAllocator)
+
+See the documentation for more information on setting up your project: https://gpuopen-librariesandsdks.github.io/VulkanMemoryAllocator/html/index.html