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

Fixing documentation

Browse source
This commit is contained in:
mklefrancois 2020-04-01 14:35:18 +02:00
parent 95912b873b
commit c7ead98e45
3 changed files with 36 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/setup.md.html
View file

@ -2,8 +2,20 @@
# Environment Setup # Environment Setup
To get support for `VK_KHR_ray_tracing`, please install an [Vulkan NVIDIA driver](https://developer.nvidia.com/vulkan-driver) ## Beta Installation
with version 442.81 or later, and the [Vulkan SDK](http://vulkan.lunarg.com/sdk/home) version 1.2.136.0 or later.
If you are in the Beta period, install and compile all of the following
* Latest driver: https://developer.nvidia.com/vulkan-driver
* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
* Latest glslangValidator: https://github.com/KhronosGroup/glslang
!!! Warning Beta
Copy/replace `glslangValidator.exe` in the VulkanSDK bin directory.<br>
Ex: `C:\VulkanSDK\1.2.131.1\Bin`
## Structure
This tutorial is a modification of [`ray_tracing__simple`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__simple), which is the result of the ray tracing tutorial. This tutorial is a modification of [`ray_tracing__simple`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__simple), which is the result of the ray tracing tutorial.
All following instructions are based on the modification of this project. All following instructions are based on the modification of this project.
@ -27,25 +39,18 @@ The directory structure should be looking like:
* | +-- 📂 ray_tracing__simple (<-- Start here) * | +-- 📂 ray_tracing__simple (<-- Start here)
* | | * | |
* | +-- 📂 ray_tracing_... * | +-- 📂 ray_tracing_...
* | |
* | ⋮ * | ⋮
* | * |
* ⋮ * ⋮
********************************************************** **********************************************************
!!! Warning !!! Warning
**Run CMake** in vk_raytracing_tutorial. **Run CMake** in vk_raytracing_tutorial.
## Beta Installation !!! Warning Beta
Modify `VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR` to the path to beta vulkan headers.
If you are in the Beta period
* Latest driver: https://developer.nvidia.com/vulkan-driver
* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
* When running CMake, modify VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR to the path to beta vulkan headers.
Ex. under C:\Vulkan\Beta, copy the folder vulkan\ which contains all headers.
VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR should point to C:\Vulkan\Beta
<!-- Markdeep: --> <!-- Markdeep: -->

0
docs/vkrt_tuto_rayquery.htm → docs/vkrt_tuto_rayquery.md.htm
View file

32
docs/vkrt_tutorial.md.htm
View file

@ -33,10 +33,23 @@ verbosity and its potential for errors.
# Environment Setup # Environment Setup
To get support for `VK_KHR_ray_tracing`, please install an [NVIDIA driver](http://www.nvidia.com/Download/index.aspx?lang=en-us)
with version 440.97 or later, and the [Vulkan SDK](http://vulkan.lunarg.com/sdk/home) version 1.1.126.0 or later.
The tutorial is a modification of [`ray_tracing__before`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__before), which loads are render OBJ scenes with Vulkan rasterizer. ## Beta Installation
If you are in the Beta period, install and compile all of the following
* Latest driver: https://developer.nvidia.com/vulkan-driver
* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
* Latest glslangValidator: https://github.com/KhronosGroup/glslang
!!! Warning Beta
Copy/replace `glslangValidator.exe` in the VulkanSDK bin directory.<br>
Ex: `C:\VulkanSDK\1.2.131.1\Bin`
## Structure
This tutorial is a modification of [`ray_tracing__before`](https://github.com/nvpro-samples/vk_raytracing_tutorial/tree/master/ray_tracing__before), which loads are render OBJ scenes with Vulkan rasterizer.
All following instructions are based on the modification of this project. All following instructions are based on the modification of this project.
The directory `ray_tracing__simple` is the end result of this tutorial. The directory `ray_tracing__simple` is the end result of this tutorial.
@ -67,21 +80,14 @@ The directory structure should be looking like:
!!! Warning !!! Warning
**Run CMake** in vk_raytracing_tutorial. **Run CMake** in vk_raytracing_tutorial.
!!! Warning Beta
Modify `VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR` to the path to beta vulkan headers.
The starting project is a simple framework allowing us to load OBJ files and rasterize them The starting project is a simple framework allowing us to load OBJ files and rasterize them
using Vulkan. using Vulkan.
![First Run](Images/resultRasterCube.png width="350px") ![First Run](Images/resultRasterCube.png width="350px")
## Beta Installation
If you are in the Beta period
* Latest driver: https://developer.nvidia.com/vulkan-driver
* Latest Vulkan headers: https://github.com/KhronosGroup/Vulkan-Headers
* When running CMake, modify VULKAN > VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR to the path to beta vulkan headers.
Ex. under C:\Vulkan\Beta, copy the folder vulkan\ which contains all headers.
VULKAN_HEADERS_OVERRIDE_INCLUDE_DIR should point to C:\Vulkan\Beta
# Ray Tracing Setup # Ray Tracing Setup