Documentation1

This commit is contained in:
tobid7 2022-04-12 08:01:12 +00:00
parent 43e6f1b808
commit 663795c748
11 changed files with 119 additions and 18 deletions

View File

@ -57,7 +57,10 @@ $(document).ready(function(){initNavTree('classRenderD7_1_1Sprite.html',''); ini
<p>This is the complete list of members for <a class="el" href="classRenderD7_1_1Sprite.html">RenderD7::Sprite</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f">FromImage</a>(RenderD7::Image *img)</td><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html">RenderD7::Sprite</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0">FromSheet</a>(RenderD7::Sheet *sheet, size_t index)</td><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html">RenderD7::Sprite</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html#ae2924bcf030217135967253672e2b33e">Sprite</a>()</td><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html">RenderD7::Sprite</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html#a1e267013d1af5cb5d8f9904d153c8a00">~Sprite</a>()</td><td class="entry"><a class="el" href="classRenderD7_1_1Sprite.html">RenderD7::Sprite</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->

View File

@ -71,10 +71,84 @@ Public Member Functions</h2></td></tr>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderD7_1_1Sprite.html#ae2924bcf030217135967253672e2b33e">Sprite</a> ()</td></tr>
<tr class="memdesc:ae2924bcf030217135967253672e2b33e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a>. <br /></td></tr>
<tr class="separator:ae2924bcf030217135967253672e2b33e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e267013d1af5cb5d8f9904d153c8a00"><td class="memItemLeft" align="right" valign="top"><a id="a1e267013d1af5cb5d8f9904d153c8a00"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderD7_1_1Sprite.html#a1e267013d1af5cb5d8f9904d153c8a00">~Sprite</a> ()</td></tr>
<tr class="memdesc:a1e267013d1af5cb5d8f9904d153c8a00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deconstruct <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a>. <br /></td></tr>
<tr class="separator:a1e267013d1af5cb5d8f9904d153c8a00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae130fb6026f59acf1543544567d5b6a0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0">FromSheet</a> (<a class="el" href="classRenderD7_1_1Sheet.html">RenderD7::Sheet</a> *sheet, size_t index)</td></tr>
<tr class="memdesc:ae130fb6026f59acf1543544567d5b6a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a> From SpriteSheet. <a href="classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0">More...</a><br /></td></tr>
<tr class="separator:ae130fb6026f59acf1543544567d5b6a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d8335d6739f0295355c5c92dbf06f2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f">FromImage</a> (<a class="el" href="classRenderD7_1_1Image.html">RenderD7::Image</a> *img)</td></tr>
<tr class="memdesc:a2d8335d6739f0295355c5c92dbf06f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a> From SpriteSheet. <a href="classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f">More...</a><br /></td></tr>
<tr class="separator:a2d8335d6739f0295355c5c92dbf06f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a> Class. </p>
</div></div><!-- contents -->
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae130fb6026f59acf1543544567d5b6a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae130fb6026f59acf1543544567d5b6a0">&#9670;&nbsp;</a></span>FromSheet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RenderD7::Sprite::FromSheet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRenderD7_1_1Sheet.html">RenderD7::Sheet</a> *&#160;</td>
<td class="paramname"><em>sheet</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>index</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a> From SpriteSheet. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sheet</td><td>the <a class="el" href="classRenderD7_1_1Sheet.html">Sheet</a> to load from.(<a class="el" href="classRenderD7_1_1Sheet.html">RenderD7::Sheet</a>) </td></tr>
<tr><td class="paramname">index</td><td>the number of the <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a> in the <a class="el" href="classRenderD7_1_1Sheet.html">Sheet</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2d8335d6739f0295355c5c92dbf06f2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d8335d6739f0295355c5c92dbf06f2f">&#9670;&nbsp;</a></span>FromImage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RenderD7::Sprite::FromImage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classRenderD7_1_1Image.html">RenderD7::Image</a> *&#160;</td>
<td class="paramname"><em>img</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a <a class="el" href="classRenderD7_1_1Sprite.html" title="Sprite Class.">Sprite</a> From SpriteSheet. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">img</td><td>the <a class="el" href="classRenderD7_1_1Image.html" title="Image Class.">Image</a> to load from.(<a class="el" href="classRenderD7_1_1Image.html" title="Image Class.">RenderD7::Image</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

View File

@ -1,4 +1,7 @@
var classRenderD7_1_1Sprite =
[
[ "Sprite", "classRenderD7_1_1Sprite.html#ae2924bcf030217135967253672e2b33e", null ]
[ "Sprite", "classRenderD7_1_1Sprite.html#ae2924bcf030217135967253672e2b33e", null ],
[ "~Sprite", "classRenderD7_1_1Sprite.html#a1e267013d1af5cb5d8f9904d153c8a00", null ],
[ "FromSheet", "classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0", null ],
[ "FromImage", "classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f", null ]
];

View File

@ -73,19 +73,25 @@ $(document).ready(function(){initNavTree('functions_f.html',''); initResizable()
: <a class="el" href="classnlohmann_1_1basic__json.html#a7f92545f5bd388d529df7eb27c09b5e8">nlohmann::basic_json</a>
</li>
<li>from_cbor()
: <a class="el" href="classnlohmann_1_1basic__json.html#afcb83dba9c83a73524cc28812db2abd4">nlohmann::basic_json</a>
: <a class="el" href="classnlohmann_1_1basic__json.html#ac771f2c2d0b16f59bc066db900963ba1">nlohmann::basic_json</a>
</li>
<li>from_json()
: <a class="el" href="structnlohmann_1_1adl__serializer.html#a2c544585b8b1828a0f1eecd831d0496e">nlohmann::adl_serializer&lt; typename, typename &gt;</a>
</li>
<li>from_msgpack()
: <a class="el" href="classnlohmann_1_1basic__json.html#abe8f728998a65ebe269931a80fd403d8">nlohmann::basic_json</a>
: <a class="el" href="classnlohmann_1_1basic__json.html#a5d4c61976353f72d2baf8a382936abe4">nlohmann::basic_json</a>
</li>
<li>from_ubjson()
: <a class="el" href="classnlohmann_1_1basic__json.html#a423ea903bcbe9c52bbdb8084f212293c">nlohmann::basic_json</a>
: <a class="el" href="classnlohmann_1_1basic__json.html#aa5e9d5e42fda65ba1f1cb43e383dacf2">nlohmann::basic_json</a>
</li>
<li>FromImage()
: <a class="el" href="classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f">RenderD7::Sprite</a>
</li>
<li>FromSheet()
: <a class="el" href="classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0">RenderD7::Sprite</a>
</li>
<li>front()
: <a class="el" href="classnlohmann_1_1basic__json.html#ad1702349b3aeca0e518921336faa570c">nlohmann::basic_json</a>
: <a class="el" href="classnlohmann_1_1basic__json.html#a135d1239f3189866baaede36ec0701c8">nlohmann::basic_json</a>
</li>
</ul>
</div><!-- contents -->

View File

@ -81,6 +81,12 @@ $(document).ready(function(){initNavTree('functions_func_f.html',''); initResiza
<li>from_ubjson()
: <a class="el" href="classnlohmann_1_1basic__json.html#a423ea903bcbe9c52bbdb8084f212293c">nlohmann::basic_json</a>
</li>
<li>FromImage()
: <a class="el" href="classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f">RenderD7::Sprite</a>
</li>
<li>FromSheet()
: <a class="el" href="classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0">RenderD7::Sprite</a>
</li>
<li>front()
: <a class="el" href="classnlohmann_1_1basic__json.html#a135d1239f3189866baaede36ec0701c8">nlohmann::basic_json</a>
</li>

View File

@ -62,6 +62,9 @@ $(document).ready(function(){initNavTree('functions_func_~.html',''); initResiza
<li>~sound()
: <a class="el" href="classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72">sound</a>
</li>
<li>~Sprite()
: <a class="el" href="classRenderD7_1_1Sprite.html#a1e267013d1af5cb5d8f9904d153c8a00">RenderD7::Sprite</a>
</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->

View File

@ -62,6 +62,9 @@ $(document).ready(function(){initNavTree('functions_~.html',''); initResizable()
<li>~sound()
: <a class="el" href="classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72">sound</a>
</li>
<li>~Sprite()
: <a class="el" href="classRenderD7_1_1Sprite.html#a1e267013d1af5cb5d8f9904d153c8a00">RenderD7::Sprite</a>
</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->

View File

@ -51,8 +51,8 @@ var NAVTREE =
var NAVTREEINDEX =
[
".html",
"classnlohmann_1_1detail_1_1binary__reader.html#a8bebd21ceef09b6b2562e87861832700",
"namespacenlohmann_1_1detail.html"
"classnlohmann_1_1detail_1_1binary__reader.html#a7b6c2d4c95d56751e233e285a5f1fea7",
"namespacemembers_type.html"
];
var SYNCONMSG = 'click to disable panel synchronisation';

View File

@ -22,6 +22,9 @@ var NAVTREEINDEX0 =
"classRenderD7_1_1Sheet.html#a869b5bb61b4197eee2b3258e2f3b64e5":[2,0,1,1,1],
"classRenderD7_1_1Sheet.html#a950debb41e4b392a4a80a9607f4ae7cd":[2,0,1,1,2],
"classRenderD7_1_1Sprite.html":[2,0,1,2],
"classRenderD7_1_1Sprite.html#a1e267013d1af5cb5d8f9904d153c8a00":[2,0,1,2,1],
"classRenderD7_1_1Sprite.html#a2d8335d6739f0295355c5c92dbf06f2f":[2,0,1,2,3],
"classRenderD7_1_1Sprite.html#ae130fb6026f59acf1543544567d5b6a0":[2,0,1,2,2],
"classRenderD7_1_1Sprite.html#ae2924bcf030217135967253672e2b33e":[2,0,1,2,0],
"classes.html":[2,1],
"classnlohmann_1_1basic__json.html":[2,0,0,2],
@ -246,8 +249,5 @@ var NAVTREEINDEX0 =
"classnlohmann_1_1detail_1_1binary__reader.html#a548c770e60f2285a931de4b7333c1ab0":[2,0,0,0,0,33],
"classnlohmann_1_1detail_1_1binary__reader.html#a55e13d567a53234573ab3833c0ca32e9":[2,0,0,0,0,29],
"classnlohmann_1_1detail_1_1binary__reader.html#a5a79480d661019b0f3fc615ae12f7de7":[2,0,0,0,0,19],
"classnlohmann_1_1detail_1_1binary__reader.html#a61a0bd8bbe7b560bd429fa990ba3ba1a":[2,0,0,0,0,30],
"classnlohmann_1_1detail_1_1binary__reader.html#a7b6c2d4c95d56751e233e285a5f1fea7":[2,0,0,0,0,22],
"classnlohmann_1_1detail_1_1binary__reader.html#a7d323283c60a0b89ee5eeadf5cb9a5ad":[2,0,0,0,0,31],
"classnlohmann_1_1detail_1_1binary__reader.html#a7e5e0b71548d0649ce4f131280d06c33":[2,0,0,0,0,23]
"classnlohmann_1_1detail_1_1binary__reader.html#a61a0bd8bbe7b560bd429fa990ba3ba1a":[2,0,0,0,0,30]
};

View File

@ -1,5 +1,8 @@
var NAVTREEINDEX1 =
{
"classnlohmann_1_1detail_1_1binary__reader.html#a7b6c2d4c95d56751e233e285a5f1fea7":[2,0,0,0,0,22],
"classnlohmann_1_1detail_1_1binary__reader.html#a7d323283c60a0b89ee5eeadf5cb9a5ad":[2,0,0,0,0,31],
"classnlohmann_1_1detail_1_1binary__reader.html#a7e5e0b71548d0649ce4f131280d06c33":[2,0,0,0,0,23],
"classnlohmann_1_1detail_1_1binary__reader.html#a8bebd21ceef09b6b2562e87861832700":[2,0,0,0,0,18],
"classnlohmann_1_1detail_1_1binary__reader.html#a9940f56290b9278c58772eda2931e599":[2,0,0,0,0,5],
"classnlohmann_1_1detail_1_1binary__reader.html#a9c413c9a1bade1ce345740f4d69156f0":[2,0,0,0,0,32],
@ -188,15 +191,15 @@ var NAVTREEINDEX1 =
"classsound.html#abb2c33709eb822528889e32722fc1153":[2,0,4,2],
"classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a":[2,0,4,3],
"deprecated.html":[0],
"functions.html":[2,3,0,0],
"functions.html":[2,3,0],
"functions.html":[2,3,0,0],
"functions_b.html":[2,3,0,1],
"functions_c.html":[2,3,0,2],
"functions_d.html":[2,3,0,3],
"functions_e.html":[2,3,0,4],
"functions_f.html":[2,3,0,5],
"functions_func.html":[2,3,1],
"functions_func.html":[2,3,1,0],
"functions_func.html":[2,3,1],
"functions_func_b.html":[2,3,1,1],
"functions_func_c.html":[2,3,1,2],
"functions_func_d.html":[2,3,1,3],
@ -246,8 +249,5 @@ var NAVTREEINDEX1 =
"namespaceRenderD7_1_1Lang.html":[1,0,1,0],
"namespacemembers.html":[1,1,0],
"namespacemembers_enum.html":[1,1,3],
"namespacemembers_func.html":[1,1,1],
"namespacemembers_type.html":[1,1,2],
"namespacenlohmann.html":[1,0,0],
"namespacenlohmann.html":[2,0,0]
"namespacemembers_func.html":[1,1,1]
};

View File

@ -1,5 +1,8 @@
var NAVTREEINDEX2 =
{
"namespacemembers_type.html":[1,1,2],
"namespacenlohmann.html":[1,0,0],
"namespacenlohmann.html":[2,0,0],
"namespacenlohmann_1_1detail.html":[2,0,0,0],
"namespacenlohmann_1_1detail.html":[1,0,0,0],
"namespacenlohmann_1_1detail_1_1dtoa__impl.html":[1,0,0,0,0],