Crafter.Graphics/examples/VulkanWindow/README.md

# HelloWindow Example

## Description

This example demonstrates the minimal code needed to create a vulkan window and show it on the screen.

## Expected Result

A blue tinted vulkan window with the title "HelloWindow" shows onscreen, with debug info in the console.

##  Highlighted Code Snippet

```cpp
VulkanDevice::CreateDevice();
WindowWaylandVulkan window("HelloWindow", 1280, 720);
VkCommandBuffer cmd = window.StartInit();
window.FinishInit();
window.StartSync();
```

## How to Run

```bash
crafter-build -c example -r
```

## Relevant documentation

[VulkanDevice](https://crafter-graphics.docs.catcrafts.net/classCrafter_1_1VulkanDevice.html)
[WindowWaylandVulkan](https://crafter-graphics.docs.catcrafts.net/classCrafter_1_1WindowWaylandVulkan.html)