herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

started woking on figuring out doxygen documentation and added readme

Browse source
This commit is contained in:
herbglitch 2024-12-24 03:47:16 -07:00
parent c598f3e106
commit 3f0556341c
1192 changed files with 199462 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

640
doc/doxygen/html/db/d08/sprite_8h.html Normal file
View file

@ -0,0 +1,640 @@
<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/graphics/sprite.h File 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>
<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"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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(1); });
/* @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('db/d08/sprite_8h.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="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sprite.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="../../d6/d85/renderer_8h_source.html">arc/graphics/renderer.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d9/d53/spritesheet_8h_source.html">arc/graphics/spritesheet.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d2/d91/point_8h_source.html">arc/math/point.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../d2/d14/math_2rectangle_8h_source.html">arc/math/rectangle.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../db/d63/array_8h_source.html">arc/std/array.h</a>&quot;</code><br />
</div>
<p><a href="../../db/d08/sprite_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a03c5973e40c2bda444c06c7550471b42" id="r_a03c5973e40c2bda444c06c7550471b42"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a></td></tr>
<tr class="memdesc:a03c5973e40c2bda444c06c7550471b42"><td class="mdescLeft">&#160;</td><td class="mdescRight">a sprite type <br /></td></tr>
<tr class="separator:a03c5973e40c2bda444c06c7550471b42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8975412b8ce43563bd9b9e8034d48107" id="r_a8975412b8ce43563bd9b9e8034d48107"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8975412b8ce43563bd9b9e8034d48107">ARC_Sprite_Axix</a></td></tr>
<tr class="separator:a8975412b8ce43563bd9b9e8034d48107"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a58f03c421534fd75dbdf5b301fff84f5" id="r_a58f03c421534fd75dbdf5b301fff84f5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a> { <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008">ARC_SPRITE_AXIS_NONE</a> = 0x00
, <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0">ARC_SPRITE_AXIS_Y</a> = 0x01
, <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f">ARC_SPRITE_AXIS_X</a> = 0x02
}</td></tr>
<tr class="separator:a58f03c421534fd75dbdf5b301fff84f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a236db372d25ec6939fc3a59a50174d2c" id="r_a236db372d25ec6939fc3a59a50174d2c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a236db372d25ec6939fc3a59a50174d2c">ARC_Sprite_Create</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> **sprite, <a class="el" href="../../d9/d53/spritesheet_8h.html#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *spritesheet, <a class="el" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *frames)</td></tr>
<tr class="memdesc:a236db372d25ec6939fc3a59a50174d2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">creates ARC_Sprite type <br /></td></tr>
<tr class="separator:a236db372d25ec6939fc3a59a50174d2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37754370968f742ee6bfbb179a50804c" id="r_a37754370968f742ee6bfbb179a50804c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a37754370968f742ee6bfbb179a50804c">ARC_Sprite_Destroy</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite)</td></tr>
<tr class="memdesc:a37754370968f742ee6bfbb179a50804c"><td class="mdescLeft">&#160;</td><td class="mdescRight">destroys ARC_Sprite type <br /></td></tr>
<tr class="separator:a37754370968f742ee6bfbb179a50804c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac71528b8b08e5c9f9ef12377413c887f" id="r_ac71528b8b08e5c9f9ef12377413c887f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac71528b8b08e5c9f9ef12377413c887f">ARC_Sprite_Copy</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> **newSprite, <a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *oldSprite)</td></tr>
<tr class="memdesc:ac71528b8b08e5c9f9ef12377413c887f"><td class="mdescLeft">&#160;</td><td class="mdescRight">copies ARC_Sprite to a new ARC_Sprite <br /></td></tr>
<tr class="separator:ac71528b8b08e5c9f9ef12377413c887f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a93598bcc2eee0b8e3eb1a94ebbcf3e5e" id="r_a93598bcc2eee0b8e3eb1a94ebbcf3e5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93598bcc2eee0b8e3eb1a94ebbcf3e5e">ARC_Sprite_SetOpacity</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, uint8_t opacity)</td></tr>
<tr class="memdesc:a93598bcc2eee0b8e3eb1a94ebbcf3e5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets ARC_Sprite's opacity <br /></td></tr>
<tr class="separator:a93598bcc2eee0b8e3eb1a94ebbcf3e5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e2479255f39c245c08a8791aea5e877" id="r_a0e2479255f39c245c08a8791aea5e877"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0e2479255f39c245c08a8791aea5e877">ARC_Sprite_Render</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, <a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *renderBounds)</td></tr>
<tr class="memdesc:a0e2479255f39c245c08a8791aea5e877"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders ARC_Sprite type <br /></td></tr>
<tr class="separator:a0e2479255f39c245c08a8791aea5e877"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96fa458abc8926631b646a8e89899474" id="r_a96fa458abc8926631b646a8e89899474"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a96fa458abc8926631b646a8e89899474">ARC_Sprite_RenderFlip</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, <a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *renderBounds, enum <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a> axis)</td></tr>
<tr class="memdesc:a96fa458abc8926631b646a8e89899474"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders ARC_Sprite type with flip <br /></td></tr>
<tr class="separator:a96fa458abc8926631b646a8e89899474"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57c6332c153a9abd0906b822fc1614ef" id="r_a57c6332c153a9abd0906b822fc1614ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a57c6332c153a9abd0906b822fc1614ef">ARC_Sprite_RenderRotated</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, <a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *renderBounds, <a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> *center, double angle)</td></tr>
<tr class="memdesc:a57c6332c153a9abd0906b822fc1614ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">renders ARC_Sprite type with rotation <br /></td></tr>
<tr class="separator:a57c6332c153a9abd0906b822fc1614ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6bed9d1c4c5c7a5ced00b45672c94f9" id="r_ae6bed9d1c4c5c7a5ced00b45672c94f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae6bed9d1c4c5c7a5ced00b45672c94f9">ARC_Sprite_SetFrameIndex</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, uint32_t index)</td></tr>
<tr class="memdesc:ae6bed9d1c4c5c7a5ced00b45672c94f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">switches ARC_Sprite's frame to specified index <br /></td></tr>
<tr class="separator:ae6bed9d1c4c5c7a5ced00b45672c94f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8f6efb1950a0e908efcd59b69427f38" id="r_ae8f6efb1950a0e908efcd59b69427f38"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8f6efb1950a0e908efcd59b69427f38">ARC_Sprite_IterateFrame</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite)</td></tr>
<tr class="memdesc:ae8f6efb1950a0e908efcd59b69427f38"><td class="mdescLeft">&#160;</td><td class="mdescRight">switches ARC_Sprite's frames to next for animation <br /></td></tr>
<tr class="separator:ae8f6efb1950a0e908efcd59b69427f38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a001e727b8923a2435a873eb085e50308" id="r_a001e727b8923a2435a873eb085e50308"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a001e727b8923a2435a873eb085e50308">ARC_Sprite_GetFrameIndex</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite)</td></tr>
<tr class="memdesc:a001e727b8923a2435a873eb085e50308"><td class="mdescLeft">&#160;</td><td class="mdescRight">gets ARC_Sprite's current frame <br /></td></tr>
<tr class="separator:a001e727b8923a2435a873eb085e50308"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98ceee44610d603afd0ed235fd72cc95" id="r_a98ceee44610d603afd0ed235fd72cc95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a98ceee44610d603afd0ed235fd72cc95">ARC_Sprite_GetBounds</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite)</td></tr>
<tr class="memdesc:a98ceee44610d603afd0ed235fd72cc95"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the current bounds based on the ARC_Sprite's frames <br /></td></tr>
<tr class="separator:a98ceee44610d603afd0ed235fd72cc95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa94ca232d44c6de7b4f00754152da02e" id="r_aa94ca232d44c6de7b4f00754152da02e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa94ca232d44c6de7b4f00754152da02e">ARC_Sprite_GetAllBounds</a> (<a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite)</td></tr>
<tr class="memdesc:aa94ca232d44c6de7b4f00754152da02e"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the array of bounds that a sprite has <br /></td></tr>
<tr class="separator:aa94ca232d44c6de7b4f00754152da02e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a03c5973e40c2bda444c06c7550471b42" name="a03c5973e40c2bda444c06c7550471b42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03c5973e40c2bda444c06c7550471b42">&#9670;&#160;</a></span>ARC_Sprite</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> <a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>a sprite type </p>
<dl class="section note"><dt>Note</dt><dd>the actual type should be define by overriding for a graphics api </dd></dl>
<p class="definition">Definition at line <a class="el" href="../../db/d08/sprite_8h_source.html#l00019">19</a> of file <a class="el" href="../../db/d08/sprite_8h_source.html">sprite.h</a>.</p>
</div>
</div>
<a id="a8975412b8ce43563bd9b9e8034d48107" name="a8975412b8ce43563bd9b9e8034d48107"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8975412b8ce43563bd9b9e8034d48107">&#9670;&#160;</a></span>ARC_Sprite_Axix</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a> <a class="el" href="#a8975412b8ce43563bd9b9e8034d48107">ARC_Sprite_Axix</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a58f03c421534fd75dbdf5b301fff84f5" name="a58f03c421534fd75dbdf5b301fff84f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58f03c421534fd75dbdf5b301fff84f5">&#9670;&#160;</a></span>ARC_Sprite_Axis</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008" name="a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008"></a>ARC_SPRITE_AXIS_NONE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0" name="a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0"></a>ARC_SPRITE_AXIS_Y&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f" name="a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f"></a>ARC_SPRITE_AXIS_X&#160;</td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="../../db/d08/sprite_8h_source.html#l00067">67</a> of file <a class="el" href="../../db/d08/sprite_8h_source.html">sprite.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 67</span> {</div>
<div class="line"><span class="lineno"> 68</span> <a class="code hl_enumvalue" href="#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008">ARC_SPRITE_AXIS_NONE</a> = 0x00,</div>
<div class="line"><span class="lineno"> 69</span> <a class="code hl_enumvalue" href="#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0">ARC_SPRITE_AXIS_Y</a> = 0x01,</div>
<div class="line"><span class="lineno"> 70</span> <a class="code hl_enumvalue" href="#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f">ARC_SPRITE_AXIS_X</a> = 0x02,</div>
<div class="line"><span class="lineno"> 71</span>} <a class="code hl_typedef" href="#a8975412b8ce43563bd9b9e8034d48107">ARC_Sprite_Axix</a>;</div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0"><div class="ttname"><a href="#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0">ARC_SPRITE_AXIS_Y</a></div><div class="ttdeci">@ ARC_SPRITE_AXIS_Y</div><div class="ttdef"><b>Definition</b> <a href="../../db/d08/sprite_8h_source.html#l00069">sprite.h:69</a></div></div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008"><div class="ttname"><a href="#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008">ARC_SPRITE_AXIS_NONE</a></div><div class="ttdeci">@ ARC_SPRITE_AXIS_NONE</div><div class="ttdef"><b>Definition</b> <a href="../../db/d08/sprite_8h_source.html#l00068">sprite.h:68</a></div></div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f"><div class="ttname"><a href="#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f">ARC_SPRITE_AXIS_X</a></div><div class="ttdeci">@ ARC_SPRITE_AXIS_X</div><div class="ttdef"><b>Definition</b> <a href="../../db/d08/sprite_8h_source.html#l00070">sprite.h:70</a></div></div>
<div class="ttc" id="asprite_8h_html_a8975412b8ce43563bd9b9e8034d48107"><div class="ttname"><a href="#a8975412b8ce43563bd9b9e8034d48107">ARC_Sprite_Axix</a></div><div class="ttdeci">enum ARC_Sprite_Axis ARC_Sprite_Axix</div></div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac71528b8b08e5c9f9ef12377413c887f" name="ac71528b8b08e5c9f9ef12377413c887f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac71528b8b08e5c9f9ef12377413c887f">&#9670;&#160;</a></span>ARC_Sprite_Copy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_Copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> **</td> <td class="paramname"><span class="paramname"><em>newSprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>oldSprite</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>copies ARC_Sprite to a new ARC_Sprite </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newSprite</td><td>ARC_Sprite that is being copied to and created </td></tr>
<tr><td class="paramname">oldSprite</td><td>ARC_Sprite contents that are being copied </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a236db372d25ec6939fc3a59a50174d2c" name="a236db372d25ec6939fc3a59a50174d2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a236db372d25ec6939fc3a59a50174d2c">&#9670;&#160;</a></span>ARC_Sprite_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> **</td> <td class="paramname"><span class="paramname"><em>sprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d9/d53/spritesheet_8h.html#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *</td> <td class="paramname"><span class="paramname"><em>spritesheet</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *</td> <td class="paramname"><span class="paramname"><em>frames</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>creates ARC_Sprite type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that is being created </td></tr>
<tr><td class="paramname">spritesheet</td><td>ARC_Spritesheet that ARC_Sprite will be pulled from </td></tr>
<tr><td class="paramname">frames</td><td><a class="el" href="../../d3/dac/structARC__Array.html" title="a type that holds an array of data and its size">ARC_Array</a> of bounds of sprite on spritesheet </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a37754370968f742ee6bfbb179a50804c" name="a37754370968f742ee6bfbb179a50804c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37754370968f742ee6bfbb179a50804c">&#9670;&#160;</a></span>ARC_Sprite_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroys ARC_Sprite type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa94ca232d44c6de7b4f00754152da02e" name="aa94ca232d44c6de7b4f00754152da02e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa94ca232d44c6de7b4f00754152da02e">&#9670;&#160;</a></span>ARC_Sprite_GetAllBounds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d3/dac/structARC__Array.html">ARC_Array</a> * ARC_Sprite_GetAllBounds </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the array of bounds that a sprite has </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite to get all the bounds from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a98ceee44610d603afd0ed235fd72cc95" name="a98ceee44610d603afd0ed235fd72cc95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98ceee44610d603afd0ed235fd72cc95">&#9670;&#160;</a></span>ARC_Sprite_GetBounds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> * ARC_Sprite_GetBounds </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the current bounds based on the ARC_Sprite's frames </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite to get bounds from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a001e727b8923a2435a873eb085e50308" name="a001e727b8923a2435a873eb085e50308"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a001e727b8923a2435a873eb085e50308">&#9670;&#160;</a></span>ARC_Sprite_GetFrameIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ARC_Sprite_GetFrameIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gets ARC_Sprite's current frame </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite to get frame from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>index ARC_Sprite's current frame index </dd></dl>
</div>
</div>
<a id="ae8f6efb1950a0e908efcd59b69427f38" name="ae8f6efb1950a0e908efcd59b69427f38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8f6efb1950a0e908efcd59b69427f38">&#9670;&#160;</a></span>ARC_Sprite_IterateFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_IterateFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>switches ARC_Sprite's frames to next for animation </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that is having its frame updated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0e2479255f39c245c08a8791aea5e877" name="a0e2479255f39c245c08a8791aea5e877"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e2479255f39c245c08a8791aea5e877">&#9670;&#160;</a></span>ARC_Sprite_Render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_Render </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *</td> <td class="paramname"><span class="paramname"><em>renderer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *</td> <td class="paramname"><span class="paramname"><em>renderBounds</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>renders ARC_Sprite type </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that will be rendered </td></tr>
<tr><td class="paramname">renderer</td><td>ARC_Renderer that is handling rendering </td></tr>
<tr><td class="paramname">renderBounds</td><td>area of renderer that ARC_Sprite will be rendered to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a96fa458abc8926631b646a8e89899474" name="a96fa458abc8926631b646a8e89899474"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a96fa458abc8926631b646a8e89899474">&#9670;&#160;</a></span>ARC_Sprite_RenderFlip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_RenderFlip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *</td> <td class="paramname"><span class="paramname"><em>renderer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *</td> <td class="paramname"><span class="paramname"><em>renderBounds</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a></td> <td class="paramname"><span class="paramname"><em>axis</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>renders ARC_Sprite type with flip </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that will be rendered </td></tr>
<tr><td class="paramname">renderer</td><td>ARC_Renderer that is handling rendering </td></tr>
<tr><td class="paramname">renderBounds</td><td>area of renderer that ARC_Sprite will be rendered to </td></tr>
<tr><td class="paramname">axis</td><td>axis to flip sprite </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a57c6332c153a9abd0906b822fc1614ef" name="a57c6332c153a9abd0906b822fc1614ef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a57c6332c153a9abd0906b822fc1614ef">&#9670;&#160;</a></span>ARC_Sprite_RenderRotated()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_RenderRotated </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *</td> <td class="paramname"><span class="paramname"><em>renderer</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *</td> <td class="paramname"><span class="paramname"><em>renderBounds</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> *</td> <td class="paramname"><span class="paramname"><em>center</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>angle</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>renders ARC_Sprite type with rotation </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that will be rendered </td></tr>
<tr><td class="paramname">renderer</td><td>ARC_Renderer that is handling rendering </td></tr>
<tr><td class="paramname">renderBounds</td><td>area of renderer that ARC_Sprite will be rendered to </td></tr>
<tr><td class="paramname">angle</td><td>angle to rotate ARC_Sprite </td></tr>
<tr><td class="paramname">center</td><td>point to rotate ARC_Sprite around </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae6bed9d1c4c5c7a5ced00b45672c94f9" name="ae6bed9d1c4c5c7a5ced00b45672c94f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6bed9d1c4c5c7a5ced00b45672c94f9">&#9670;&#160;</a></span>ARC_Sprite_SetFrameIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_SetFrameIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>index</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>switches ARC_Sprite's frame to specified index </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that is having its frame set </td></tr>
<tr><td class="paramname">index</td><td>uint32_t to set ARC_Sprite's frame index to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a93598bcc2eee0b8e3eb1a94ebbcf3e5e" name="a93598bcc2eee0b8e3eb1a94ebbcf3e5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93598bcc2eee0b8e3eb1a94ebbcf3e5e">&#9670;&#160;</a></span>ARC_Sprite_SetOpacity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Sprite_SetOpacity </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *</td> <td class="paramname"><span class="paramname"><em>sprite</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t</td> <td class="paramname"><span class="paramname"><em>opacity</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>sets ARC_Sprite's opacity </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sprite</td><td>ARC_Sprite that is changing opacity </td></tr>
<tr><td class="paramname">opacity</td><td>new opacity for ARC_Sprite</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>this is temp because opacity probably should be a value bigger than 255 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_169ca87d8ac185e5b51c45f4a68386c0.html">graphics</a></li><li class="navelem"><a class="el" href="../../db/d08/sprite_8h.html">sprite.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>

22
doc/doxygen/html/db/d08/sprite_8h.js Normal file
View file

@ -0,0 +1,22 @@
var sprite_8h =
[
[ "ARC_Sprite", "db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42", null ],
[ "ARC_Sprite_Axix", "db/d08/sprite_8h.html#a8975412b8ce43563bd9b9e8034d48107", null ],
[ "ARC_Sprite_Axis", "db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5", [
[ "ARC_SPRITE_AXIS_NONE", "db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008", null ],
[ "ARC_SPRITE_AXIS_Y", "db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0", null ],
[ "ARC_SPRITE_AXIS_X", "db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f", null ]
] ],
[ "ARC_Sprite_Copy", "db/d08/sprite_8h.html#ac71528b8b08e5c9f9ef12377413c887f", null ],
[ "ARC_Sprite_Create", "db/d08/sprite_8h.html#a236db372d25ec6939fc3a59a50174d2c", null ],
[ "ARC_Sprite_Destroy", "db/d08/sprite_8h.html#a37754370968f742ee6bfbb179a50804c", null ],
[ "ARC_Sprite_GetAllBounds", "db/d08/sprite_8h.html#aa94ca232d44c6de7b4f00754152da02e", null ],
[ "ARC_Sprite_GetBounds", "db/d08/sprite_8h.html#a98ceee44610d603afd0ed235fd72cc95", null ],
[ "ARC_Sprite_GetFrameIndex", "db/d08/sprite_8h.html#a001e727b8923a2435a873eb085e50308", null ],
[ "ARC_Sprite_IterateFrame", "db/d08/sprite_8h.html#ae8f6efb1950a0e908efcd59b69427f38", null ],
[ "ARC_Sprite_Render", "db/d08/sprite_8h.html#a0e2479255f39c245c08a8791aea5e877", null ],
[ "ARC_Sprite_RenderFlip", "db/d08/sprite_8h.html#a96fa458abc8926631b646a8e89899474", null ],
[ "ARC_Sprite_RenderRotated", "db/d08/sprite_8h.html#a57c6332c153a9abd0906b822fc1614ef", null ],
[ "ARC_Sprite_SetFrameIndex", "db/d08/sprite_8h.html#ae6bed9d1c4c5c7a5ced00b45672c94f9", null ],
[ "ARC_Sprite_SetOpacity", "db/d08/sprite_8h.html#a93598bcc2eee0b8e3eb1a94ebbcf3e5e", null ]
];

294
doc/doxygen/html/db/d08/sprite_8h_source.html Normal file
View file

@ -0,0 +1,294 @@
<!-- HTML header for doxygen 1.9.2-->
<!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" class="dark-mode">
<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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Archeus: /home/herbglitch/programs/archeus/arc/include/arc/graphics/sprite.h Source File</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>
<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"/>
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Archeus<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">A C library and game engine that focuses on documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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(1); });
/* @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('db/d08/sprite_8h_source.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="headertitle"><div class="title">sprite.h</div></div>
</div><!--header-->
<div class="contents">
<a href="../../db/d08/sprite_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef ARC_GRAPHICS_SPRITE_H_</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ARC_GRAPHICS_SPRITE_H_</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="../../d6/d85/renderer_8h.html">arc/graphics/renderer.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="../../d9/d53/spritesheet_8h.html">arc/graphics/spritesheet.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;<a class="code" href="../../d2/d91/point_8h.html">arc/math/point.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;<a class="code" href="../../d2/d14/math_2rectangle_8h.html">arc/math/rectangle.h</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;<a class="code" href="../../db/d63/array_8h.html">arc/std/array.h</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"></span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">/**</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * @brief a sprite type</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * </span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * @note the actual type should be define by overriding for a graphics api</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42"> 19</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> <a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a>;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"></span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/**</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment"> * @brief creates ARC_Sprite type</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"> * </span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment"> * @param sprite ARC_Sprite that is being created</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @param spritesheet ARC_Spritesheet that ARC_Sprite will be pulled from</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @param frames ARC_Array of bounds of sprite on spritesheet</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> */</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a236db372d25ec6939fc3a59a50174d2c"> 28</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#a236db372d25ec6939fc3a59a50174d2c">ARC_Sprite_Create</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> **sprite, <a class="code hl_typedef" href="../../d9/d53/spritesheet_8h.html#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *spritesheet, <a class="code hl_struct" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *frames);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment"></span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">/**</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"> * @brief destroys ARC_Sprite type</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * </span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param sprite ARC_Sprite to destroy</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> */</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a37754370968f742ee6bfbb179a50804c"> 35</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#a37754370968f742ee6bfbb179a50804c">ARC_Sprite_Destroy</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="comment"></span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment">/**</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment"> * @brief copies ARC_Sprite to a new ARC_Sprite</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * </span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param newSprite ARC_Sprite that is being copied to and created</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param oldSprite ARC_Sprite contents that are being copied</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> */</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#ac71528b8b08e5c9f9ef12377413c887f"> 43</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#ac71528b8b08e5c9f9ef12377413c887f">ARC_Sprite_Copy</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> **newSprite, <a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *oldSprite);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">//TODO: temp</span><span class="comment"></span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">/**</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @brief sets ARC_Sprite&#39;s opacity</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> *</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @param sprite ARC_Sprite that is changing opacity</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param opacity new opacity for ARC_Sprite</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> *</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> * @note this is temp because opacity probably should be a value</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment"> * bigger than 255</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment">*/</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a93598bcc2eee0b8e3eb1a94ebbcf3e5e"> 55</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#a93598bcc2eee0b8e3eb1a94ebbcf3e5e">ARC_Sprite_SetOpacity</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, uint8_t opacity);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"></span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment">/**</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @brief renders ARC_Sprite type</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * </span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> * @param sprite ARC_Sprite that will be rendered</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"> * @param renderer ARC_Renderer that is handling rendering</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"> * @param renderBounds area of renderer that ARC_Sprite will be rendered to</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> */</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a0e2479255f39c245c08a8791aea5e877"> 64</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#a0e2479255f39c245c08a8791aea5e877">ARC_Sprite_Render</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, <a class="code hl_typedef" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *renderBounds);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment">//TODO: move this to a better location</span></div>
<div class="foldopen" id="foldopen00067" data-start="{" data-end="};">
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5"> 67</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a> {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008"> 68</a></span> <a class="code hl_enumvalue" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008">ARC_SPRITE_AXIS_NONE</a> = 0x00,</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0"> 69</a></span> <a class="code hl_enumvalue" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0">ARC_SPRITE_AXIS_Y</a> = 0x01,</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f"> 70</a></span> <a class="code hl_enumvalue" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f">ARC_SPRITE_AXIS_X</a> = 0x02,</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a8975412b8ce43563bd9b9e8034d48107"> 71</a></span>} <a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a8975412b8ce43563bd9b9e8034d48107">ARC_Sprite_Axix</a>;</div>
</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"></span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">/**</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> * @brief renders ARC_Sprite type with flip</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * </span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @param sprite ARC_Sprite that will be rendered</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @param renderer ARC_Renderer that is handling rendering</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> * @param renderBounds area of renderer that ARC_Sprite will be rendered to</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> * @param axis axis to flip sprite</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> */</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a96fa458abc8926631b646a8e89899474"> 81</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#a96fa458abc8926631b646a8e89899474">ARC_Sprite_RenderFlip</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, <a class="code hl_typedef" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *renderBounds, <span class="keyword">enum</span> <a class="code hl_enumeration" href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a> axis);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"></span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment">/**</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @brief renders ARC_Sprite type with rotation</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * </span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @param sprite ARC_Sprite that will be rendered</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * @param renderer ARC_Renderer that is handling rendering</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> * @param renderBounds area of renderer that ARC_Sprite will be rendered to</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"> * @param angle angle to rotate ARC_Sprite</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"> * @param center point to rotate ARC_Sprite around</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> */</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a57c6332c153a9abd0906b822fc1614ef"> 92</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#a57c6332c153a9abd0906b822fc1614ef">ARC_Sprite_RenderRotated</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, <a class="code hl_typedef" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *renderBounds, <a class="code hl_struct" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> *center, <span class="keywordtype">double</span> angle);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"></span> </div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment">/**</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * @brief switches ARC_Sprite&#39;s frame to specified index</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> * </span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"> * @param sprite ARC_Sprite that is having its frame set</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"> * @param index uint32_t to set ARC_Sprite&#39;s frame index to</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> */</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#ae6bed9d1c4c5c7a5ced00b45672c94f9"> 100</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#ae6bed9d1c4c5c7a5ced00b45672c94f9">ARC_Sprite_SetFrameIndex</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite, uint32_t index);</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"></span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment">/**</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> * @brief switches ARC_Sprite&#39;s frames to next for animation</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment"> * </span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> * @param sprite ARC_Sprite that is having its frame updated</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> */</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#ae8f6efb1950a0e908efcd59b69427f38"> 107</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="../../db/d08/sprite_8h.html#ae8f6efb1950a0e908efcd59b69427f38">ARC_Sprite_IterateFrame</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment"></span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment">/**</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment"> * @brief gets ARC_Sprite&#39;s current frame</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"> * </span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> * @param sprite ARC_Sprite to get frame from</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"> *</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment"> * @return index ARC_Sprite&#39;s current frame index</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment"> */</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a001e727b8923a2435a873eb085e50308"> 116</a></span>uint32_t <a class="code hl_function" href="../../db/d08/sprite_8h.html#a001e727b8923a2435a873eb085e50308">ARC_Sprite_GetFrameIndex</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment"></span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment">/**</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment"> * @brief returns the current bounds based on the ARC_Sprite&#39;s frames</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment"> * </span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"> * @param sprite ARC_Sprite to get bounds from</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment"> */</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#a98ceee44610d603afd0ed235fd72cc95"> 123</a></span><a class="code hl_struct" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *<a class="code hl_function" href="../../db/d08/sprite_8h.html#a98ceee44610d603afd0ed235fd72cc95">ARC_Sprite_GetBounds</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment"></span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="comment">/**</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"> * @brief returns the array of bounds that a sprite has</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="comment"> *</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment"> * @param sprite ARC_Sprite to get all the bounds from</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment">*/</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="../../db/d08/sprite_8h.html#aa94ca232d44c6de7b4f00754152da02e"> 130</a></span><a class="code hl_struct" href="../../d3/dac/structARC__Array.html">ARC_Array</a> *<a class="code hl_function" href="../../db/d08/sprite_8h.html#aa94ca232d44c6de7b4f00754152da02e">ARC_Sprite_GetAllBounds</a>(<a class="code hl_typedef" href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a> *sprite);</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>}</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> </div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><span class="preprocessor">#endif </span><span class="comment">// !ARC_GRAPHICS_SPRITE_H_</span></div>
<div class="ttc" id="aarray_8h_html"><div class="ttname"><a href="../../db/d63/array_8h.html">array.h</a></div></div>
<div class="ttc" id="amath_2rectangle_8h_html"><div class="ttname"><a href="../../d2/d14/math_2rectangle_8h.html">rectangle.h</a></div></div>
<div class="ttc" id="apoint_8h_html"><div class="ttname"><a href="../../d2/d91/point_8h.html">point.h</a></div></div>
<div class="ttc" id="arenderer_8h_html"><div class="ttname"><a href="../../d6/d85/renderer_8h.html">renderer.h</a></div></div>
<div class="ttc" id="arenderer_8h_html_a2b82366dc421b3e80aace49f3ae8639a"><div class="ttname"><a href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a></div><div class="ttdeci">struct ARC_RendererType ARC_Renderer</div><div class="ttdef"><b>Definition</b> <a href="../../d6/d85/renderer_8h_source.html#l00016">renderer.h:16</a></div></div>
<div class="ttc" id="asprite_8h_html_a001e727b8923a2435a873eb085e50308"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a001e727b8923a2435a873eb085e50308">ARC_Sprite_GetFrameIndex</a></div><div class="ttdeci">uint32_t ARC_Sprite_GetFrameIndex(ARC_Sprite *sprite)</div><div class="ttdoc">gets ARC_Sprite's current frame</div></div>
<div class="ttc" id="asprite_8h_html_a03c5973e40c2bda444c06c7550471b42"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a03c5973e40c2bda444c06c7550471b42">ARC_Sprite</a></div><div class="ttdeci">struct ARC_Sprite ARC_Sprite</div><div class="ttdoc">a sprite type</div><div class="ttdef"><b>Definition</b> <a href="#l00019">sprite.h:19</a></div></div>
<div class="ttc" id="asprite_8h_html_a0e2479255f39c245c08a8791aea5e877"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a0e2479255f39c245c08a8791aea5e877">ARC_Sprite_Render</a></div><div class="ttdeci">void ARC_Sprite_Render(ARC_Sprite *sprite, ARC_Renderer *renderer, ARC_Rect *renderBounds)</div><div class="ttdoc">renders ARC_Sprite type</div></div>
<div class="ttc" id="asprite_8h_html_a236db372d25ec6939fc3a59a50174d2c"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a236db372d25ec6939fc3a59a50174d2c">ARC_Sprite_Create</a></div><div class="ttdeci">void ARC_Sprite_Create(ARC_Sprite **sprite, ARC_Spritesheet *spritesheet, ARC_Array *frames)</div><div class="ttdoc">creates ARC_Sprite type</div></div>
<div class="ttc" id="asprite_8h_html_a37754370968f742ee6bfbb179a50804c"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a37754370968f742ee6bfbb179a50804c">ARC_Sprite_Destroy</a></div><div class="ttdeci">void ARC_Sprite_Destroy(ARC_Sprite *sprite)</div><div class="ttdoc">destroys ARC_Sprite type</div></div>
<div class="ttc" id="asprite_8h_html_a57c6332c153a9abd0906b822fc1614ef"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a57c6332c153a9abd0906b822fc1614ef">ARC_Sprite_RenderRotated</a></div><div class="ttdeci">void ARC_Sprite_RenderRotated(ARC_Sprite *sprite, ARC_Renderer *renderer, ARC_Rect *renderBounds, ARC_Point *center, double angle)</div><div class="ttdoc">renders ARC_Sprite type with rotation</div></div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5">ARC_Sprite_Axis</a></div><div class="ttdeci">ARC_Sprite_Axis</div><div class="ttdef"><b>Definition</b> <a href="#l00067">sprite.h:67</a></div></div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a1cccd14ed492d5e4b151808984cda3c0">ARC_SPRITE_AXIS_Y</a></div><div class="ttdeci">@ ARC_SPRITE_AXIS_Y</div><div class="ttdef"><b>Definition</b> <a href="#l00069">sprite.h:69</a></div></div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a8349cec50345d927a52c3a74dc7c8008">ARC_SPRITE_AXIS_NONE</a></div><div class="ttdeci">@ ARC_SPRITE_AXIS_NONE</div><div class="ttdef"><b>Definition</b> <a href="#l00068">sprite.h:68</a></div></div>
<div class="ttc" id="asprite_8h_html_a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a58f03c421534fd75dbdf5b301fff84f5a86b6c238d4da4d62c0e5f7652a1a058f">ARC_SPRITE_AXIS_X</a></div><div class="ttdeci">@ ARC_SPRITE_AXIS_X</div><div class="ttdef"><b>Definition</b> <a href="#l00070">sprite.h:70</a></div></div>
<div class="ttc" id="asprite_8h_html_a8975412b8ce43563bd9b9e8034d48107"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a8975412b8ce43563bd9b9e8034d48107">ARC_Sprite_Axix</a></div><div class="ttdeci">enum ARC_Sprite_Axis ARC_Sprite_Axix</div></div>
<div class="ttc" id="asprite_8h_html_a93598bcc2eee0b8e3eb1a94ebbcf3e5e"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a93598bcc2eee0b8e3eb1a94ebbcf3e5e">ARC_Sprite_SetOpacity</a></div><div class="ttdeci">void ARC_Sprite_SetOpacity(ARC_Sprite *sprite, uint8_t opacity)</div><div class="ttdoc">sets ARC_Sprite's opacity</div></div>
<div class="ttc" id="asprite_8h_html_a96fa458abc8926631b646a8e89899474"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a96fa458abc8926631b646a8e89899474">ARC_Sprite_RenderFlip</a></div><div class="ttdeci">void ARC_Sprite_RenderFlip(ARC_Sprite *sprite, ARC_Renderer *renderer, ARC_Rect *renderBounds, enum ARC_Sprite_Axis axis)</div><div class="ttdoc">renders ARC_Sprite type with flip</div></div>
<div class="ttc" id="asprite_8h_html_a98ceee44610d603afd0ed235fd72cc95"><div class="ttname"><a href="../../db/d08/sprite_8h.html#a98ceee44610d603afd0ed235fd72cc95">ARC_Sprite_GetBounds</a></div><div class="ttdeci">ARC_Rect * ARC_Sprite_GetBounds(ARC_Sprite *sprite)</div><div class="ttdoc">returns the current bounds based on the ARC_Sprite's frames</div></div>
<div class="ttc" id="asprite_8h_html_aa94ca232d44c6de7b4f00754152da02e"><div class="ttname"><a href="../../db/d08/sprite_8h.html#aa94ca232d44c6de7b4f00754152da02e">ARC_Sprite_GetAllBounds</a></div><div class="ttdeci">ARC_Array * ARC_Sprite_GetAllBounds(ARC_Sprite *sprite)</div><div class="ttdoc">returns the array of bounds that a sprite has</div></div>
<div class="ttc" id="asprite_8h_html_ac71528b8b08e5c9f9ef12377413c887f"><div class="ttname"><a href="../../db/d08/sprite_8h.html#ac71528b8b08e5c9f9ef12377413c887f">ARC_Sprite_Copy</a></div><div class="ttdeci">void ARC_Sprite_Copy(ARC_Sprite **newSprite, ARC_Sprite *oldSprite)</div><div class="ttdoc">copies ARC_Sprite to a new ARC_Sprite</div></div>
<div class="ttc" id="asprite_8h_html_ae6bed9d1c4c5c7a5ced00b45672c94f9"><div class="ttname"><a href="../../db/d08/sprite_8h.html#ae6bed9d1c4c5c7a5ced00b45672c94f9">ARC_Sprite_SetFrameIndex</a></div><div class="ttdeci">void ARC_Sprite_SetFrameIndex(ARC_Sprite *sprite, uint32_t index)</div><div class="ttdoc">switches ARC_Sprite's frame to specified index</div></div>
<div class="ttc" id="asprite_8h_html_ae8f6efb1950a0e908efcd59b69427f38"><div class="ttname"><a href="../../db/d08/sprite_8h.html#ae8f6efb1950a0e908efcd59b69427f38">ARC_Sprite_IterateFrame</a></div><div class="ttdeci">void ARC_Sprite_IterateFrame(ARC_Sprite *sprite)</div><div class="ttdoc">switches ARC_Sprite's frames to next for animation</div></div>
<div class="ttc" id="aspritesheet_8h_html"><div class="ttname"><a href="../../d9/d53/spritesheet_8h.html">spritesheet.h</a></div></div>
<div class="ttc" id="aspritesheet_8h_html_a1e01dfc3d163e82e7d00d039f0e0a82c"><div class="ttname"><a href="../../d9/d53/spritesheet_8h.html#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a></div><div class="ttdeci">struct ARC_Spritesheet ARC_Spritesheet</div><div class="ttdef"><b>Definition</b> <a href="../../d9/d53/spritesheet_8h_source.html#l00014">spritesheet.h:14</a></div></div>
<div class="ttc" id="astructARC__Array_html"><div class="ttname"><a href="../../d3/dac/structARC__Array.html">ARC_Array</a></div><div class="ttdoc">a type that holds an array of data and its size</div><div class="ttdef"><b>Definition</b> <a href="../../db/d63/array_8h_source.html#l00013">array.h:13</a></div></div>
<div class="ttc" id="astructARC__Point_html"><div class="ttname"><a href="../../d2/d9d/structARC__Point.html">ARC_Point</a></div><div class="ttdef"><b>Definition</b> <a href="../../d2/d91/point_8h_source.html#l00010">point.h:10</a></div></div>
<div class="ttc" id="astructARC__Rect_html"><div class="ttname"><a href="../../d0/d18/structARC__Rect.html">ARC_Rect</a></div><div class="ttdef"><b>Definition</b> <a href="../../d2/d14/math_2rectangle_8h_source.html#l00012">rectangle.h:12</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.9.2-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul><li class="navelem"><a class="el" href="../../dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="../../dir_8698ff38f6ae643760cdad826b9d4736.html">arc</a></li><li class="navelem"><a class="el" href="../../dir_169ca87d8ac185e5b51c45f4a68386c0.html">graphics</a></li><li class="navelem"><a class="el" href="../../db/d08/sprite_8h.html">sprite.h</a></li></ul>
</div>
<script type="text/javascript">
// script for doxygen 1.9.1
$(function() {
toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
toggleButton.title = "Toggle Light/Dark Mode"
$(document).ready(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
$(window).resize(function(){
document.getElementById("MSearchBox").parentNode.appendChild(toggleButton)
})
})
</script>
</body>
</html>