• Stars
    star
    1,098
  • Rank 42,222 (Top 0.9 %)
  • Language
    C++
  • License
    Apache License 2.0
  • Created almost 4 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A beginner-friendly Vulkan path tracing tutorial in under 300 lines of C++.

logo

vk_mini_path_tracer

A relatively small, beginner-friendly path tracing tutorial.

▢️ Load the tutorial! ◀️

This tutorial is a beginner-friendly introduction to writing your own fast, photorealistic path tracer in less than 300 lines of C++ code and 250 lines of GLSL shader code using Vulkan. Here's an example of what you'll render at the end of this tutorial!

Vulkan is a low-level API for programming GPUs – fast, highly parallel processors. It works on a wide variety of platforms – everything from workstations, to gaming consoles, to tablets and mobile phones, to edge devices.

Vulkan is usually known as a complex API, but I believe that when presented in the right way, it's possible to make learning Vulkan accessible to people of all skill levels, whether they're never programmed graphics before or whether they're a seasoned rendering engineer. Perhaps surprisingly, one of the best ways to introduce Vulkan may be with GPU path tracing, because the API involved is relatively small.

We'll show how to write a small path tracer, using the NVVK helpers, included in the nvpro-samples framework, to help with some Vulkan calls when needed. For advanced readers, we'll also optionally talk about performance tips and some of the implementation details inside the helpers and Vulkan itself.

The final program uses less than 300 lines of C++ and less than 250 lines of GLSL shader code, including comments. You can find it here.

Here are all the Vulkan functions, and NVVK functions and objects, that we'll use in the main tutorial:

Vulkan Functions
vkAllocateCommandBuffers vkBeginCommandBuffer vkCmdBindDescriptorSets
vkCmdBindPipeline vkCmdDispatch vkCmdFillBuffer
vkCmdPipelineBarrier vkCreateCommandPool vkCreateComputePipelines
vkDestroyCommandPool vkDestroyPipeline vkDestroyShaderModule
vkFreeCommandBuffers vkGetBufferDeviceAddress vkQueueSubmit
vkQueueWaitIdle vkUpdateDescriptorSets
NVVK Functions and Objects
nvvk::Buffer NVVK_CHECK nvvk::Context
nvvk::ContextCreateInfo nvvk::createShaderModule nvvk::DescriptorSetContainer
nvvk::make nvvk::RayTracingBuilderKHR nvvk::ResourceAllocatorDedicated

Chapters

Chapter
small
Hello, Vulkan!
small
Device Extensions and Vulkan Objects
small
Memory and Commands
small
Writing an Image
small
Compute Shaders
small
Descriptors
small
Acceleration Structures and Ray Tracing
small
Four Uses of Intersection Data
small
Accessing Mesh Data
small
Perfectly Specular Reflections
small
Antialiasing and Pseudorandom Number Generation
small
Diffuse Reflection

Extra Chapters

These are optional, extra tutorials that show how to polish and add new features to the main tutorial's path tracer. Make sure to check out the list of further Vulkan and ray tracing resources at the end of the main tutorial as well!

Extra Chapter

Gaussian Filter Antialiasing

Measuring Performance

Compaction

Including Files and Matching Values Between C++ And GLSL

Push Constants

More Samples

Images

Debug Names

Instances and Transformation Matrices

Multiple Materials

Ray Tracing Pipelines

Building and Running

Please see the instructions here.

More Repositories

1

vk_raytracing_tutorial_KHR

Ray tracing examples and tutorials using VK_KHR_ray_tracing
C++
1,314
star
2

vk_raytrace

Ray tracing glTF scene with Vulkan
C++
533
star
3

gl_occlusion_culling

OpenGL sample for shader-based occlusion culling
C++
517
star
4

nvpro_core

shared source code and resources needed for the samples to run
C++
457
star
5

optix_advanced_samples

C
411
star
6

gl_vk_meshlet_cadscene

This OpenGL/Vulkan sample illustrates the use of "mesh shaders" for rendering CAD models.
C++
345
star
7

gl_ssao

optimized screen-space ambient occlusion, cache-aware hbao
C++
343
star
8

build_all

GO HERE FIRST: nvpro-samples overview
Batchfile
312
star
9

vk_order_independent_transparency

Demonstrates seven different techniques for order-independent transparency in Vulkan.
C++
264
star
10

vk_video_samples

Vulkan video samples
C++
239
star
11

gl_vk_chopper

Simple vulkan rendering example.
C++
202
star
12

vk_mini_samples

Collection of Vulkan samples
HLSL
184
star
13

vk_raytracing_tutorial_NV

Vulkan ray tracing examples and tutorials using VK_NV_ray_tracing
C++
158
star
14

gl_vk_threaded_cadscene

OpenGL and Vulkan comparison on rendering a CAD scene using various techniques
C++
157
star
15

gl_cadscene_rendertechniques

OpenGL sample on various rendering approaches for typical CAD scenes
C++
151
star
16

gl_commandlist_basic

OpenGL sample for NV_command_list
C++
112
star
17

vk_gltf_renderer

Rendering glTF scenes with ray tracer and raster (Vulkan)
C++
102
star
18

vk_displacement_micromaps

This sample showcases rasterizing and ray tracing displaced NVIDIA Micro-Mesh assets in Vulkan with and without the VK_NV_displacement_micromap extension.
C++
92
star
19

vk_denoise

Denoising a Vulkan ray traced image using OptiX denoiser
C++
88
star
20

gl_vk_bk3dthreaded

Vulkan sample rendering 3D with 'worker-threads'
C++
84
star
21

gl_vk_simple_interop

Display an image created by Vulkan compute shader, with OpenGL
C++
76
star
22

vk_toon_shader

Silhouette and toon shading post-processing with Vulkan
C++
74
star
23

gl_dynamic_lod

GPU classifies how to render millions of particles
C++
71
star
24

nvtt_samples

NVIDIA Texture Tools samples for compression, image processing, and decompression.
C++
64
star
25

gl_vk_supersampled

Vulkan sample showing a high quality super-sampled rendering
C++
63
star
26

optix_prime_baking

Shows how to bake ambient occlusion at mesh vertices using OptiX Prime
45
star
27

vk_compute_mipmaps

Customizable compute shader for fast cache-aware mipmap generation
GLSL
41
star
28

vk_async_resources

Sample showcasing lifetime management and resource transfers in Vulkan
C++
32
star
29

gl_vk_raytrace_interop

Adding ray traced ambient occlusion using Vulkan and OpenGL
C++
30
star
30

vk_timeline_semaphore

Vulkan timeline semaphore + async compute performance sample
GLSL
26
star
31

gl_render_vk_ddisplay

OpenGL sample that renders into a Vulkan direct display
C++
26
star
32

gl_multicast

OpenGL sample for the new GL_NVX_linked_gpu_multicast extension
C++
25
star
33

vk_device_generated_cmds

Vulkan sample on VK_NV_device_generated_commands
C++
25
star
34

shared_external

external libraries, needed for the samples (AntTweakBar; ZLib...)
HTML
17
star
35

vk_offline

Rendering offline using Vulkan without opening a window
C++
13
star
36

glsl_indexed_types_generator

GLSL code generator to aid use of Vulkan's descriptor set indexing
Lua
12
star
37

gl_cuda_simple_interop

Sample showing OpenGL and CUDA interop
C++
11
star
38

vk_memory_decompression

Vulkan Memory Decompression (VK_NV_memory_decompression) sample
C++
10
star
39

vk_streamline

DLSS Super Resolution and DLSS Frame Generation via Streamline
C++
10
star
40

vk_idbuffer_rasterization

Vulkan sample to render efficient per-part IDs in CAD models
C++
8
star
41

gl_path_rendering_CMYK

Example of how to use path rendering; and how to use it with CMYK (using multi-render target)
C++
8
star
42

dx12_present_barrier

This sample demonstrates the usage of the new NvAPI interface to synchronize present calls between windows on the same system as well as on distributed systems.
C++
7
star
43

nvml_enterprise_gpu_check

Shows how to check if a GPU is an Enterprise/Quadro GPU using NVML.
C++
4
star
44

vk_raytrace_displacement

C++
3
star
45

gl_vrs

Variable Rate Shading in OpenGL
C++
3
star
46

third_party_binaries

pre-built libraries for the nvpro-samples framework
C
2
star
47

vk_inherited_viewport

VK_NV_inherited_viewport_scissor and secondary subpass command buffer re-use
C++
2
star
48

vk_ddisplay

Sample to demonstrate multi-GPU rendering and presenting to ddisplays, meaning displays that are not part of the Windows desktop and of which an application takes complete control.
C++
2
star