From 444f011a437174bea86c0134ed0c983231e7967b Mon Sep 17 00:00:00 2001 From: mklefrancois <38076163+mklefrancois@users.noreply.github.com> Date: Mon, 31 Aug 2020 17:06:59 +0200 Subject: [PATCH] Update Documentation --- docs/vkrt_tutorial.md.htm | 2 -- ray_tracing_animation/README.md | 6 +++--- ray_tracing_anyhit/README.md | 4 ++-- ray_tracing_callable/README.md | 2 +- ray_tracing_instances/README.md | 4 ++-- ray_tracing_jitter_cam/README.md | 2 +- ray_tracing_manyhits/README.md | 8 ++++---- ray_tracing_reflections/README.md | 2 +- 8 files changed, 14 insertions(+), 16 deletions(-) diff --git a/docs/vkrt_tutorial.md.htm b/docs/vkrt_tutorial.md.htm index ad874f0..d4fa7f0 100644 --- a/docs/vkrt_tutorial.md.htm +++ b/docs/vkrt_tutorial.md.htm @@ -2018,8 +2018,6 @@ with more advanced ray tracing based algorithms. -(insert vkrt_tuto_further.md.html here) - ---- diff --git a/ray_tracing_animation/README.md b/ray_tracing_animation/README.md index d61fb9c..5a060bf 100644 --- a/ray_tracing_animation/README.md +++ b/ray_tracing_animation/README.md @@ -1,6 +1,6 @@ # Ray Tracing Animation - Tutorial -![](Images/animation2.gif) +![](images/animation2.gif) ## Tutorial ([Setup](../docs/setup.md)) @@ -156,7 +156,7 @@ The last point is to call the update at the end of the function. m_rtBuilder.updateTlasMatrices(m_tlas); ~~~~ -![](Images/animation1.gif) +![](images/animation1.gif) ### nvvk::RaytracingBuilder::updateTlasMatrices (Implementation) @@ -592,4 +592,4 @@ Finally, we can add a line at the end of `HelloVulkan::animationObject()` to upd m_rtBuilder.updateBlas(2); ~~~~ -![](Images/animation2.gif) +![](images/animation2.gif) diff --git a/ray_tracing_anyhit/README.md b/ray_tracing_anyhit/README.md index a8727a5..c9f5f43 100644 --- a/ray_tracing_anyhit/README.md +++ b/ray_tracing_anyhit/README.md @@ -248,11 +248,11 @@ any hit or intersection shaders in the Hit Group. But in this example, the close This is how the current SBT looks like. -![](Images/anyhit_0.png) +![](images/anyhit_0.png) And we need to add the following to the ray tracing pipeline, a copy of the previous Hit Group, with a new AnyHit using the proper payload. -![](Images/anyhit_01.png) +![](images/anyhit_01.png) ### New shaders diff --git a/ray_tracing_callable/README.md b/ray_tracing_callable/README.md index 84879f3..b190cc8 100644 --- a/ray_tracing_callable/README.md +++ b/ray_tracing_callable/README.md @@ -1,6 +1,6 @@ # Callable Shaders - Tutorial -![](Images/callable.png) +![](images/callable.png) Author: [Martin-Karl Lefrançois](https://devblogs.nvidia.com/author/mlefrancois/) ## Tutorial ([Setup](../docs/setup.md)) diff --git a/ray_tracing_instances/README.md b/ray_tracing_instances/README.md index f0f1269..87e2fe7 100644 --- a/ray_tracing_instances/README.md +++ b/ray_tracing_instances/README.md @@ -178,10 +178,10 @@ The VMA allocator need to be released in `HelloVulkan::destroyResources()` after Instead of thousands of allocations, our example will have only 14 allocations. Note that some of these allocations are allocated by Dear ImGui, and not by DMA. These are the 14 objects with blue borders below: -![Memory](Images/VkInstanceNsight1.png) +![Memory](images/VkInstanceNsight1.png) Finally, here is the Vulkan Device Memory view from Nsight Graphics: -![VkMemory](Images/VkInstanceNsight2.png) +![VkMemory](images/VkInstanceNsight2.png) diff --git a/ray_tracing_jitter_cam/README.md b/ray_tracing_jitter_cam/README.md index 85a374f..6612e71 100644 --- a/ray_tracing_jitter_cam/README.md +++ b/ray_tracing_jitter_cam/README.md @@ -1,6 +1,6 @@ # Jitter Camera - Tutorial -![](Images/antialiasing.png) +![](images/antialiasing.png) ## Tutorial ([Setup](../docs/setup.md)) diff --git a/ray_tracing_manyhits/README.md b/ray_tracing_manyhits/README.md index 8cb0985..3ae4fbe 100644 --- a/ray_tracing_manyhits/README.md +++ b/ray_tracing_manyhits/README.md @@ -1,6 +1,6 @@ # Multiple Closest Hit Shaders - Tutorial -![](Images/manyhits.png) +![](images/manyhits.png) ## Tutorial ([Setup](../docs/setup.md)) @@ -77,7 +77,7 @@ Then add a new hit group group immediately after adding the first hit group: As a test, you can try changing the `sbtRecordOffset` parameter of the `traceRayEXT` call in `raytrace.rgen`. If you set the offset to `1`, then all ray hits will use the new CHIT, and the raytraced output should look like the image below: -![](Images/manyhits2.png) +![](images/manyhits2.png) !!! Warning After testing this out, make sure to revert this change in `raytrace.rgen` before continuing. @@ -123,7 +123,7 @@ Back in `main.cpp`, after loading the scene's models, we can now have both `wuso helloVk.m_objInstance[1].hitgroup = 1; ~~~~ -![](Images/manyhits3.png) +![](images/manyhits3.png) ## Shader Record Data `shaderRecordKHR` @@ -277,7 +277,7 @@ ROUND_UP(m_rtProperties.shaderGroupHandleSize + sizeof(HitRecordBuffer), progOff !!! Note: The result should now show both `wuson` models with a yellow color. -![](Images/manyhits4.png) +![](images/manyhits4.png) ## Extending Hit diff --git a/ray_tracing_reflections/README.md b/ray_tracing_reflections/README.md index f279fc7..742be7c 100644 --- a/ray_tracing_reflections/README.md +++ b/ray_tracing_reflections/README.md @@ -1,6 +1,6 @@ # Reflections - Tutorial -![](Images/reflections.png) +![](images/reflections.png) ## Tutorial ([Setup](../docs/setup.md))