Skip to content

Commit d97d6c8

Browse files
github-actions[bot]github-actions[bot]
committed
Deploy to GitHub Pages
0 parents  commit d97d6c8

4,804 files changed

Lines changed: 581060 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/annotated.html‎

Lines changed: 990 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/annotated_dup.js‎

Lines changed: 824 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes.html‎

Lines changed: 185 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/clipboard.js‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
/**
2+
3+
The code below is based on the Doxygen Awesome project, see
4+
https://github.com/jothepro/doxygen-awesome-css
5+
6+
MIT License
7+
8+
Copyright (c) 2021 - 2022 jothepro
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
28+
*/
29+
30+
let clipboard_title = "Copy to clipboard"
31+
let clipboard_icon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path fill="#888" d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
32+
let clipboard_successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
33+
let clipboard_successDuration = 1000
34+
35+
document.addEventListener('DOMContentLoaded', function() {
36+
if(navigator.clipboard) {
37+
const fragments = document.getElementsByClassName("fragment")
38+
for(const fragment of fragments) {
39+
const clipboard_div = document.createElement("div")
40+
clipboard_div.classList.add("clipboard")
41+
clipboard_div.innerHTML = clipboard_icon
42+
clipboard_div.title = clipboard_title
43+
clipboard_div.addEventListener('click', function() {
44+
const content = this.parentNode.cloneNode(true)
45+
// filter out line number and folded fragments from file listings
46+
content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
47+
let text = content.textContent
48+
// remove trailing newlines and trailing spaces from empty lines
49+
text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
50+
navigator.clipboard.writeText(text);
51+
this.classList.add("success")
52+
this.innerHTML = clipboard_successIcon
53+
window.setTimeout(() => { // switch back to normal icon after timeout
54+
this.classList.remove("success")
55+
this.innerHTML = clipboard_icon
56+
}, clipboard_successDuration);
57+
})
58+
fragment.insertBefore(clipboard_div, fragment.firstChild)
59+
}
60+
}
61+
})

‎docs/codefolding.js‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
/*
2+
@licstart The following is the entire license notice for the JavaScript code in this file.
3+
4+
The MIT License (MIT)
5+
6+
Copyright (C) 1997-2026 by Dimitri van Heesch
7+
8+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
9+
and associated documentation files (the "Software"), to deal in the Software without restriction,
10+
including without limitation the rights to use, copy, modify, merge, publish, distribute,
11+
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
12+
furnished to do so, subject to the following conditions:
13+
14+
The above copyright notice and this permission notice shall be included in all copies or
15+
substantial portions of the Software.
16+
17+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
18+
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20+
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22+
23+
@licend The above is the entire license notice for the JavaScript code in this file
24+
*/
25+
26+
let codefold = {
27+
opened : true,
28+
29+
show_plus : function(el) {
30+
if (el) {
31+
el.classList.remove('minus');
32+
el.classList.add('plus');
33+
}
34+
},
35+
36+
show_minus : function(el) {
37+
if (el) {
38+
el.classList.add('minus');
39+
el.classList.remove('plus');
40+
}
41+
},
42+
43+
// toggle all folding blocks
44+
toggle_all : function() {
45+
if (this.opened) {
46+
const foldAll = document.getElementById('fold_all');
47+
this.show_plus(foldAll);
48+
document.querySelectorAll('div[id^=foldopen]').forEach(el => el.style.display = 'none');
49+
document.querySelectorAll('div[id^=foldclosed]').forEach(el => el.style.display = '');
50+
document.querySelectorAll('div[id^=foldclosed] span.fold').forEach(el => this.show_plus(el));
51+
} else {
52+
const foldAll = document.getElementById('fold_all');
53+
this.show_minus(foldAll);
54+
document.querySelectorAll('div[id^=foldopen]').forEach(el => el.style.display = '');
55+
document.querySelectorAll('div[id^=foldclosed]').forEach(el => el.style.display = 'none');
56+
}
57+
this.opened=!this.opened;
58+
},
59+
60+
// toggle single folding block
61+
toggle : function(id) {
62+
const openEl = document.getElementById('foldopen'+id);
63+
const closedEl = document.getElementById('foldclosed'+id);
64+
if (openEl) {
65+
openEl.style.display = openEl.style.display === 'none' ? '' : 'none';
66+
const nextEl = openEl.nextElementSibling;
67+
if (nextEl) {
68+
nextEl.querySelectorAll('span.fold').forEach(el => this.show_plus(el));
69+
}
70+
}
71+
if (closedEl) {
72+
closedEl.style.display = closedEl.style.display === 'none' ? '' : 'none';
73+
}
74+
},
75+
76+
init : function() {
77+
// add code folding line and global control
78+
document.querySelectorAll('span.lineno').forEach((el, index) => {
79+
el.style.paddingRight = '4px';
80+
el.style.marginRight = '2px';
81+
el.style.display = 'inline-block';
82+
el.style.width = '54px';
83+
el.style.background = 'linear-gradient(var(--fold-line-color),var(--fold-line-color)) no-repeat 46px/2px 100%';
84+
const span = document.createElement('span');
85+
if (index === 0) { // add global toggle to first line
86+
span.className = 'fold minus';
87+
span.id = 'fold_all';
88+
span.onclick = () => codefold.toggle_all();
89+
} else { // add vertical lines to other rows
90+
span.className = 'fold'
91+
}
92+
el.appendChild(span);
93+
});
94+
// add toggle controls to lines with fold divs
95+
document.querySelectorAll('div.foldopen').forEach(el => {
96+
// extract specific id to use
97+
const id = el.getAttribute('id').replace('foldopen','');
98+
// extract start and end foldable fragment attributes
99+
const start = el.getAttribute('data-start');
100+
const end = el.getAttribute('data-end');
101+
// replace normal fold span with controls for the first line of a foldable fragment
102+
const firstFold = el.querySelector('span.fold');
103+
if (firstFold) {
104+
const span = document.createElement('span');
105+
span.className = 'fold minus';
106+
span.onclick = () => codefold.toggle(id);
107+
firstFold.replaceWith(span);
108+
}
109+
// append div for folded (closed) representation
110+
const closedDiv = document.createElement('div');
111+
closedDiv.id = 'foldclosed'+id;
112+
closedDiv.className = 'foldclosed';
113+
closedDiv.style.display = 'none';
114+
el.after(closedDiv);
115+
// extract the first line from the "open" section to represent closed content
116+
const line = el.children[0] ? el.children[0].cloneNode(true) : null;
117+
if (line) {
118+
// remove any glow that might still be active on the original line
119+
line.classList.remove('glow');
120+
if (start) {
121+
// if line already ends with a start marker (e.g. trailing {), remove it
122+
line.innerHTML = line.innerHTML.replace(new RegExp('\\s*'+start+'\\s*$','g'),'');
123+
}
124+
// replace minus with plus symbol
125+
line.querySelectorAll('span.fold').forEach(span => {
126+
codefold.show_plus(span);
127+
// re-apply click handler as it is not copied with cloneNode
128+
span.onclick = () => codefold.toggle(id);
129+
});
130+
// append ellipsis
131+
const ellipsisLink = document.createElement('a');
132+
ellipsisLink.href = "javascript:codefold.toggle('"+id+"')";
133+
ellipsisLink.innerHTML = '&#8230;';
134+
line.appendChild(document.createTextNode(' '+start));
135+
line.appendChild(ellipsisLink);
136+
line.appendChild(document.createTextNode(end));
137+
// insert constructed line into closed div
138+
closedDiv.appendChild(line);
139+
}
140+
});
141+
},
142+
};
143+
/* @license-end */

‎docs/cookie.js‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*!
2+
Cookie helper functions
3+
Copyright (c) 2023 Dimitri van Heesch
4+
Released under MIT license.
5+
*/
6+
let Cookie = {
7+
cookie_namespace: 'doxygen_',
8+
9+
readSetting(cookie,defVal) {
10+
if (window.chrome) {
11+
const val = localStorage.getItem(this.cookie_namespace+cookie) ||
12+
sessionStorage.getItem(this.cookie_namespace+cookie);
13+
if (val) return val;
14+
} else {
15+
let myCookie = this.cookie_namespace+cookie+"=";
16+
if (document.cookie) {
17+
const index = document.cookie.indexOf(myCookie);
18+
if (index != -1) {
19+
const valStart = index + myCookie.length;
20+
let valEnd = document.cookie.indexOf(";", valStart);
21+
if (valEnd == -1) {
22+
valEnd = document.cookie.length;
23+
}
24+
return document.cookie.substring(valStart, valEnd);
25+
}
26+
}
27+
}
28+
return defVal;
29+
},
30+
31+
writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
32+
if (window.chrome) {
33+
if (days==0) {
34+
sessionStorage.setItem(this.cookie_namespace+cookie,val);
35+
} else {
36+
localStorage.setItem(this.cookie_namespace+cookie,val);
37+
}
38+
} else {
39+
let date = new Date();
40+
date.setTime(date.getTime()+(days*24*60*60*1000));
41+
const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
42+
document.cookie = this.cookie_namespace + cookie + "=" +
43+
val + "; SameSite=Lax;" + expiration + "path=/";
44+
}
45+
},
46+
47+
eraseSetting(cookie) {
48+
if (window.chrome) {
49+
if (localStorage.getItem(this.cookie_namespace+cookie)) {
50+
localStorage.removeItem(this.cookie_namespace+cookie);
51+
} else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
52+
sessionStorage.removeItem(this.cookie_namespace+cookie);
53+
}
54+
} else {
55+
this.writeSetting(cookie,'',-1);
56+
}
57+
},
58+
}

‎docs/d0/d00/structDiligent_1_1InputLayoutDescX.html‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.17.0"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Diligent Engine: Diligent::InputLayoutDescX Struct Reference</title>
9+
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="../../codefolding.js"></script>
11+
<script type="text/javascript" src="../../clipboard.js"></script>
12+
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="../../navtreedata.js"></script>
14+
<script type="text/javascript" src="../../navtree.js"></script>
15+
<script type="text/javascript" src="../../cookie.js"></script>
16+
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="../../search/searchdata.js"></script>
18+
<script type="text/javascript" src="../../search/search.js"></script>
19+
<script type="text/javascript">
20+
document.addEventListener('DOMContentLoaded', init_search);
21+
</script>
22+
<script type="module">
23+
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
24+
const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';
25+
mermaid.initialize({ startOnLoad: true, theme: theme });
26+
</script>
27+
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
28+
</head>
29+
<body>
30+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
31+
<div id="titlearea">
32+
<table cellspacing="0" cellpadding="0">
33+
<tbody>
34+
<tr id="projectrow">
35+
<td id="projectalign">
36+
<div id="projectname">Diligent Engine
37+
</div>
38+
</td>
39+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
40+
<span class="left">
41+
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
42+
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
43+
onfocus="searchBox.OnSearchFieldFocus(true)"
44+
onblur="searchBox.OnSearchFieldFocus(false)"
45+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
46+
</span><span class="right">
47+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
48+
</span>
49+
</div>
50+
</td>
51+
</tr>
52+
</tbody>
53+
</table>
54+
</div>
55+
<!-- end header part -->
56+
<!-- Generated by Doxygen 1.17.0 -->
57+
<script type="text/javascript">
58+
let searchBox = new SearchBox("searchBox", "../../search/",'.html');
59+
</script>
60+
<script type="text/javascript">
61+
document.addEventListener('DOMContentLoaded', codefold.init);
62+
</script>
63+
</div><!-- top -->
64+
<div id="side-nav" class="ui-resizable side-nav-resizable">
65+
<div id="nav-tree">
66+
<div id="nav-tree-contents">
67+
<div id="nav-sync" class="sync"></div>
68+
</div>
69+
</div>
70+
<div id="splitbar" style="-moz-user-select:none;"
71+
class="ui-resizable-handle">
72+
</div>
73+
</div>
74+
<script type="text/javascript">
75+
document.addEventListener('DOMContentLoaded',() => { initNavTree('d0/d00/structDiligent_1_1InputLayoutDescX.html','../../','dd/d48/structDiligent_1_1InputLayoutDescX-members'); });
76+
</script>
77+
<div id="container">
78+
<div id="doc-content">
79+
<!-- window showing the filter options -->
80+
<div id="MSearchSelectWindow"
81+
onmouseover="return searchBox.OnSearchSelectShow()"
82+
onmouseout="return searchBox.OnSearchSelectHide()"
83+
onkeydown="return searchBox.OnSearchSelectKey(event)">
84+
</div>
85+
86+
<!-- iframe showing the search results (closed by default) -->
87+
<div id="MSearchResultsWindow">
88+
<div id="MSearchResults">
89+
<div class="SRPage">
90+
<div id="SRIndex">
91+
<div id="SRResults"></div>
92+
<div class="SRStatus" id="Loading">Loading...</div>
93+
<div class="SRStatus" id="Searching">Searching...</div>
94+
<div class="SRStatus" id="NoMatches">No Matches</div>
95+
</div>
96+
</div>
97+
</div>
98+
</div>
99+
100+
<div class="header">
101+
<div class="headertitle"><div class="title">Diligent::InputLayoutDescX Struct Reference</div></div>
102+
</div><!--header-->
103+
<div class="contents">
104+
105+
<p>C++ wrapper over <a class="el" href="../../d4/d3a/structDiligent_1_1InputLayoutDesc.html" title="Layout description.">InputLayoutDesc</a>.
106+
<a href="#details">More...</a></p>
107+
108+
<p><code>#include &lt;GraphicsTypesX.hpp&gt;</code></p>
109+
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
110+
<div class="textblock"><p>C++ wrapper over <a class="el" href="../../d4/d3a/structDiligent_1_1InputLayoutDesc.html" title="Layout description.">InputLayoutDesc</a>. </p>
111+
</div></div><!-- contents -->
112+
</div><!-- doc-content -->
113+
<div id="page-nav" class="page-nav-panel">
114+
<div id="page-nav-resize-handle"></div>
115+
<div id="page-nav-tree">
116+
<div id="page-nav-contents">
117+
</div><!-- page-nav-contents -->
118+
</div><!-- page-nav-tree -->
119+
</div><!-- page-nav -->
120+
</div><!-- container -->
121+
<!-- HTML footer for doxygen 1.13.2-->
122+
<!-- start footer part -->
123+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
124+
<ul>
125+
<li class="navelem"><a href="../../d7/dca/namespaceDiligent.html">Diligent</a></li><li class="navelem"><a href="../../d0/d00/structDiligent_1_1InputLayoutDescX.html">InputLayoutDescX</a></li>
126+
<li class="footer">
127+
<a href="https://diligentgraphics.com">
128+
<img class="footer" src="https://github.com/DiligentGraphics/DiligentCore/raw/master/media/diligentgraphics-logo.png" width="99" height="32" alt="Diligent Graphics" />
129+
</a>
130+
</li>
131+
</ul>
132+
</div>
133+
</body>
134+
</html>

0 commit comments

Comments
 (0)