mirror/vk-bootstrap
1
0
Fork 0
mirror of https://github.com/charles-lunarg/vk-bootstrap.git synced 2024-11-26 08:44:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Redid example code in readme to be more legible

Browse Source
This commit is contained in:
Charles Giessen 2020-04-18 21:34:51 -06:00
parent 1f462b42f3
commit 782840296c
1 changed files with 21 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -22,47 +22,46 @@ It also adds several conveniences for:
#include "VkBootstrap.h" #include "VkBootstrap.h"
void init_vulkan() void init_vulkan () {
{
vkb::InstanceBuilder builder; vkb::InstanceBuilder builder;
builder.request_validation_layers() auto inst_ret = builder.set_app_name ("Example Vulkan Application")
.set_app_name ("Example Vulkan Application") .request_validation_layers ()
.use_default_debug_messenger (); .use_default_debug_messenger ()
auto inst_ret = builder.build(); .build ();
if (!inst_ret.has_value()) { if (!inst_ret) {
// error // error
} }
vkb::Instance vkb_inst = inst_ret.value(); vkb::Instance vkb_inst = inst_ret.value ();
vkb::PhysicalDeviceSelector selector{ inst }; vkb::PhysicalDeviceSelector selector{ vkb_inst };
selector.set_surface (/* from user created window*/) auto phys_ret = selector.set_surface (/* from user created window*/)
.set_minimum_version (1, 1) //require a vulkan 1.1 capable device .set_minimum_version (1, 1) // require a vulkan 1.1 capable device
.require_dedicated_transfer_queue(); .require_dedicated_transfer_queue ()
auto phys_ret = selector.select (); .select ();
if (!phys_ret.has_value()) { if (!phys_ret) {
// error // error
} }
vkb::DeviceBuilder device_builder{ phys_ret.value() }; vkb::DeviceBuilder device_builder{ phys_ret.value () };
// automatically propagate needed data from instance & physical device
auto dev_ret = device_builder.build (); auto dev_ret = device_builder.build ();
if (!dev_ret.has_value()){ if (!dev_ret) {
// error // error
} }
vkb::Device dev = dev_ret.value(); vkb::Device vkb_device = dev_ret.value ();
// Get the VkDevice handle used in the rest of a vulkan application // Get the VkDevice handle used in the rest of a vulkan application
VkDevice device = dev.device; VkDevice device = vkb_device.device;
// Get the graphics queue with a helper function // Get the graphics queue with a helper function
auto graphics_queue_ret = dev.get_queue(vkb::QueueType::graphics); auto graphics_queue_ret = vkb_device.get_queue (vkb::QueueType::graphics);
if (!graphics_queue_ret.has_value()){ if (!graphics_queue_ret) {
// error // error
} }
VkQueue graphics_queue = graphics_queue_ret.value(); VkQueue graphics_queue = graphics_queue_ret.value ();
// Turned 400-500 lines of boilerplate into less than fifty. // Turned 400-500 lines of boilerplate into less than fifty.
} }
``` ```
See `example/triangle.cpp` for an example that renders a triangle to the screen. See `example/triangle.cpp` for an example that renders a triangle to the screen.