README
¶
Vulkan-Tutorial.com
This is a go port of the example code at vulkan-tutorial.com, using vkngwrapper as a wrapper library. Each subfolder pertains to a single step of the tutorial, and I have tried to strike a balance between making the tutorial code match the C++ code as closely as possible while still being vaguely idiomatic. You should be able to use the code files here as a reference while working through the vulkan tutorial.
To learn more about vkngwrapper, check out the core repository!
- Rights
- Executing This Code
- Notable Changes From C++
- Drawing a Triangle
- Swapchain Recreation
- Vertex buffers
- Uniform buffers
- Texture mapping
- Depth Buffering
- Loading Models
- Generating Mipmaps
- Multisampling
Rights
The vulkan tutorial's source and licensing information can be found at https://github.com/Overv/VulkanTutorial and are licensed under the CC BY-SA 4.0 license or the CC0 1.0 Universal license. The example code in this folder and its subfolders is also licensed under the CC0 1.0 Universal license found here. Code outside this directory may be licensed differently.
Images and meshes in this directory were obtained from the vulkan tutorial and are licensed under the CC BY-SA 4.0 license.
Executing This Code
Before this code can be executed, you will need to install the Vulkan SDK for your operating system. Additionally, it may be necessary to download SDL2 using your local package manager. For more information, see go-sdl2 requirements.
Notable Changes From C++
In order to best support this code as an idiomatic Golang example, there are a few differences between this code and the default C++ code provided at http://vulkan-tutorial.com/ - they are listed here and reasoning is provided.
SDL2 Instead of GLFW
This example code uses go-sdl2 as its windowing system, with Surface support provided via integrations/sdl2. The primary reason for this is that go-sdl2's level of support is far, far better than any GLFW wrapper for Go.
No Device layers
Step 2 of the tutorial instructs users to apply a validation layer to both the Vulkan Instance and the Device. However, Device layers were deprecated before Vulkan 1.0 was released, and is not necessary when activating validation behavior. As a result, vkngwrapper does not support Device layers and we do not apply them in this tutorial.
Vulkan Portability Subset
Beginning with Step 4, we activate the VK_KHR_portability_subset extension
in the logical Device on creation, when it is available. Doing so allows this tutorial to run on hardware
that does not support the full Vulkan spec, such as Mac laptops.
Go Embed
Asset files are loaded from disk using //go:embed. This makes it very easy to package each step's assets with the step itself and load the assets from disk with a minimum of confusion.
Drawing a Triangle
Setup
Base Code
Instance
Validation layers
Physical devices and queue families
Logical device and queues
Presentation
Window surface
Swapchain
Image views
Graphics pipeline basics
Introduction
Shader Modules
Fixed functions
Render passes
Conclusion
Drawing
Framebuffers
Command buffers
Rendering and presentation
Swapchain Recreation
Vertex buffers
Vertex input description
(Will cause Validation Layer errors, but that will be fixed in the next chapter)
Vertex buffer creation
Staging buffer
Index buffer
Uniform buffers
Descriptor layout and buffer
Descriptor pool and sets
Texture mapping
Images
Image view and sampler
Combined image sampler
Depth buffering
Loading models
Generating Mipmaps
Multisampling
Directories
¶
| Path | Synopsis |
|---|---|
|
steps
|
|
|
00_base_code
command
|
|
|
01_instance_creation
command
|
|
|
02_validation_layers
command
|
|
|
03_physical_device_selection
command
|
|
|
04_logical_device
command
|
|
|
05_window_surface
command
|
|
|
06_swapchain
command
|
|
|
07_image_views
command
|
|
|
08_graphics_pipeline
command
|
|
|
09_shader_modules
command
|
|
|
10_fixed_functions
command
|
|
|
11_render_passes
command
|
|
|
12_graphics_pipeline_complete
command
|
|
|
13_framebuffers
command
|
|
|
14_command_buffers
command
|
|
|
15_hello_triangle
command
|
|
|
16_swap_chain_recreation
command
|
|
|
17_vertex_input
command
|
|
|
18_vertex_buffer
command
|
|
|
19_staging_buffer
command
|
|
|
20_index_buffer
command
|
|
|
21_descriptor_layout
command
|
|
|
22_descriptor_sets
command
|
|
|
23_texture_image
command
|
|
|
24_sampler
command
|
|
|
25_texture_mapping
command
|
|
|
26_depth_buffering
command
|
|
|
27_model_loading
command
|
|
|
28_mipmapping
command
|
|
|
29_multisampling
command
|