Add useful example applications which teach users how to use certain features
johannesugb opened this issue · 0 comments
johannesugb commented
This is a general issue which requests to add additional sample applications with the intent of teaching framework users how certain things can be done. A good source for inspiration can be Sascha Willems' Vulkan examples. The point shall be to show how certain things can be done, how certain Vulkan features can be used, and how all of this is done with Auto-Vk/Gears-Vk.
Please discuss below which example would be worthwhile to be added to the Gears-Vk examples applications and why!
Whenever we have decided upon the addition of a new example application, the following Definition of Done list may serve as a template for things to check:
- A new example applications has been added properly to the
gears-vk.sln
, it can be built and run without errors or validation errors. - The example's code shows how to use a certain feature or how some task can be done with Auto-Vk/Gears_Vk. The code is focussed on clarity and explains the relevant parts very well while otherwise trying to cause as little additional overhead or confusion as possible.
- If -- in order to enable the desired functionality -- code additions to either Auto-Vk or Gears-Vk are necessary, please contribute then via pull requests.
- The added example code (and possibly framework code) is documented and written in a way so that a new framework user has a chance of understanding it.
- The Contribution Guidelines have been followed.