Skip to content

Commit

Permalink
Improved documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
stripe2933 committed Oct 6, 2024
1 parent c6a20e7 commit efcd1e0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/hello-triangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/using-vku.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit efcd1e0

Please sign in to comment.