documentation

example/VulkanTriangle/README

@@ -0,0 +1,29 @@
+# HelloWindow Example
+
+## Description
+
+This example demonstrates how to load shaders and render a triangle.
+
+## Expected Result
+
+A blue tinted vulkan window with a white triangle in the center.
+
+##  Highlighted Code Snippet
+
+```cpp
+EventListener<VkCommandBuffer> listener(&window.onDraw, [&descriptors, &meshShader](VkCommandBuffer cmd){
+    vkCmdBindDescriptorSets(cmd, VK_PIPELINE_BIND_POINT_GRAPHICS, Pipeline::pipelineLayout, 0, 2, &descriptors.set[0], 0, NULL);
+    vkCmdBindPipeline(cmd, VK_PIPELINE_BIND_POINT_GRAPHICS, Pipeline::pipeline);
+    VulkanDevice::vkCmdDrawMeshTasksEXTProc(cmd, meshShader.threadCount, 1, 1);
+});
+```
+
+## How to Run
+
+```bash
+crafter-build -c example -r
+```
+
+## Relevant documentation
+
+