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

223
doc/doxygen/html/db/d45/structARC__Sprite.html Normal file
View file

@ -0,0 +1,223 @@
<!-- 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: ARC_Sprite Struct 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/d45/structARC__Sprite.html','../../'); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">ARC_Sprite Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a00d1c869b02b259cbb6a832d658f9f77" id="r_a00d1c869b02b259cbb6a832d658f9f77"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d41/structARC__Spritesheet.html">ARC_Spritesheet</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a00d1c869b02b259cbb6a832d658f9f77">spritesheet</a></td></tr>
<tr class="separator:a00d1c869b02b259cbb6a832d658f9f77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec6a8a578b6a0f3569108e8beb4f9ea0" id="r_aec6a8a578b6a0f3569108e8beb4f9ea0"><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="#aec6a8a578b6a0f3569108e8beb4f9ea0">frames</a></td></tr>
<tr class="separator:aec6a8a578b6a0f3569108e8beb4f9ea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8466f91297108bba6c33e8f5267ac19" id="r_ae8466f91297108bba6c33e8f5267ac19"><td class="memItemLeft" align="right" valign="top">uint32_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8466f91297108bba6c33e8f5267ac19">frameIndex</a></td></tr>
<tr class="separator:ae8466f91297108bba6c33e8f5267ac19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a926dee148e71ef30aaef10fc9205379d" id="r_a926dee148e71ef30aaef10fc9205379d"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a926dee148e71ef30aaef10fc9205379d">opacity</a></td></tr>
<tr class="separator:a926dee148e71ef30aaef10fc9205379d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html#l00007">7</a> of file <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ae8466f91297108bba6c33e8f5267ac19" name="ae8466f91297108bba6c33e8f5267ac19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8466f91297108bba6c33e8f5267ac19">&#9670;&#160;</a></span>frameIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t* ARC_Sprite::frameIndex</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html#l00010">10</a> of file <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00024">ARC_Sprite_Copy()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00084">ARC_Sprite_GetBounds()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00080">ARC_Sprite_GetFrameIndex()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00072">ARC_Sprite_IterateFrame()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00036">ARC_Sprite_Render()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00042">ARC_Sprite_RenderFlip()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00057">ARC_Sprite_RenderRotated()</a>, and <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00063">ARC_Sprite_SetFrameIndex()</a>.</p>
</div>
</div>
<a id="aec6a8a578b6a0f3569108e8beb4f9ea0" name="aec6a8a578b6a0f3569108e8beb4f9ea0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec6a8a578b6a0f3569108e8beb4f9ea0">&#9670;&#160;</a></span>frames</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::frames</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html#l00009">9</a> of file <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00024">ARC_Sprite_Copy()</a>, <a class="el" href="../../d9/d34/packages_2graphics_2sdl_2config_8c_source.html#l00277">ARC_Sprite_Delete()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00088">ARC_Sprite_GetAllBounds()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00084">ARC_Sprite_GetBounds()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00072">ARC_Sprite_IterateFrame()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00036">ARC_Sprite_Render()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00042">ARC_Sprite_RenderFlip()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00057">ARC_Sprite_RenderRotated()</a>, and <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00063">ARC_Sprite_SetFrameIndex()</a>.</p>
</div>
</div>
<a id="a926dee148e71ef30aaef10fc9205379d" name="a926dee148e71ef30aaef10fc9205379d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a926dee148e71ef30aaef10fc9205379d">&#9670;&#160;</a></span>opacity</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ARC_Sprite::opacity</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html#l00012">12</a> of file <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00036">ARC_Sprite_Render()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00042">ARC_Sprite_RenderFlip()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00057">ARC_Sprite_RenderRotated()</a>, and <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00032">ARC_Sprite_SetOpacity()</a>.</p>
</div>
</div>
<a id="a00d1c869b02b259cbb6a832d658f9f77" name="a00d1c869b02b259cbb6a832d658f9f77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00d1c869b02b259cbb6a832d658f9f77">&#9670;&#160;</a></span>spritesheet</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="../../d0/d41/structARC__Spritesheet.html">ARC_Spritesheet</a>* ARC_Sprite::spritesheet</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html#l00008">8</a> of file <a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00024">ARC_Sprite_Copy()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00011">ARC_Sprite_Create()</a>, <a class="el" href="../../d9/d34/packages_2graphics_2sdl_2config_8c_source.html#l00277">ARC_Sprite_Delete()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00036">ARC_Sprite_Render()</a>, <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00042">ARC_Sprite_RenderFlip()</a>, and <a class="el" href="../../d2/d1a/packages_2graphics_2sdl_2sprite_8c_source.html#l00057">ARC_Sprite_RenderRotated()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/herbglitch/programs/archeus/arc/packages/graphics/sdl/<a class="el" href="../../d1/d88/packages_2graphics_2sdl_2sprite_8h_source.html">sprite.h</a></li>
</ul>
</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="../../db/d45/structARC__Sprite.html">ARC_Sprite</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>

7
doc/doxygen/html/db/d45/structARC__Sprite.js Normal file
View file

@ -0,0 +1,7 @@
var structARC__Sprite =
[
[ "frameIndex", "db/d45/structARC__Sprite.html#ae8466f91297108bba6c33e8f5267ac19", null ],
[ "frames", "db/d45/structARC__Sprite.html#aec6a8a578b6a0f3569108e8beb4f9ea0", null ],
[ "opacity", "db/d45/structARC__Sprite.html#a926dee148e71ef30aaef10fc9205379d", null ],
[ "spritesheet", "db/d45/structARC__Sprite.html#a00d1c869b02b259cbb6a832d658f9f77", null ]
];