clara/bluenoise-raytracer
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

New documentation

Browse source
This commit is contained in:
mklefrancois 2020-08-31 16:57:10 +02:00
parent e1dff2a4e7
commit 3465e08c77
31 changed files with 2825 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

62
docs/setup.md Normal file
View file

@ -0,0 +1,62 @@

# Environment Setup
## Repositories
Besides the current repository, you will also need to clone or download the following repositories:
* [shared_sources](https://github.com/nvpro-samples/shared_sources): The primary framework that all samples depend on.
* [shared_external](https://github.com/nvpro-samples/shared_external): Third party libraries that are provided pre-compiled, mostly for Windows x64 / MSVC.
The directory structure should be looking like this:
~~~~
\
|
+-- :file_folder: shared_external
|
+-- :file_folder: shared_sources
|
+-- :open_file_folder: vk_raytracing_tutorial_KHR
| |
| +-- :file_folder: ray_tracing__simple
| |
| +-- :file_folder: ray_tracing_...
| |
| ⋮
|
⋮
~~~~
## Latest Vulkan SDK
This repository tries to always be up to date with the latest Vulkan SDK, therefore we suggest to download and install it.
**Vulkan SDK**: https://vulkan.lunarg.com/sdk/home
## Beta Installation
KHR ray tracing is still in Beta, therefore you will need the latest
Vulkan driver.
**Latest driver**: https://developer.nvidia.com/vulkan-driver
## CMake
The CMakefile will use other makefiles from `shared_sources` and look for Vulkan environment variables for the installation of the SDK. Therefore, it is important to have all the above installed before running Cmake in the
`vk_raytracing_tutorial_KHR` directory.
**_Note_**: If you are using your own Vulkan header files, it is possible to overide the default search path.
Modify `VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR` to the path to beta vulkan headers.
## Starting From Extra Tutorial
All _extra_ tutorials are starting from the end result of the _first tutorial_. The directory of the _extra_ tutorials is the end result of doing it.
To start the tutorial from the begining.
* Make a copy of the ray_tutorial__simple (backup)
* Follow the tutorial by modifying ray_tutorial__simple