Updated documentation (#996)

docs/index.md

@@ -134,16 +134,22 @@ Yocto/GL depends on `stb_image.h`, `stb_image_write.h`, `stb_image_resize.h` and
 for glTF and JSON support, and `filesystem.hpp` to support C++17 filesystem API
 when missing. All dependencies are included in the distribution.
 
-We optionally support building OpenGL demos, which are handled by including
-glad, GLFW, ImGui as dependecies in apps. OpenGL support might eventually
+Yocto/GL optionally supports building OpenGL demos, which are handled by including
+glad, GLFW, ImGui as dependencies in apps. OpenGL support might eventually
 become part of the Yocto/GL libraries. OpenGL support is enabled by defining
 the cmake option `YOCTO_OPENGL` and contained in the `yocto_gui` library.
 
-Finally, we optionally support the use of Intel's Embree for ray casting.
-At this point, we rely pon prebuilt binaries distributed by Intel.
+Yocto/GL optionally supports the use of Intel's Embree for ray casting.
+At this point, we rely on prebuilt binaries distributed by Intel.
 See the main CMake file for how to link to it. Embree support is enabled by
 defining the cmake option `YOCTO_EMBREE`.
 
+Yocto/GL optionally supports the use of Intel's Open Image Denoise for denoising
+renders. At this point, we rely on prebuilt binaries distributed by Intel.
+See the main CMake file for how to link to it. Open Image Denoise support is enabled by
+defining the cmake option `YOCTO_DENOISE`. See `apps/yimagedenoise` for
+a demonstration.
+
 <!--
 
 <style type="text/css">

docs/yocto/yocto_bvh.md

@@ -6,6 +6,7 @@ Yocto/Bvh is implemented in `yocto_bvh.h` and `yocto_bvh.cpp`.
 
 **This library is experimental** and will be documented appropriately when
 the code reaches stability.
+For now, use the [Yocto/Scene](yocto_scene.md) support for this.
 
 <!--
 

libs/yocto/yocto_bvh.h

@@ -4,7 +4,7 @@
 // Yocto/Bvh provides ray-intersection and point-overlap queries accelerated
 // by a two-level BVH using an internal or wrapping Embree.
 // Yocto/Bvh is implemented in `yocto_bvh.h` and `yocto_bvh.cpp`.
-//
+// For now, use the Yocto/Scene support for this.
 
 //
 // LICENSE:

mkdocs.yml

@@ -35,6 +35,7 @@ nav:
   - Image utilities: yocto/yocto_image.md
   - Shape utilities: yocto/yocto_shape.md
   - Mesh processing: yocto/yocto_mesh.md
+  - Ray-scene intersection: yocto/yocto_bvh.md
   - Model serialization: yocto/yocto_modelio.md
   - Scene representation: yocto/yocto_scene.md
   - Scene serialization: yocto/yocto_sceneio.md

readme.md

@@ -132,20 +132,18 @@ Yocto/GL depends on `stb_image.h`, `stb_image_write.h`, `stb_image_resize.h` and
 for glTF and JSON support, and `filesystem.hpp` to support C++17 filesystem API
 when missing. All dependencies are included in the distribution.
 
-We optionally support building OpenGL demos, which are handled by including
-glad, GLFW, ImGui as dependecies in apps. OpenGL support might eventually
+Yocto/GL optionally supports building OpenGL demos, which are handled by including
+glad, GLFW, ImGui as dependencies in apps. OpenGL support might eventually
 become part of the Yocto/GL libraries. OpenGL support is enabled by defining
 the cmake option `YOCTO_OPENGL` and contained in the `yocto_gui` library.
 
-Furthermore, by defining the cmake option YOCTO_DENOISE, we support building
-an app and a corresponding library that integrates Intel Open Image Denoise
-(see `apps/yimagedenoise`, `libs/yocto_denoise`). The Intel Open Image Denoise
-library is provided as a git submodule in `libs/yocto_denoise/ext`, so,
-when building with this option enabled, one must ensure that all the dependencies
-of Intel Open Image Denoise are installed on the host machine. See the [OIDN compilation instructions](https://github.com/OpenImageDenoise/oidn/blob/master/README.md)
-for more information.
-
-Finally, we optionally support the use of Intel's Embree for ray casting.
+Yocto/GL optionally supports the use of Intel's Embree for ray casting.
 At this point, we rely on prebuilt binaries distributed by Intel.
 See the main CMake file for how to link to it. Embree support is enabled by
 defining the cmake option `YOCTO_EMBREE`.
+
+Yocto/GL optionally supports the use of Intel's Open Image Denoise for denoising
+renders. At this point, we rely on prebuilt binaries distributed by Intel.
+See the main CMake file for how to link to it. Open Image Denoise support is enabled by
+defining the cmake option `YOCTO_DENOISE`. See `apps/yimagedenoise` for
+a demonstration.