Skip to content

Commit 5ba4840

Browse files
Documentation update
1 parent 11e7fad commit 5ba4840

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

.github/cache.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"improve/android-app-sleep": "3f6db653442c03e14c4877a9ecd7acfb5fcacf9c",
1111
"jdl/bundle-instance-data-abstraction": "8ad7eb52217ffabaf20adc37b7465efcdb959c12",
1212
"jdl/csharp-bindings": "823598c3ede755983ddfeb6bd352241c37d22572",
13-
"jdl/improve-buffer-performance": "c8b0ae7a14b6f619e2a7c9eb83a593651d3fd698",
13+
"jdl/improve-buffer-performance": "2b5df675d794c3cde8b5f8248ff71a1452832030",
1414
"jdl/resource_rewrite": "c894b8a566f18f3d6f339bdbf3f69b4a477ff2ad"
1515
},
1616
"generator": "017f4e1d4dcc5b5a5bb16dc1e243557b76b6250f",

docs/jdl/improve-buffer-performance/classcore_1_1ivk_1_1material__t.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ <h3>
487487
<h3>Brief</h3>
488488
<p>prepares the material for rendering by binding the pipeline.</p>
489489
<h3>Details</h3>
490-
<p><aside class="m-note m-danger"><h4>Warning</h4><p>only call this in the context of recording the draw call.</p></aside><aside class="m-note m-dim"><h4><a href="todo.html#_todo000008" class="m-doc">Todo</a></h4><p>drawindex is a temporary hack to support instancing. a generic solution should be sought after.</p></aside></p>
490+
<p><aside class="m-note m-danger"><h4>Warning</h4><p>only call this in the context of recording the draw call.</p></aside><aside class="m-note m-dim"><h4><a href="todo.html#_todo000007" class="m-doc">Todo</a></h4><p>drawindex is a temporary hack to support instancing. a generic solution should be sought after.</p></aside></p>
491491
<table class="m-table m-fullwidth m-flat">
492492
<thead>
493493
<tr><th colspan="2">Parameters</th></tr>

docs/jdl/improve-buffer-performance/classcore_1_1ivk_1_1pipeline.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ <h3>content</h3>
5555
<li><a href="#member-functions">member functions</a></li>
5656
</ul>
5757
</nav>
58-
<aside class="m-note m-danger"><h4>Warning</h4><p>calling the update method family <em>during</em> the recording of the vk::CommandBuffer&#x27;s will invalidate the command buffer</p></aside><aside class="m-note m-dim"><h4><a href="todo.html#_todo000007" class="m-doc">Todo</a></h4><p>find a solution around the warning</p></aside>
58+
<aside class="m-note m-danger"><h4>Warning</h4><p>calling the update method family <em>during</em> the recording of the vk::CommandBuffer&#x27;s will invalidate the command buffer</p></aside><aside class="m-note m-dim"><h4><a href="todo.html#_todo000008" class="m-doc">Todo</a></h4><p>find a solution around the warning</p></aside>
5959
<section id="typeless-methods">
6060
<h2><a href="#typeless-methods">constructors, destructors, conversion operators</a></h2>
6161
<dl class="m-doc">

docs/jdl/improve-buffer-performance/todo.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<h1>
4747
Todo List
4848
</h1>
49-
<dl class="m-doc"><dt>Class <a href="classcore_1_1data_1_1buffer__t.html" class="m-doc">core::<wbr />data::<wbr />buffer_t</a></dt><dd><a name="_todo000001"></a> figure out a way around incompatible <a href="classcore_1_1data_1_1buffer__t.html" class="m-doc">core::<wbr />data::<wbr />buffer_t</a> setups, perhaps by using structs to construct the class.</dd><dt>Class <a href="classcore_1_1data_1_1geometry__t.html" class="m-doc">core::<wbr />data::<wbr />geometry_t</a></dt><dd><p><a name="_todo000003"></a>write an example of a custom stream.</p><p>support numbered streams (i.e. UV0, UV1, etc..).</p></dd><dt>Member <a href="classcore_1_1data_1_1sampler__t.html#ace67337e9b24c8dd56a522d32f77ca70" class="m-doc">core::<wbr />data::<wbr />sampler_t::<wbr />mip_maxlod</a> () const</dt><dd><a name="_todo000004"></a>this value is currently ignored in core::core::ivk::sampler_t.</dd><dt>Member <a href="classcore_1_1ivk_1_1material__t.html#a0f05c71f5b90524760861509d3e8b7a1" class="m-doc">core::<wbr />ivk::<wbr />material_t::<wbr />bind_pipeline</a> (vk::CommandBuffer cmdBuffer, core::resource::handle&lt;core::ivk::framebuffer_t&gt; framebuffer, uint32_t drawIndex)</dt><dd><a name="_todo000008"></a>drawindex is a temporary hack to support instancing. a generic solution should be sought after.</dd><dt>Class <a href="classcore_1_1ivk_1_1pipeline.html" class="m-doc">core::<wbr />ivk::<wbr />pipeline</a></dt><dd><a name="_todo000007"></a>find a solution around the warning</dd><dt>Class <a href="classcore_1_1meta_1_1shader.html" class="m-doc">core::<wbr />meta::<wbr />shader</a></dt><dd><a name="_todo000005"></a>add a way to deal with push_constants</dd><dt>Class <a href="structcore_1_1resource_1_1metadata.html" class="m-doc">core::<wbr />resource::<wbr />metadata</a></dt><dd><a name="_todo000006"></a>check multi-cache</dd><dt>Member <a href="data_2geometry_8hpp.html#a30de94fca286c8885632a530c0ccd344" class="m-doc">MAX_<wbr />BONE_<wbr />WEIGHTS</a></dt><dd><a name="_todo000002"></a>implement a more robust system for this.</dd><dt>Member <a href="structpsl_1_1details_1_1print__t.html#afaf3fcdd162227c61608fd243f0d444b" class="m-doc">psl::<wbr />details::<wbr />print_t&lt;Args&gt;::<wbr />print_t</a> (level_t level, const char*fmt, Args &amp;&amp; ... args, const std::source_location&amp;loc=std::source_location::current())</dt><dd><a name="_todo000011"></a>When Android implements source_location, remove the ifdefs and migrate to source_location</dd><dt>Class <a href="classpsl_1_1serialization_1_1details_1_1anonymous__property.html" class="m-doc">psl::<wbr />serialization::<wbr />details::<wbr />anonymous_property&lt;T&gt;</a></dt><dd><a name="_todo000018"></a>add overloads for <a href="classpsl_1_1serialization_1_1details_1_1anonymous__property.html" class="m-doc">anonymous_<wbr />property</a> interacting with other <a href="classpsl_1_1serialization_1_1details_1_1anonymous__property.html" class="m-doc">anonymous_<wbr />property</a>&#x27;s</dd><dt>Member <a href="classpsl_1_1spmc_1_1producer.html#a11cdadc6ac76979d33eee5cb7f7284f3" class="m-doc">psl::<wbr />spmc::<wbr />producer&lt;T&gt;::<wbr />push</a> (T &amp;&amp; value)</dt><dd><a name="_todo000012"></a>Implement the backing storage as an atomic&lt;shared_ptr&lt;buffer&gt;&gt; for more logical cleanup flow.</dd><dt>Member <a href="namespacepsl.html#aa3d7f3935f8b5887a467c2c8b3d43ffc" class="m-doc">psl::<wbr />to_underlying</a> (T value) noexcept -&gt; std::underlying_type_t&lt;T&gt;</dt><dd><a name="_todo000019"></a>when android supports this remove</dd><dt>Member <a href="namespacepsl_1_1utility_1_1application_1_1path.html#a8c916507303dc1b3236a0b12c9cfd99e" class="m-doc">psl::<wbr />utility::<wbr />application::<wbr />path::<wbr />get_path</a> ()</dt><dd><a name="_todo000010"></a>check if returning an empty path for android is correct behaviour.</dd><dt>Member <a href="classpsl_1_1utility_1_1platform_1_1directory.html#aecf4e1221f2cee2b12a3d17b128b9fbf" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />directory::<wbr />all_files</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> target_directory, bool recursive)</dt><dd><a name="_todo000015"></a>on android no search is run.</dd><dt>Member <a href="classpsl_1_1utility_1_1platform_1_1directory.html#a23423cf9b8caf77482fb55333407744a" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />directory::<wbr />erase</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> path)</dt><dd><a name="_todo000014"></a>android platform always fails this, is it possible this is not always the case?</dd><dt>Member <a href="classpsl_1_1utility_1_1platform_1_1directory.html#acfc3697c05c46ed245d512184ebd864a" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />directory::<wbr />is_directory</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> path)</dt><dd><a name="_todo000013"></a>android platform always returns false. Check if there is a way around this or redesign this.</dd><dt>Member <a href="namespacepsl_1_1utility_1_1platform_1_1file.html#a8f9e68769fc420bd5fc605eee8894368" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />file::<wbr />erase</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> filename)</dt><dd><a name="_todo000017"></a>android lacks an implementation.</dd><dt>Member <a href="namespacepsl_1_1utility_1_1platform_1_1file.html#ae04325015959b72e083779ed43ae7167" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />file::<wbr />exists</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> filename)</dt><dd><a name="_todo000016"></a>android lacks an implementation.</dd></dl>
49+
<dl class="m-doc"><dt>Class <a href="classcore_1_1data_1_1buffer__t.html" class="m-doc">core::<wbr />data::<wbr />buffer_t</a></dt><dd><a name="_todo000001"></a> figure out a way around incompatible <a href="classcore_1_1data_1_1buffer__t.html" class="m-doc">core::<wbr />data::<wbr />buffer_t</a> setups, perhaps by using structs to construct the class.</dd><dt>Class <a href="classcore_1_1data_1_1geometry__t.html" class="m-doc">core::<wbr />data::<wbr />geometry_t</a></dt><dd><p><a name="_todo000003"></a>write an example of a custom stream.</p><p>support numbered streams (i.e. UV0, UV1, etc..).</p></dd><dt>Member <a href="classcore_1_1data_1_1sampler__t.html#ace67337e9b24c8dd56a522d32f77ca70" class="m-doc">core::<wbr />data::<wbr />sampler_t::<wbr />mip_maxlod</a> () const</dt><dd><a name="_todo000004"></a>this value is currently ignored in core::core::ivk::sampler_t.</dd><dt>Member <a href="classcore_1_1ivk_1_1material__t.html#a0f05c71f5b90524760861509d3e8b7a1" class="m-doc">core::<wbr />ivk::<wbr />material_t::<wbr />bind_pipeline</a> (vk::CommandBuffer cmdBuffer, core::resource::handle&lt;core::ivk::framebuffer_t&gt; framebuffer, uint32_t drawIndex)</dt><dd><a name="_todo000007"></a>drawindex is a temporary hack to support instancing. a generic solution should be sought after.</dd><dt>Class <a href="classcore_1_1ivk_1_1pipeline.html" class="m-doc">core::<wbr />ivk::<wbr />pipeline</a></dt><dd><a name="_todo000008"></a>find a solution around the warning</dd><dt>Class <a href="classcore_1_1meta_1_1shader.html" class="m-doc">core::<wbr />meta::<wbr />shader</a></dt><dd><a name="_todo000005"></a>add a way to deal with push_constants</dd><dt>Class <a href="structcore_1_1resource_1_1metadata.html" class="m-doc">core::<wbr />resource::<wbr />metadata</a></dt><dd><a name="_todo000006"></a>check multi-cache</dd><dt>Member <a href="data_2geometry_8hpp.html#a30de94fca286c8885632a530c0ccd344" class="m-doc">MAX_<wbr />BONE_<wbr />WEIGHTS</a></dt><dd><a name="_todo000002"></a>implement a more robust system for this.</dd><dt>Member <a href="structpsl_1_1details_1_1print__t.html#afaf3fcdd162227c61608fd243f0d444b" class="m-doc">psl::<wbr />details::<wbr />print_t&lt;Args&gt;::<wbr />print_t</a> (level_t level, const char*fmt, Args &amp;&amp; ... args, const std::source_location&amp;loc=std::source_location::current())</dt><dd><a name="_todo000011"></a>When Android implements source_location, remove the ifdefs and migrate to source_location</dd><dt>Class <a href="classpsl_1_1serialization_1_1details_1_1anonymous__property.html" class="m-doc">psl::<wbr />serialization::<wbr />details::<wbr />anonymous_property&lt;T&gt;</a></dt><dd><a name="_todo000018"></a>add overloads for <a href="classpsl_1_1serialization_1_1details_1_1anonymous__property.html" class="m-doc">anonymous_<wbr />property</a> interacting with other <a href="classpsl_1_1serialization_1_1details_1_1anonymous__property.html" class="m-doc">anonymous_<wbr />property</a>&#x27;s</dd><dt>Member <a href="classpsl_1_1spmc_1_1producer.html#a11cdadc6ac76979d33eee5cb7f7284f3" class="m-doc">psl::<wbr />spmc::<wbr />producer&lt;T&gt;::<wbr />push</a> (T &amp;&amp; value)</dt><dd><a name="_todo000012"></a>Implement the backing storage as an atomic&lt;shared_ptr&lt;buffer&gt;&gt; for more logical cleanup flow.</dd><dt>Member <a href="namespacepsl.html#aa3d7f3935f8b5887a467c2c8b3d43ffc" class="m-doc">psl::<wbr />to_underlying</a> (T value) noexcept -&gt; std::underlying_type_t&lt;T&gt;</dt><dd><a name="_todo000019"></a>when android supports this remove</dd><dt>Member <a href="namespacepsl_1_1utility_1_1application_1_1path.html#a8c916507303dc1b3236a0b12c9cfd99e" class="m-doc">psl::<wbr />utility::<wbr />application::<wbr />path::<wbr />get_path</a> ()</dt><dd><a name="_todo000010"></a>check if returning an empty path for android is correct behaviour.</dd><dt>Member <a href="classpsl_1_1utility_1_1platform_1_1directory.html#aecf4e1221f2cee2b12a3d17b128b9fbf" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />directory::<wbr />all_files</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> target_directory, bool recursive)</dt><dd><a name="_todo000015"></a>on android no search is run.</dd><dt>Member <a href="classpsl_1_1utility_1_1platform_1_1directory.html#a23423cf9b8caf77482fb55333407744a" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />directory::<wbr />erase</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> path)</dt><dd><a name="_todo000014"></a>android platform always fails this, is it possible this is not always the case?</dd><dt>Member <a href="classpsl_1_1utility_1_1platform_1_1directory.html#acfc3697c05c46ed245d512184ebd864a" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />directory::<wbr />is_directory</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> path)</dt><dd><a name="_todo000013"></a>android platform always returns false. Check if there is a way around this or redesign this.</dd><dt>Member <a href="namespacepsl_1_1utility_1_1platform_1_1file.html#a8f9e68769fc420bd5fc605eee8894368" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />file::<wbr />erase</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> filename)</dt><dd><a name="_todo000017"></a>android lacks an implementation.</dd><dt>Member <a href="namespacepsl_1_1utility_1_1platform_1_1file.html#ae04325015959b72e083779ed43ae7167" class="m-doc">psl::<wbr />utility::<wbr />platform::<wbr />file::<wbr />exists</a> (<a href="namespacepsl.html#a410ffef54619c8dff3cdf8bd46755632" class="m-doc">psl::<wbr />string_view</a> filename)</dt><dd><a name="_todo000016"></a>android lacks an implementation.</dd></dl>
5050
</div>
5151
</div>
5252
</div>

0 commit comments

Comments
 (0)