herbglitch/archeus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
archeus/doc/doxygen/html/d9/d53/spritesheet_8h.html

284 lines
16 KiB
HTML
Raw Normal View History

started woking on figuring out doxygen documentation and added readme
2024-12-24 03:47:16 -07:00
<!-- 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/spritesheet.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('d9/d53/spritesheet_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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">spritesheet.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</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="../../d6/d85/renderer_8h_source.html">arc/graphics/renderer.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="../../da/d66/string_8h_source.html">arc/std/string.h</a>&quot;</code><br />
</div>
<p><a href="../../d9/d53/spritesheet_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:a1e01dfc3d163e82e7d00d039f0e0a82c" id="r_a1e01dfc3d163e82e7d00d039f0e0a82c"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a></td></tr>
<tr class="separator:a1e01dfc3d163e82e7d00d039f0e0a82c"><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:a07d3eb2716f237551fb29dc425a14870" id="r_a07d3eb2716f237551fb29dc425a14870"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07d3eb2716f237551fb29dc425a14870">ARC_Spritesheet_CreateFromFile</a> (<a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> **spritesheet, <a class="el" href="../../d6/d85/renderer_8h.html#a2b82366dc421b3e80aace49f3ae8639a">ARC_Renderer</a> *renderer, <a class="el" href="../../df/d06/structARC__String.html">ARC_String</a> *path)</td></tr>
<tr class="separator:a07d3eb2716f237551fb29dc425a14870"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abef4c60c51ed55e11b67c33073092811" id="r_abef4c60c51ed55e11b67c33073092811"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abef4c60c51ed55e11b67c33073092811">ARC_Spritesheet_Destroy</a> (<a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *spritesheet)</td></tr>
<tr class="separator:abef4c60c51ed55e11b67c33073092811"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2943ba8a63fa94ad9ddff7ecc3b2dc7" id="r_ab2943ba8a63fa94ad9ddff7ecc3b2dc7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2943ba8a63fa94ad9ddff7ecc3b2dc7">ARC_Spritesheet_RenderArea</a> (<a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *spritesheet, <a class="el" href="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *sheetBounds, <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="separator:ab2943ba8a63fa94ad9ddff7ecc3b2dc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87bd15ebf4a1ebebe8f8033dd55c0142" id="r_a87bd15ebf4a1ebebe8f8033dd55c0142"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87bd15ebf4a1ebebe8f8033dd55c0142">ARC_Spritesheet_GetSize</a> (<a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *spritesheet)</td></tr>
<tr class="separator:a87bd15ebf4a1ebebe8f8033dd55c0142"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6881e1db0e3ccf7aec5b97d59cc558c6" id="r_a6881e1db0e3ccf7aec5b97d59cc558c6"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6881e1db0e3ccf7aec5b97d59cc558c6">ARC_Spritesheet_GetTileSize</a> (<a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *spritesheet)</td></tr>
<tr class="separator:a6881e1db0e3ccf7aec5b97d59cc558c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a1e01dfc3d163e82e7d00d039f0e0a82c" name="a1e01dfc3d163e82e7d00d039f0e0a82c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e01dfc3d163e82e7d00d039f0e0a82c">&#9670;&#160;</a></span>ARC_Spritesheet</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> <a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d9/d53/spritesheet_8h_source.html#l00014">14</a> of file <a class="el" href="../../d9/d53/spritesheet_8h_source.html">spritesheet.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a07d3eb2716f237551fb29dc425a14870" name="a07d3eb2716f237551fb29dc425a14870"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07d3eb2716f237551fb29dc425a14870">&#9670;&#160;</a></span>ARC_Spritesheet_CreateFromFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Spritesheet_CreateFromFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#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="../../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="../../df/d06/structARC__String.html">ARC_String</a> *</td> <td class="paramname"><span class="paramname"><em>path</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abef4c60c51ed55e11b67c33073092811" name="abef4c60c51ed55e11b67c33073092811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abef4c60c51ed55e11b67c33073092811">&#9670;&#160;</a></span>ARC_Spritesheet_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Spritesheet_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *</td> <td class="paramname"><span class="paramname"><em>spritesheet</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a87bd15ebf4a1ebebe8f8033dd55c0142" name="a87bd15ebf4a1ebebe8f8033dd55c0142"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87bd15ebf4a1ebebe8f8033dd55c0142">&#9670;&#160;</a></span>ARC_Spritesheet_GetSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d2/d9d/structARC__Point.html">ARC_Point</a> ARC_Spritesheet_GetSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *</td> <td class="paramname"><span class="paramname"><em>spritesheet</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a6881e1db0e3ccf7aec5b97d59cc558c6" name="a6881e1db0e3ccf7aec5b97d59cc558c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6881e1db0e3ccf7aec5b97d59cc558c6">&#9670;&#160;</a></span>ARC_Spritesheet_GetTileSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t * ARC_Spritesheet_GetTileSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#a1e01dfc3d163e82e7d00d039f0e0a82c">ARC_Spritesheet</a> *</td> <td class="paramname"><span class="paramname"><em>spritesheet</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab2943ba8a63fa94ad9ddff7ecc3b2dc7" name="ab2943ba8a63fa94ad9ddff7ecc3b2dc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2943ba8a63fa94ad9ddff7ecc3b2dc7">&#9670;&#160;</a></span>ARC_Spritesheet_RenderArea()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ARC_Spritesheet_RenderArea </td>
<td>(</td>
<td class="paramtype"><a class="el" href="#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="../../d0/d18/structARC__Rect.html">ARC_Rect</a> *</td> <td class="paramname"><span class="paramname"><em>sheetBounds</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">
</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="../../d9/d53/spritesheet_8h.html">spritesheet.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>
Reference in a new issue Copy permalink