nanopenguin/SDL_Minigame
0
0
Fork 0
mirror of https://github.com/Nimac0/SDL_Minigame synced 2026-01-12 12:33:43 +00:00
Code Actions Wiki
SDL_Minigame/classSpriteComponent.html

327 lines
17 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.10.0-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=11" />
<meta name="generator" content="Doxygen 1.13.2" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>VEGO-Engine: SpriteComponent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top">
<!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">VEGO-Engine
<span id="projectnumber">&#160;0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classSpriteComponent.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classSpriteComponent-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SpriteComponent Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classSpriteComponent.html" title="SpriteComponent class to handle sprite rendering and animation.">SpriteComponent</a> class to handle sprite rendering and animation.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SpriteComponent_8h_source.html">SpriteComponent.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af767b0da914fc583613626ac58505d58" id="r_af767b0da914fc583613626ac58505d58"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af767b0da914fc583613626ac58505d58">SpriteComponent</a> (<a class="el" href="classTextures.html">Textures</a> texture, int zIndex)</td></tr>
<tr class="memdesc:af767b0da914fc583613626ac58505d58"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for <a class="el" href="classSpriteComponent.html" title="SpriteComponent class to handle sprite rendering and animation.">SpriteComponent</a>. <br /></td></tr>
<tr class="separator:af767b0da914fc583613626ac58505d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c2b0ac3fc6418bb475d257597905e66" id="r_a2c2b0ac3fc6418bb475d257597905e66"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c2b0ac3fc6418bb475d257597905e66">SpriteComponent</a> (<a class="el" href="classTextures.html">Textures</a> texture, int xOffset, int yOffset, int zIndex)</td></tr>
<tr class="memdesc:a2c2b0ac3fc6418bb475d257597905e66"><td class="mdescLeft">&#160;</td><td class="mdescRight">zIndex The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on <br /></td></tr>
<tr class="separator:a2c2b0ac3fc6418bb475d257597905e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5987774516010e021703a02a37d0509b" id="r_a5987774516010e021703a02a37d0509b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5987774516010e021703a02a37d0509b">SpriteComponent</a> (const char *path, int xOffset, int yOffset, int zIndex)</td></tr>
<tr class="memdesc:a5987774516010e021703a02a37d0509b"><td class="mdescLeft">&#160;</td><td class="mdescRight">zIndex The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on <br /></td></tr>
<tr class="separator:a5987774516010e021703a02a37d0509b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0af0ea0070ffc60b3b8d0e1c1f13b5f2" id="r_a0af0ea0070ffc60b3b8d0e1c1f13b5f2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0af0ea0070ffc60b3b8d0e1c1f13b5f2">SpriteComponent</a> (<a class="el" href="classTextures.html">Textures</a> texture, bool isAnimated, std::map&lt; std::string, std::unique_ptr&lt; Animation &gt; &gt; *animationList, std::string defaultAnimation, int zIndex)</td></tr>
<tr class="memdesc:a0af0ea0070ffc60b3b8d0e1c1f13b5f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">used for animated sprites <br /></td></tr>
<tr class="separator:a0af0ea0070ffc60b3b8d0e1c1f13b5f2"><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="classSpriteComponent.html" title="SpriteComponent class to handle sprite rendering and animation.">SpriteComponent</a> class to handle sprite rendering and animation. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af767b0da914fc583613626ac58505d58" name="af767b0da914fc583613626ac58505d58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af767b0da914fc583613626ac58505d58">&#9670;&#160;</a></span>SpriteComponent() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpriteComponent::SpriteComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTextures.html">Textures</a></td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for <a class="el" href="classSpriteComponent.html" title="SpriteComponent class to handle sprite rendering and animation.">SpriteComponent</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">texture</td><td>The texture to be used for the sprite, must be a Texture enum</td></tr>
</table>
</dd>
</dl>
<p>zIndex The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </p>
</div>
</div>
<a id="a2c2b0ac3fc6418bb475d257597905e66" name="a2c2b0ac3fc6418bb475d257597905e66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c2b0ac3fc6418bb475d257597905e66">&#9670;&#160;</a></span>SpriteComponent() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpriteComponent::SpriteComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTextures.html">Textures</a></td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>xOffset</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>yOffset</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>zIndex The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">texture</td><td>The texture to be used for the sprite, must be a Texture enum </td></tr>
<tr><td class="paramname">xOffset</td><td>The x offset of the sprite, used for rendering position </td></tr>
<tr><td class="paramname">yOffset</td><td>The y offset of the sprite, used for rendering position </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5987774516010e021703a02a37d0509b" name="a5987774516010e021703a02a37d0509b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5987774516010e021703a02a37d0509b">&#9670;&#160;</a></span>SpriteComponent() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpriteComponent::SpriteComponent </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>xOffset</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>yOffset</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>zIndex The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">texture</td><td>The texture to be used for the sprite, must be a char* path </td></tr>
<tr><td class="paramname">xOffset</td><td>The x offset of the sprite, used for rendering position </td></tr>
<tr><td class="paramname">yOffset</td><td>The y offset of the sprite, used for rendering position </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0af0ea0070ffc60b3b8d0e1c1f13b5f2" name="a0af0ea0070ffc60b3b8d0e1c1f13b5f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0af0ea0070ffc60b3b8d0e1c1f13b5f2">&#9670;&#160;</a></span>SpriteComponent() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SpriteComponent::SpriteComponent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTextures.html">Textures</a></td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>isAnimated</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::map&lt; std::string, std::unique_ptr&lt; Animation &gt; &gt; *</td> <td class="paramname"><span class="paramname"><em>animationList</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>defaultAnimation</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>zIndex</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>used for animated sprites </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">texture</td><td>The texture to be used for the sprite, must be a Texture enum </td></tr>
<tr><td class="paramname">isAnimated</td><td>Whether the sprite is animated or not </td></tr>
<tr><td class="paramname">animationList</td><td>The list of animations to be used for the sprite </td></tr>
<tr><td class="paramname">defaultAnimation</td><td>The default animation to be used for the sprite when it first gets loaded </td></tr>
<tr><td class="paramname">zIndex</td><td>The z-index of the sprite, used for rendering order, in order to show up on the map, the zIndex must be higher than the layer you want it to show up on </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="SpriteComponent_8h_source.html">SpriteComponent.h</a></li>
<li>src/<b>SpriteComponent.cpp</b></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classSpriteComponent.html">SpriteComponent</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
View Git Blame Copy Permalink