This repository contains demos made with Vulkan API for Golang. Currently these are Android apps only, but I hope for contributions. A list of Android devices with their vulkan support clarified: 0vulkaninfo.md.
Refer to github.com/xlab/android-go/example#prerequisites for the first run instructions for Android NDK. Please note that you'll need to obtain a device with native Vulkan API support.
Once setup correctly, this course of actions is the flow of building and debugging of any app:
make # you can debug any bugs in Go code here
make install
make listenAfter you make changes, a simple make && make install would be enough to have your app APK updated on the device.
See the Makefile for details on each step.
This is a simple app template, ported from googlesamples/android-vulkan-tutorials/tutorial01_load_vulkan. VulkanInfo gathers info about your Vulkan environment's properties and prints them to the log. After you install and run the target app, check out the ADB logcat logs:
$ make listen
adb logcat -c
adb logcat *:S VulkanInfo
--------- beginning of system
--------- beginning of main
08-16 21:22:21.008 5096 5111 I VulkanInfo: ╭─────────────────────────────────────────────────╮
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ VULKAN PROPERTIES AND SURFACE CAPABILITES │
08-16 21:22:21.008 5096 5111 I VulkanInfo: ├────────────────────────┬────────────────────────┤
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Physical Device Name │ NVIDIA Tegra K1 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Physical Device Vendor │ 10de │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Physical Device Type │ Integrated GPU │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Physical GPUs │ 1 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ API Version │ 1.0.3 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ API Version Supported │ 1.0.3 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Driver Version │ 361.0.0 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: ├────────────────────────┼────────────────────────┤
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Image count │ 2 - 3 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Array layers │ 1 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Image size (current) │ 1200x1920 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Image size (extent) │ 1x1 - 4096x4096 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Usage flags │ 9f │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Current transform │ 04 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Allowed transforms │ 10f │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ Surface formats │ 3 of 185 │
08-16 21:22:21.008 5096 5111 I VulkanInfo: ├────────────────────────┼────────────────────────┤
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ INSTANCE EXTENSIONS │ │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ 1 │ VK_KHR_surface │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ 2 │ VK_KHR_android_surface │
08-16 21:22:21.008 5096 5111 I VulkanInfo: ├────────────────────────┼────────────────────────┤
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ DEVICE EXTENSIONS │ │
08-16 21:22:21.008 5096 5111 I VulkanInfo: │ 1 │ VK_KHR_swapchain │
08-16 21:22:21.008 5096 5111 I VulkanInfo: ╰────────────────────────┴────────────────────────╯
If you enable some of validation layers, they'd get listed too.
A fully functional drawing example, ported from googlesamples/android-vulkan-tutorials/tutorial05_triangle. 1KLOC, nothing special, I liked the way the original code has been organized. This was the first piece of some real code I wrote using the Vulkan API and it really delivered my the idea behind it. Anyway, I used a wrong method of handling errors here, just to see how it would feel after I'm done. It feels horrible, must've used asserts like in the next demo. All the debug and validation layers are disabled by default.
Well, after the first demo I felt like I'm ready for a big deal. A cube! It's a drawing example with dynamic state that I ported from the Cube demo under googlesamples/vulkan-basic-samples/LunarGSamples/Demos. 1.6KLOC (from 3KLOC), not a big deal (sarcasm). Surely that was a total suicide plus I figured out that the repo had an outdated version of the code and in the LunarG mainstream a lots of things are fixed now. Also the code is very poorly organized.
But there are some positive moments too. For example, I figured out how to use the validation layers, so I could debug a few nasty typos and bugs. Also I tried and was satisfied by the error handling method I picked here. Definitely would recommend to organize your error checking methods to be assert-like.
And anyways, that was a fun trip and actually it works: the validation layers are quiet now, thousands of lines do useful work and some parts can be reused as snippets. It just draws nothing that I could show you. :)
I decided to fallback from this example for a few months, maybe I'll do another cube demo from scratch when I'll get used to Vulkan more. Feel free to debug this thing. Validation layers and debug reporting are enabled in the code.
Do it! Just do it! 10KLOC is just a warm-up for you.