Update documentation

yaul-org · Nov 14, 2023 · fc584bf · fc584bf
1 parent da64860
commit fc584bf
Showing 1 changed file with 38 additions and 2 deletions.
diff --git a/html/group__MIC3D__INIT__CONFIG.html b/html/group__MIC3D__INIT__CONFIG.html
@@ -141,8 +141,44 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga13fe261c35cf933ff181445
 </div><div class="memdoc">
 
 <p>Initialize Mic3D. </p>
-<p>Not yet documented.</p>
-<div class="fragment"></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
+<p>Not yet documented. Not idempotent.</p>
+<p>Below is an example of how to initialize Mic3D: </p><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__depth__values">workarea_mic3d_depth_values_t</a> _pool_depth_values;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__z__values">workarea_mic3d_z_values_t</a> _pool_z_values;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__screen__points">workarea_mic3d_screen_points_t</a> _pool_screen_points;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__sort__singles">workarea_mic3d_sort_singles_t</a> _pool_sort_singles;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__cmdts">workarea_mic3d_cmdts_t</a> _pool_cmdts;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__render__matrices">workarea_mic3d_render_matrices_t</a> _pool_render_matrices;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__light__matrices">workarea_mic3d_light_matrices_t</a> _pool_light_matrices;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__colors">workarea_mic3d_colors_t</a> _pool_colors;</div>
+<div class="line"><span class="keyword">static</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__work">workarea_mic3d_work_t</a> _pool_work;</div>
+<div class="line"> </div>
+<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_struct" href="group__MIC3D__WORKAREA.html#structworkarea__mic3d">workarea_mic3d_t</a> _workarea = {</div>
+<div class="line">    &amp;_pool_depth_values,</div>
+<div class="line">    &amp;_pool_z_values,</div>
+<div class="line">    &amp;_pool_screen_points,</div>
+<div class="line">    &amp;_pool_sort_singles,</div>
+<div class="line">    &amp;_pool_cmdts,</div>
+<div class="line">    &amp;_pool_render_matrices,</div>
+<div class="line">    &amp;_pool_light_matrices,</div>
+<div class="line">    &amp;_pool_colors,</div>
+<div class="line">    &amp;_pool_work</div>
+<div class="line">};</div>
+<div class="line"> </div>
+<div class="line"><span class="comment">// ...</span></div>
+<div class="line"><a class="code hl_function" href="group__MIC3D__INIT__CONFIG.html#ga13fe261c35cf933ff181445f00d9ba12">mic3d_init</a>(&amp;_workarea);</div>
+<div class="line"><span class="comment">// ...</span></div>
+<div class="ttc" id="agroup__MIC3D__INIT__CONFIG_html_ga13fe261c35cf933ff181445f00d9ba12"><div class="ttname"><a href="group__MIC3D__INIT__CONFIG.html#ga13fe261c35cf933ff181445f00d9ba12">mic3d_init</a></div><div class="ttdeci">void mic3d_init(workarea_mic3d_t *workarea)</div><div class="ttdoc">Initialize Mic3D.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d">workarea_mic3d</a></div><div class="ttdoc">Work area defined, needed for library.</div><div class="ttdef"><b>Definition:</b> workarea.h:118</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__cmdts"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__cmdts">workarea_mic3d_cmdts</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__colors"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__colors">workarea_mic3d_colors</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__depth__values"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__depth__values">workarea_mic3d_depth_values</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__light__matrices"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__light__matrices">workarea_mic3d_light_matrices</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__render__matrices"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__render__matrices">workarea_mic3d_render_matrices</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__screen__points"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__screen__points">workarea_mic3d_screen_points</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__sort__singles"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__sort__singles">workarea_mic3d_sort_singles</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__work"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__work">workarea_mic3d_work</a></div><div class="ttdoc">Not yet documented.</div></div>
+<div class="ttc" id="agroup__MIC3D__WORKAREA_html_structworkarea__mic3d__z__values"><div class="ttname"><a href="group__MIC3D__WORKAREA.html#structworkarea__mic3d__z__values">workarea_mic3d_z_values</a></div><div class="ttdoc">Not yet documented.</div></div>
+</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">workarea</td><td></td></tr>
   </table>