Vulkan-Tutorial icon indicating copy to clipboard operation
Vulkan-Tutorial copied to clipboard

Depth buffering chapter documentation completely different from actual code

Open SaschaWillems opened this issue 1 month ago • 1 comments

While working on #134 I also wanted to update the documentation for the depth buffering chapter. But said documentation is completely different than the actual code. Functions names do not match, calls are made in the documentation, but not the code, documentation mixes C/C++ header style, documentation uses some code to automatically deduce barrier settings, etc.

@gpx1000: What should we do in such cases? I need to adjust barriers in code, but the documentation does not resemble the code, so unsure on how to or if at all I can/should also update the documentation.

SaschaWillems avatar Oct 25 '25 15:10 SaschaWillems

This also partially applies to the Image view and sampler chapter. For example, the old tutorial still had a function bool isDeviceSuitable(VkPhysicalDevice device). Now this function is still used in this particular chapter but has not been introduced prior to it.

johannes-el avatar Oct 26 '25 10:10 johannes-el