mirror/vk-bootstrap
1
0
Fork 0
mirror of https://github.com/charles-lunarg/vk-bootstrap.git synced 2024-11-22 15:24:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated readme to include section on how to use in an app

Browse Source
This commit is contained in:
Charles Giessen 2020-02-03 20:51:52 -07:00
parent 8734ed18e0
commit ac7d38046b
1 changed files with 53 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -1,6 +1,6 @@
# Vk-Bootstrap # Vk-Bootstrap
A Vulkan Utility library meant to jump start a Vulkan Application A Vulkan utility library meant to jump start a Vulkan Application
This library simplifies the tedious process of: This library simplifies the tedious process of:
@ -10,52 +10,73 @@ This library simplifies the tedious process of:
* Getting Queues * Getting Queues
* Swapchain Creation * Swapchain Creation
It also adds several convenience for: It also adds several conveniences for:
* enabling validation layers * enabling validation layers
* setting up a debug callback * setting up a debug callback
* automate getting a drawable surface
* selecting a gpu based on a small set of common criteria * selecting a gpu based on a small set of common criteria
## Example ## Example
```cpp ```cpp
vkb::InstanceBuilder builder;
builder.setup_validation_layers() #include "VkBootstrap.h"
void device_init()
{
vkb::InstanceBuilder builder;
builder.setup_validation_layers()
.set_app_name ("example") .set_app_name ("example")
.set_default_debug_messenger (); .set_default_debug_messenger ();
auto inst_ret = builder.build(); auto inst_ret = builder.build();
if (!inst_ret.has_value()) { if (!inst_ret.has_value()) {
// error // error
} }
vkb::Instance inst = inst_ret.value(); vkb::Instance inst = inst_ret.value();
vkb::PhysicalDeviceSelector selector{ inst }; vkb::PhysicalDeviceSelector selector{ inst };
selector.set_surface (/* from user created window*/) selector.set_surface (/* from user created window*/)
.set_minimum_version (1, 0) .set_minimum_version (1, 0)
.require_dedicated_transfer_queue(); .require_dedicated_transfer_queue();
auto phys_ret = selector.select (); auto phys_ret = selector.select ();
if (!phys_ret.has_value()) { if (!phys_ret.has_value()) {
// error // error
} }
vkb::PhysicalDevice physical_device = phys_ret.value(); vkb::PhysicalDevice physical_device = phys_ret.value();
vkb::DeviceBuilder device_builder{ physical_device }; vkb::DeviceBuilder device_builder{ physical_device };
auto dev_ret = device_builder.build (); auto dev_ret = device_builder.build ();
if (!dev_ret.has_value()){ if (!dev_ret.has_value()){
// error // error
} }
vkb::Device device = dev_ret.value(); vkb::Device device = dev_ret.value();
VkQueue graphics_queue = get_queue_graphics(device).value(); VkQueue graphics_queue = get_queue_graphics(device).value();
VkQueue compute_queue = get_queue_compute(device).value(); VkQueue compute_queue = get_queue_compute(device).value();
VkQueue transfer_queue = get_queue_transfer(device).value(); VkQueue transfer_queue = get_queue_transfer(device).value();
}
``` ```
## Building ## Using
Requires CMake and Vulkan installed on your system. Simply copy the `src/VkBootstrap.h` and `src/VkBootstrap.cpp` into your project
Alternatively, add this project as a git-submodule
```bash
git submodule add https://github.com/charles-lunarg/vk-bootstrap
```
Then add the project with cmake
```cmake
add_subdirectory(vk-bootstrap)
```
## Manually Building
Simple setup
```bash ```bash
git clone https://github.com/charles-lunarg/vk-bootstrap git clone https://github.com/charles-lunarg/vk-bootstrap