Skip to content

Commit c8704e6

Browse files
github-actions[bot]github-actions[bot]
committed
Documentation update
1 parent e83f092 commit c8704e6

File tree

6 files changed

+257
-5
lines changed

6 files changed

+257
-5
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/instance-data-sparse-array": "4df3e04bcd2ea5f82659c739c8d0e00c0a21a201",
13+
"jdl/instance-data-sparse-array": "d3d8cbff1eda0f077f87dcd46adbb70a51e4bd53",
1414
"jdl/resource_rewrite": "c894b8a566f18f3d6f339bdbf3f69b4a477ff2ad"
1515
},
1616
"generator": "017f4e1d4dcc5b5a5bb16dc1e243557b76b6250f",

‎docs/jdl/instance-data-sparse-array/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#_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>
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>
491491
<table class="m-table m-fullwidth m-flat">
492492
<thead>
493493
<tr><th colspan="2">Parameters</th></tr>

‎docs/jdl/instance-data-sparse-array/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#_todo000008" 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#_todo000007" 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/instance-data-sparse-array/searchdata-v2.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/jdl/instance-data-sparse-array/structcore_1_1gfx_1_1details_1_1instance_1_1storage__link.html‎

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<title>core::gfx::details::instance::storage_link struct | Paradigm Engine C++20 Rendering Library & Toolchain</title>
6+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
7+
<link rel="stylesheet" href="m-dark+documentation.compiled.css" />
8+
<link rel="icon" href="favicon-dark.png" type="image/png" />
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
10+
<meta name="theme-color" content="#22272e" />
11+
</head>
12+
<body>
13+
<header><nav id="navigation">
14+
<div class="m-container">
15+
<div class="m-row">
16+
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">Paradigm Engine <span class="m-thin">C++20 Rendering Library & Toolchain</span></a>
17+
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
18+
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
19+
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
20+
</svg></a>
21+
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
22+
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
23+
</div>
24+
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
25+
<div class="m-row">
26+
<ol class="m-col-t-6 m-col-m-none">
27+
<li><a href="pages.html">pages</a></li>
28+
<li><a href="namespaces.html">namespaces</a></li>
29+
</ol>
30+
<ol class="m-col-t-6 m-col-m-none" start="3">
31+
<li><a href="annotated.html">classes</a></li>
32+
<li><a href="files.html">files</a></li>
33+
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
34+
<use href="#m-doc-search-icon-path" />
35+
</svg></a></li><li style="line-height: 2.5rem;"><select name="branch/tag" id="ref-select" onchange="location = this.value;" style="border-width: 0 0 0.25rem 0;"><option value="../../jdl/instance-data-sparse-array/structcore_1_1gfx_1_1details_1_1instance_1_1storage__link.html">jdl/instance-data-sparse-array</option></select></li>
36+
</ol>
37+
</div>
38+
</div>
39+
</div>
40+
</div>
41+
</nav></header>
42+
<main><article>
43+
<div class="m-container m-container-inflatable">
44+
<div class="m-row">
45+
<div class="m-col-l-10 m-push-l-1">
46+
<h1>
47+
<span class="m-breadcrumb"><a href="namespacecore.html">core</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecore_1_1gfx.html">gfx</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecore_1_1gfx_1_1details.html">details</a>::<wbr/></span><span class="m-breadcrumb"><a href="namespacecore_1_1gfx_1_1details_1_1instance.html">instance</a>::<wbr/></span>storage_link <span class="m-thin">struct</span>
48+
</h1>
49+
<p>A link between a <a href="classcore_1_1gfx_1_1details_1_1instance_1_1gpu__storage__buffer.html" class="m-doc">gpu_<wbr />storage_<wbr />buffer</a> and the <a href="classcore_1_1gfx_1_1details_1_1instance_1_1geometry__instance__data.html" class="m-doc">geometry_<wbr />instance_<wbr />data</a> that owns it.</p>
50+
<p>This link is used to record commands that need to be executed on the gpu storage buffer. When the instance&#x27;s apply is invoked, it will consume the commands recorded in this link and execute them on the actual gpu buffer.</p><aside class="m-note m-danger"><h4>Warning</h4><p>This structure relies on implementation details of <a href="classpsl_1_1sparse__array.html" class="m-doc">psl::<wbr />sparse_array</a>.</p></aside>
51+
</div>
52+
</div>
53+
</div>
54+
</article></main>
55+
<div class="m-doc-search" id="search">
56+
<a href="#!" onclick="return hideSearch()"></a>
57+
<div class="m-container">
58+
<div class="m-row">
59+
<div class="m-col-m-8 m-push-m-2">
60+
<div class="m-doc-search-header m-text m-small">
61+
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
62+
<div id="search-symbolcount">&hellip;</div>
63+
</div>
64+
<div class="m-doc-search-content">
65+
<form>
66+
<input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
67+
</form>
68+
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
69+
<div id="search-help" class="m-text m-dim m-text-center">
70+
<p class="m-noindent">Search for symbols, directories, files, pages or
71+
modules. You can omit any prefix from the symbol or file path; adding a
72+
<code>:</code> or <code>/</code> suffix lists all members of given symbol or
73+
directory.</p>
74+
<p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
75+
/ <span class="m-label m-dim">&uarr;</span> to navigate through the list,
76+
<span class="m-label m-dim">Enter</span> to go.
77+
<span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
78+
copy a link to the result using <span class="m-label m-dim">⌘</span>
79+
<span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
80+
<span class="m-label m-dim">M</span> produces a Markdown link.</p>
81+
</div>
82+
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
83+
<ul id="search-results"></ul>
84+
</div>
85+
</div>
86+
</div>
87+
</div>
88+
</div>
89+
<script>
90+
var visibility_level = 1;
91+
function radio_visibility_toggle(value) {
92+
if(value.id === 'first_toggle' && value.checked) {
93+
visibility_level = 1;
94+
}
95+
else if(value.id === 'second_toggle' && value.checked) {
96+
visibility_level = 2;
97+
}
98+
else if(value.id === 'third_toggle' && value.checked) {
99+
visibility_level = 3;
100+
}
101+
else {
102+
return;
103+
}
104+
105+
update_visibility();
106+
}
107+
108+
function update_visibility()
109+
{
110+
localStorage.visibility_level = visibility_level;
111+
var private_elements = document.getElementsByClassName("private-visibility");
112+
var protected_elements = document.getElementsByClassName("protected-visibility");
113+
if (visibility_level == 1) {
114+
for (i = 0; i < protected_elements.length; i++) {
115+
protected_elements[i].style.display = "none";
116+
}
117+
for (i = 0; i < private_elements.length; i++) {
118+
private_elements[i].style.display = "none";
119+
}
120+
} else if (visibility_level == 2) {
121+
for (i = 0; i < protected_elements.length; i++) {
122+
protected_elements[i].style.display = "";
123+
}
124+
for (i = 0; i < private_elements.length; i++) {
125+
private_elements[i].style.display = "none";
126+
}
127+
} else if (visibility_level == 3) {
128+
for (i = 0; i < protected_elements.length; i++) {
129+
protected_elements[i].style.display = "";
130+
}
131+
for (i = 0; i < private_elements.length; i++) {
132+
private_elements[i].style.display = "";
133+
}
134+
}
135+
}
136+
137+
function load_image(target, url, map_id)
138+
{
139+
var img = document.createElement("img");
140+
var loc = url.match(/[^\/]+$/)[0];
141+
img.src = loc;
142+
img.alt = loc;
143+
img.style = "display: block;margin-left: auto;margin-right: auto;"
144+
img.useMap ="#localmap"
145+
target.appendChild(img);
146+
147+
if(map_id)
148+
{
149+
var file = document.location.href.replace(".html", "__inherit__graph.map");
150+
var class_tree = document.getElementById(map_id);
151+
class_tree.style = "";
152+
153+
var request = new XMLHttpRequest();
154+
request.open('GET', file, true);
155+
request.onreadystatechange = function(){
156+
if (request.readyState === 4){
157+
if (request.status === 200)
158+
{
159+
target.innerHTML += request.responseText;
160+
target.childNodes[1].name="localmap"
161+
var c = target.childNodes[1].childNodes;
162+
for (i = 1; i < c.length; i+=2) {
163+
c[i].href =c[i].href.replace("$", "");
164+
}
165+
}
166+
}
167+
};
168+
request.send();
169+
}
170+
}
171+
172+
function on_document_body_loaded()
173+
{
174+
if (localStorage.getItem("visibility_level") === null) {
175+
visibility_level = 1;
176+
}
177+
else
178+
{
179+
visibility_level =localStorage.visibility_level;
180+
}
181+
var first = document.getElementById('first_toggle');
182+
if(first != null) {
183+
first.checked = visibility_level == 1;
184+
var second = document.getElementById('second_toggle');
185+
second.checked = visibility_level == 2;
186+
var third = document.getElementById('third_toggle');
187+
third.checked = visibility_level == 3;
188+
update_visibility();
189+
}
190+
191+
var img_tag = document.getElementById("img_tag");
192+
if(img_tag != null)
193+
{
194+
var img = document.createElement("img");
195+
img.onload = function()
196+
{
197+
img.alt = loc;
198+
img.style = "display: block;margin-left: auto;margin-right: auto;";
199+
img.useMap ="#localmap";
200+
img_tag.appendChild(img);
201+
202+
var file = document.location.href.replace(".html", "__inherit__graph.map");
203+
var class_tree = document.getElementById("class-tree");
204+
class_tree.style = "";
205+
206+
var request = new XMLHttpRequest();
207+
request.open('GET', file, true);
208+
request.onreadystatechange = function(){
209+
if (request.readyState === 4){
210+
if (request.status === 200)
211+
{
212+
img_tag.innerHTML += request.responseText;
213+
img_tag.childNodes[1].name="localmap"
214+
var c = img_tag.childNodes[1].childNodes;
215+
for (i = 1; i < c.length; i+=2) {
216+
c[i].href =c[i].href.replace("$", "");
217+
}
218+
}
219+
}
220+
};
221+
request.send();
222+
}
223+
224+
var url = document.location.href.replace(".html", "__inherit__graph.png");
225+
var loc = url.match(/[^\/]+$/)[0];
226+
img.src = loc;
227+
}
228+
}
229+
230+
function expandable_node(target)
231+
{
232+
var other = target.parentNode.querySelector((target.id == "expanded")?"#brief": "#expanded");
233+
if(other != null)
234+
{
235+
target.className = "m-entry-row collapsed"
236+
other.className = (other.id == "expanded")?"m-entry-row":"m-entry-row flex";
237+
}
238+
}
239+
</script>
240+
<script src="search-v2.js"></script>
241+
<script src="searchdata-v2.js" async="async"></script>
242+
<footer><nav>
243+
<div class="m-container">
244+
<div class="m-row">
245+
<div class="m-col-l-10 m-push-l-1">
246+
<p>Paradigm Engine C++20 Rendering Library & Toolchain. Created with <a href="https://doxygen.org/">Doxygen</a> 1.9.5 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
247+
</div>
248+
</div>
249+
</div>
250+
</nav></footer>
251+
</body>
252+
</html>

0 commit comments

Comments
 (0)