Documentation1

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

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! -->