From 15b30e7bd155b37d62f89258de97e30ccc71763f Mon Sep 17 00:00:00 2001 From: mklefrancois <38076163+mklefrancois@users.noreply.github.com> Date: Wed, 2 Sep 2020 15:57:42 +0200 Subject: [PATCH] Fixing note --- docs/setup.md | 2 +- ray_tracing_animation/README.md | 4 ++-- ray_tracing_anyhit/README.md | 8 ++++---- ray_tracing_gltf/README.md | 4 ++-- ray_tracing_instances/README.md | 2 +- ray_tracing_intersection/README.md | 2 +- ray_tracing_manyhits/README.md | 8 ++++---- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index d146e70..55d1f15 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -44,7 +44,7 @@ Vulkan driver. 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. +:warning: **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 diff --git a/ray_tracing_animation/README.md b/ray_tracing_animation/README.md index 5a060bf..e8c89c2 100644 --- a/ray_tracing_animation/README.md +++ b/ray_tracing_animation/README.md @@ -82,7 +82,7 @@ Next, we update the buffer that describes the scene, which is used by the raster } ~~~~ -**Note**: +:warning: **Note:** We could have used `cmdBuf.updateBuffer(m_sceneDesc.buffer, 0, m_objInstance)` to update the buffer, but this function only works for buffers with less than 65,536 bytes. If we had 2000 Wuson models, this call wouldn't work. @@ -490,7 +490,7 @@ In the rendering loop, after the call to `animationInstances`, call the object a helloVk.animationObject(diff.count()); ~~~~ -**Note**: At this point, the object should be animated when using the rasterizer, but should still be immobile when using the ray tracer. +:warning: **Note:** At this point, the object should be animated when using the rasterizer, but should still be immobile when using the ray tracer. diff --git a/ray_tracing_anyhit/README.md b/ray_tracing_anyhit/README.md index c9f5f43..1365641 100644 --- a/ray_tracing_anyhit/README.md +++ b/ray_tracing_anyhit/README.md @@ -17,7 +17,7 @@ The any hit shader can be useful for discarding intersections, such as for alpha used for simple transparency. In this example we will show what is needed to do to add this shader type and to create a transparency effect. -**Note** +:warning: **Note:** This example is based on many elements from the [Antialiasing Tutorial](vkrt_tuto_jitter_cam.md.htm). @@ -49,7 +49,7 @@ layout(binding = 1, set = 1, scalar) buffer MatColorBufferObject { WaveFrontMate // clang-format on ~~~~ -**Note** +:warning: **Note:** You can find the source of `random.glsl` in the Antialiasing Tutorial [here](../ray_tracing_jitter_cam/README.md#toc1.1). @@ -259,7 +259,7 @@ And we need to add the following to the ray tracing pipeline, a copy of the prev Create two new files `raytrace_0.ahit` and `raytrace_1.ahit`, and rename `raytrace.ahit` to `raytrace_ahit.glsl` -**! _WARNING_ !** +:warning: **Note:** Cmake need to be re-run to add the new files to the project. In `raytrace_0.ahit` add the following code @@ -390,7 +390,7 @@ m_rtShaderGroups.push_back(hg); At the end of the function, delete the shader module `ahit1SM`. -**NOTE** Re-Run +:warning: **Note:** Re-Run Everything should work as before, but now it does it right. diff --git a/ray_tracing_gltf/README.md b/ray_tracing_gltf/README.md index 255f01f..857d2ba 100644 --- a/ray_tracing_gltf/README.md +++ b/ray_tracing_gltf/README.md @@ -497,7 +497,7 @@ First initialize the `payload` and variable to compute the accumulation. Now the loop over the trace function, will be like the following. -**Note:** the depth is hardcode, but could be a parameter to the `push constant`. +:warning: **Note:** the depth is hardcode, but could be a parameter to the `push constant`. ~~~~C for(; prd.depth < 10; prd.depth++) @@ -520,6 +520,6 @@ Now the loop over the trace function, will be like the following. } ~~~~ -**Note:** do not forget to use `hitValue` in the `imageStore`. +:warning: **Note:** do not forget to use `hitValue` in the `imageStore`. diff --git a/ray_tracing_instances/README.md b/ray_tracing_instances/README.md index 87e2fe7..4b47ce6 100644 --- a/ray_tracing_instances/README.md +++ b/ray_tracing_instances/README.md @@ -55,7 +55,7 @@ Then replace the calls to `helloVk.loadModel` in `main()` by } ~~~~ -**Note:** +:warning: **Note:** This will create 3 models (OBJ) and their instances, and then add 2000 instances distributed between green cubes and cubes with one color per face. diff --git a/ray_tracing_intersection/README.md b/ray_tracing_intersection/README.md index 4a40056..8eb8428 100644 --- a/ray_tracing_intersection/README.md +++ b/ray_tracing_intersection/README.md @@ -194,7 +194,7 @@ In `main.cpp`, where we are loading the OBJ model, we can replace it with helloVk.createSpheres(); ~~~~ -**Note**: it is possible to have more OBJ models, but the spheres will need to be added after all of them. +:warning: **Note:** it is possible to have more OBJ models, but the spheres will need to be added after all of them. The scene will be large, better to move the camera out diff --git a/ray_tracing_manyhits/README.md b/ray_tracing_manyhits/README.md index 3ae4fbe..89c2952 100644 --- a/ray_tracing_manyhits/README.md +++ b/ray_tracing_manyhits/README.md @@ -103,7 +103,7 @@ struct sceneDesc }; ~~~~ -**Warning:** +:warning: **Note:** The solution will not automatically recompile the shaders after this change to `wavefront.glsl`; instead, you will need to recompile all of the SPIR-V shaders. ### `hello_vulkan.cpp` @@ -131,7 +131,7 @@ When creating the [Shader Binding Table](https://www.khronos.org/registry/vulkan This information can be used to pass extra information to a shader, for each entry in the SBT. -**Note:** +:warning: **Note:** Since each entry in an SBT group must have the same size, each entry of the group has to have enough space to accommodate the largest element in the entire group. The following diagram represents our current SBT, with the addition of some data to `HitGroup1`. As mentioned in the **note**, even if @@ -184,7 +184,7 @@ void main() } ~~~~ -**Note** +:warning: **Note:** Adding a new shader requires to rerun CMake to added to the project compilation system. @@ -335,7 +335,7 @@ Finally, we need to add the new entry as well at the end of the buffer, reusing pBuffer += hitSize; ~~~~ -** Warning**: +:warning: **Note:** Adding entries like this can be error-prone and inconvenient for decent scene sizes. Instead, it is recommended to wrap the storage of handles, data, and size per group in a SBT utility to handle this automatically.