blob: 5c0ece381d739d14db2ba3a2b517cfeeacbf0b93 [file] [log] [blame] [edit]
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>32blit API: graphics/tilemap.hpp 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="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
</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">32blit API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('tilemap_8hpp_source.html',''); initResizable(); });
/* @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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">tilemap.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;cstdint&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;../32blit.hpp&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &quot;../types/size.hpp&quot;</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;../types/point.hpp&quot;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;../types/mat3.hpp&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceblit.html">blit</a> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="namespaceblit.html#aa7ace6db758861161c7f20b0eb8dc69f"> 12</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="namespaceblit.html#aa7ace6db758861161c7f20b0eb8dc69f">TMXFlags</a> {</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; TMX_16Bit = (1 &lt;&lt; 0), </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <a class="code" href="namespaceblit.html#aa7ace6db758861161c7f20b0eb8dc69fa7f53627e8a802607be1336c0d89ad6af">TMX_Transforms</a> = (1 &lt;&lt; 1) </div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceblit.html#aa7ace6db758861161c7f20b0eb8dc69fa7f53627e8a802607be1336c0d89ad6af"> 15</a></span>&#160; };</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"> #pragma pack(push,1)</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structblit_1_1TMX.html"> 19</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1TMX.html">TMX</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordtype">char</span> head[4];</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; uint16_t header_length;</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; uint16_t flags;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; uint16_t empty_tile;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; uint16_t width;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; uint16_t height;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; uint16_t layers;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; uint8_t data[];</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; };</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor"> #pragma pack(pop)</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="comment">// A `tilemap` describes a grid of tiles with optional transforms</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structblit_1_1TileMap.html"> 33</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structblit_1_1TileMap.html">TileMap</a> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="structblit_1_1Size.html">Size</a> bounds;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; uint8_t *tiles;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; uint8_t *transforms;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="structblit_1_1Surface.html">Surface</a> *sprites;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structblit_1_1Mat3.html">Mat3</a> transform = Mat3::identity();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; NONE = 0, <span class="comment">// draw nothing</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; REPEAT = 1, <span class="comment">// infinite repeat</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; DEFAULT_FILL = 2, <span class="comment">// fill with default tile</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; CLAMP_TO_EDGE = 3, <span class="comment">// repeats the tile at the edge</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; } repeat_mode = NONE; <span class="comment">// determines what to do when drawing outside of the layer bounds.</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; uint8_t default_tile_id;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordtype">int</span> empty_tile_id = -1;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">enum</span> LoadFlags {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; copy_tiles = (1 &lt;&lt; 0),</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; copy_transforms = (1 &lt;&lt; 1)</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; };</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="structblit_1_1TileMap.html#aace7ea2806f3debeccf552a37bb9d96d">TileMap</a>(uint8_t *tiles, uint8_t *transforms, <a class="code" href="structblit_1_1Size.html">Size</a> bounds, <a class="code" href="structblit_1_1Surface.html">Surface</a> *sprites);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keyword">static</span> <a class="code" href="structblit_1_1TileMap.html">TileMap</a> *load_tmx(<span class="keyword">const</span> uint8_t *asset, <a class="code" href="structblit_1_1Surface.html">Surface</a> *sprites, <span class="keywordtype">int</span> layer = 0, <span class="keywordtype">int</span> flags = copy_tiles | copy_transforms);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keyword">inline</span> int32_t offset(<span class="keyword">const</span> <a class="code" href="structblit_1_1Point.html">Point</a> &amp;p) {<span class="keywordflow">return</span> offset(p.x, p.y);} <span class="comment">// __attribute__((always_inline));</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; int32_t offset(int16_t x, int16_t y); <span class="comment">// __attribute__((always_inline));</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; uint8_t <a class="code" href="structblit_1_1TileMap.html#ae046d828377b810f4cb74ca6856ce4e1">tile_at</a>(<span class="keyword">const</span> <a class="code" href="structblit_1_1Point.html">Point</a> &amp;p); <span class="comment">// __attribute__((always_inline));</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; uint8_t <a class="code" href="structblit_1_1TileMap.html#a39884b6ea0d627b0371cdb7be5445be9">transform_at</a>(<span class="keyword">const</span> <a class="code" href="structblit_1_1Point.html">Point</a> &amp;p); <span class="comment">// __attribute__((always_inline));</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structblit_1_1TileMap.html#af8d409972ea5f4afeaf8fbfeaa8d4a8b">draw</a>(<a class="code" href="structblit_1_1Surface.html">Surface</a> *dest, <a class="code" href="structblit_1_1Rect.html">Rect</a> viewport, std::function&lt;<a class="code" href="structblit_1_1Mat3.html">Mat3</a>(uint8_t)&gt; scanline_callback = <span class="keyword">nullptr</span>);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">// void mipmap_texture_span(surface *dest, point s, uint16_t c, vec2 swc, vec2 ewc);</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">void</span> <a class="code" href="structblit_1_1TileMap.html#ab99ad5ad604dcac3a23060a29b90a46d">texture_span</a>(<a class="code" href="structblit_1_1Surface.html">Surface</a> *dest, <a class="code" href="structblit_1_1Point.html">Point</a> s, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> c, <a class="code" href="structblit_1_1Vec2.html">Vec2</a> swc, <a class="code" href="structblit_1_1Vec2.html">Vec2</a> ewc);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; };</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;}</div>
<div class="ttc" id="anamespaceblit_html"><div class="ttname"><a href="namespaceblit.html">blit</a></div><div class="ttdef"><b>Definition:</b> audio.cpp:10</div></div>
<div class="ttc" id="anamespaceblit_html_aa7ace6db758861161c7f20b0eb8dc69f"><div class="ttname"><a href="namespaceblit.html#aa7ace6db758861161c7f20b0eb8dc69f">blit::TMXFlags</a></div><div class="ttdeci">TMXFlags</div><div class="ttdef"><b>Definition:</b> tilemap.hpp:12</div></div>
<div class="ttc" id="anamespaceblit_html_aa7ace6db758861161c7f20b0eb8dc69fa7f53627e8a802607be1336c0d89ad6af"><div class="ttname"><a href="namespaceblit.html#aa7ace6db758861161c7f20b0eb8dc69fa7f53627e8a802607be1336c0d89ad6af">blit::TMX_Transforms</a></div><div class="ttdeci">@ TMX_Transforms</div><div class="ttdoc">tile data is 16-bit</div><div class="ttdef"><b>Definition:</b> tilemap.hpp:14</div></div>
<div class="ttc" id="astructblit_1_1Mat3_html"><div class="ttname"><a href="structblit_1_1Mat3.html">blit::Mat3</a></div><div class="ttdef"><b>Definition:</b> mat3.hpp:6</div></div>
<div class="ttc" id="astructblit_1_1Point_html"><div class="ttname"><a href="structblit_1_1Point.html">blit::Point</a></div><div class="ttdef"><b>Definition:</b> point.hpp:10</div></div>
<div class="ttc" id="astructblit_1_1Rect_html"><div class="ttname"><a href="structblit_1_1Rect.html">blit::Rect</a></div><div class="ttdef"><b>Definition:</b> rect.hpp:11</div></div>
<div class="ttc" id="astructblit_1_1Size_html"><div class="ttname"><a href="structblit_1_1Size.html">blit::Size</a></div><div class="ttdef"><b>Definition:</b> size.hpp:9</div></div>
<div class="ttc" id="astructblit_1_1Surface_html"><div class="ttname"><a href="structblit_1_1Surface.html">blit::Surface</a></div><div class="ttdef"><b>Definition:</b> surface.hpp:112</div></div>
<div class="ttc" id="astructblit_1_1TMX_html"><div class="ttname"><a href="structblit_1_1TMX.html">blit::TMX</a></div><div class="ttdoc">struct header generated by the output_struct option</div><div class="ttdef"><b>Definition:</b> tilemap.hpp:19</div></div>
<div class="ttc" id="astructblit_1_1TileMap_html"><div class="ttname"><a href="structblit_1_1TileMap.html">blit::TileMap</a></div><div class="ttdef"><b>Definition:</b> tilemap.hpp:33</div></div>
<div class="ttc" id="astructblit_1_1TileMap_html_a39884b6ea0d627b0371cdb7be5445be9"><div class="ttname"><a href="structblit_1_1TileMap.html#a39884b6ea0d627b0371cdb7be5445be9">blit::TileMap::transform_at</a></div><div class="ttdeci">uint8_t transform_at(const Point &amp;p)</div><div class="ttdef"><b>Definition:</b> tilemap.cpp:115</div></div>
<div class="ttc" id="astructblit_1_1TileMap_html_aace7ea2806f3debeccf552a37bb9d96d"><div class="ttname"><a href="structblit_1_1TileMap.html#aace7ea2806f3debeccf552a37bb9d96d">blit::TileMap::TileMap</a></div><div class="ttdeci">TileMap(uint8_t *tiles, uint8_t *transforms, Size bounds, Surface *sprites)</div><div class="ttdef"><b>Definition:</b> tilemap.cpp:16</div></div>
<div class="ttc" id="astructblit_1_1TileMap_html_ab99ad5ad604dcac3a23060a29b90a46d"><div class="ttname"><a href="structblit_1_1TileMap.html#ab99ad5ad604dcac3a23060a29b90a46d">blit::TileMap::texture_span</a></div><div class="ttdeci">void texture_span(Surface *dest, Point s, unsigned int c, Vec2 swc, Vec2 ewc)</div><div class="ttdef"><b>Definition:</b> tilemap.cpp:182</div></div>
<div class="ttc" id="astructblit_1_1TileMap_html_ae046d828377b810f4cb74ca6856ce4e1"><div class="ttname"><a href="structblit_1_1TileMap.html#ae046d828377b810f4cb74ca6856ce4e1">blit::TileMap::tile_at</a></div><div class="ttdeci">uint8_t tile_at(const Point &amp;p)</div><div class="ttdef"><b>Definition:</b> tilemap.cpp:100</div></div>
<div class="ttc" id="astructblit_1_1TileMap_html_af8d409972ea5f4afeaf8fbfeaa8d4a8b"><div class="ttname"><a href="structblit_1_1TileMap.html#af8d409972ea5f4afeaf8fbfeaa8d4a8b">blit::TileMap::draw</a></div><div class="ttdeci">void draw(Surface *dest, Rect viewport, std::function&lt; Mat3(uint8_t)&gt; scanline_callback=nullptr)</div><div class="ttdef"><b>Definition:</b> tilemap.cpp:131</div></div>
<div class="ttc" id="astructblit_1_1Vec2_html"><div class="ttname"><a href="structblit_1_1Vec2.html">blit::Vec2</a></div><div class="ttdef"><b>Definition:</b> vec2.hpp:9</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e79632891301b850df87e9c0030293fa.html">graphics</a></li><li class="navelem"><b>tilemap.hpp</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>