From efcd1e02d39df0f787fcba789a4e83f60b19c8de Mon Sep 17 00:00:00 2001 From: gomkyung2 Date: Sun, 6 Oct 2024 19:23:36 +0900 Subject: [PATCH] Improved documentation. --- docs/hello-triangle.md | 2 +- docs/using-vku.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hello-triangle.md b/docs/hello-triangle.md index 014082d..b45e224 100644 --- a/docs/hello-triangle.md +++ b/docs/hello-triangle.md @@ -1018,7 +1018,7 @@ If you're not familiar about how to use the `VK_KHR_dynamic_rendering` extension We allocated the command buffer from graphics command pool, change the image layout for color attachment usage, and do triangle rendering with the dynamic rendering scope. As mentioned above, since dynamic rendering feature is not core until Vulkan 1.3, you have to pass the dispatcher object to the `beginRenderingKHR` and `endRenderingKHR` functions (which can be omitted if you're using Vulkan 1.3). > [!TIP] -> You can set `VKU_DEFAULT_DYNAMIC_DISPATCHER` CMake variable at the configuration time, or add `dynamic-dispatcher` feature when use vcpkg to make Vulkan-Hpp uses dynamically loaded function pointers. For this feature, see [Using vku](using-vku.md) page and [Vulkan-Hpp documentation](https://github.com/KhronosGroup/Vulkan-Hpp/blob/main/README.md#extensions--per-device-function-pointers) for the details. +> You can set `VKU_DEFAULT_DYNAMIC_DISPATCHER` CMake variable at the configuration time, or add `dynamic-dispatcher` feature when use vcpkg to make Vulkan-Hpp uses dynamically loaded function pointers. For this feature, see [Using vku](using-vku.md) page and [Vulkan-Hpp documentation](https://github.com/KhronosGroup/Vulkan-Hpp/blob/main/README.md#extensions--per-device-function-pointers) for the details. With dynamic dispatch loader, you can omit the last parameter `*device.getDispatcher()`. `vku::fullSubresourceRange(vk::ImageAspectFlags aspectFlags = vk::ImageApsectFlagBits::eColor)` is *vku*'s utility function that generates the whole subresource region (all mip levels and array layers) with the given aspect flags. diff --git a/docs/using-vku.md b/docs/using-vku.md index 282a24c..c0c6b4e 100644 --- a/docs/using-vku.md +++ b/docs/using-vku.md @@ -252,7 +252,7 @@ All done! Now configuring your project with `--preset=vcpkg` would automatically 2. Using `CPM.cmake`: ```cmake - CPMAddPackage("gh:stripe2933/vku@v0.1.0") + CPMAddPackage("gh:stripe2933/vku@0.1.0") ``` After this, you can use `find_package(vku CONFIG REQUIRED)` in your project.