commit 44b3cfed2a86fe93a975c8cdeed229a4c72d3443
parent ff33462d42aa1df7940e91d2f4c40d7c28718dc8
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 15 May 2019 10:15:17 +0200
Write the Star-3D html template
Diffstat:
1 file changed, 43 insertions(+), 0 deletions(-)
diff --git a/star-engine/star-3d.html.in b/star-engine/star-3d.html.in
@@ -0,0 +1,43 @@
+<header>
+ <h1>Star-3D</h1>
+</header>
+
+<p>The Star-3D library <b>manages surfacic geometries</b> and provides
+operators to access them efficiently like <b>uniform sampling</b> or
+<b>ray-tracing</b>. To ensure high ray-tracing efficiency, Star-3D internally
+relies on <a
+href="https://software.intel.com/en-us/rendering-framework">Intel(R) Rendering
+Framework]():</a><a href=https://embree.github.io>Embree</a> that provides
+highly optimized ray-tracing kernels for a wide range of data workloads. The
+main target of Star-3D are programmers that want to efficiently handle
+<b>complex and arbitrary 3D content</b>.</p>
+
+<p>The main concept exposed in Star-3D is the <b>shape</b>. A shape represents a
+3D object such as a triangular mesh or a sphere, whose data are user defined
+and can be updated at any time. A virtual environment is built by attaching one
+or several shapes to a <b>scene</b>. A scene can be <b>instantiated</b> into
+one or several shapes that can be then attached to a scene as any regular
+shapes. Each instance has its own position and orientation while the
+instantiated geometry is stored once even though it is instantiated several
+times. This feature can thus be used to create extremely complex environment
+with a low memory footprint.</p>
+
+<p>To access the scene data through uniform sampling or ray-tracing, one has to
+create a <b>view</b> of the scene. On its creation, the view internally builds
+data structures required by the aforementionned access operators. This data
+structure are built from the scene geometry as defined at the moment of the
+view creation; a view is thus insensitive to scene updates following its
+creation. This means that several views can be used to register different
+state of the same scene, giving to the caller a great flexibility to manage the
+scene data.</p>
+
+${RELEASE_NOTES}
+
+<h2>License</h2>
+
+<p>Copyright © 2015-2019 <a
+href="https://www.meso-star.com">|Meso|Star>.</a> Star-3D is free software
+released under CeCILL v2.1 license. You are also welcome to redistribute it
+under certain conditions; refer to the <a
+href="https://cecill.info/licences/Licence_CeCILL_V2.1-en.html">license</a> for
+details.</p>