zoriya/ComSquare
1
0
Fork 0
mirror of https://github.com/zoriya/ComSquare.git synced 2026-05-27 16:21:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
ComSquare/classComSquare_1_1PPU_1_1TileRenderer.html
T
AnonymusRaccoon d33b0ab52d Deploying the doc
2021-07-13 21:32:24 +00:00

665 lines
34 KiB
HTML
Raw Permalink Blame History

<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ComSquare: ComSquare::PPU::TileRenderer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<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">ComSquare
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceComSquare.html">ComSquare</a></li><li class="navelem"><a class="el" href="namespaceComSquare_1_1PPU.html">PPU</a></li><li class="navelem"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a> &#124;
<a href="classComSquare_1_1PPU_1_1TileRenderer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ComSquare::PPU::TileRenderer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="TileRenderer_8hpp_source.html">TileRenderer.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ComSquare::PPU::TileRenderer:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classComSquare_1_1PPU_1_1TileRenderer__coll__graph.svg" width="262" height="1186"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adf5049b7b40c4b96700e24864326f951"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#adf5049b7b40c4b96700e24864326f951">setPaletteIndex</a> (int paletteIndex)</td></tr>
<tr class="memdesc:adf5049b7b40c4b96700e24864326f951"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the palette to use for render (index of palette) <a href="classComSquare_1_1PPU_1_1TileRenderer.html#adf5049b7b40c4b96700e24864326f951">More...</a><br /></td></tr>
<tr class="separator:adf5049b7b40c4b96700e24864326f951"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca91ac9ac3b1dc3cb0549018dfe28d48"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#aca91ac9ac3b1dc3cb0549018dfe28d48">setBpp</a> (int bpp)</td></tr>
<tr class="memdesc:aca91ac9ac3b1dc3cb0549018dfe28d48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the bpp to render graphics. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#aca91ac9ac3b1dc3cb0549018dfe28d48">More...</a><br /></td></tr>
<tr class="separator:aca91ac9ac3b1dc3cb0549018dfe28d48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0f6764ac171190eaaa5366fd271a85e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#ab0f6764ac171190eaaa5366fd271a85e">getBpp</a> () const</td></tr>
<tr class="memdesc:ab0f6764ac171190eaaa5366fd271a85e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current bpp. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#ab0f6764ac171190eaaa5366fd271a85e">More...</a><br /></td></tr>
<tr class="separator:ab0f6764ac171190eaaa5366fd271a85e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaff14ae8f6b97b429a95ae5c38704b99"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#aaff14ae8f6b97b429a95ae5c38704b99">getPaletteIndex</a> () const</td></tr>
<tr class="memdesc:aaff14ae8f6b97b429a95ae5c38704b99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the index of the current palette used. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#aaff14ae8f6b97b429a95ae5c38704b99">More...</a><br /></td></tr>
<tr class="separator:aaff14ae8f6b97b429a95ae5c38704b99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e6d5fc0697f982e9af9c1f70fe79ab"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a99e6d5fc0697f982e9af9c1f70fe79ab">getPixelReferenceFromTile</a> (uint16_t tileAddress, uint8_t pixelIndex)</td></tr>
<tr class="memdesc:a99e6d5fc0697f982e9af9c1f70fe79ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the color pixel reference from the tile address and pixelIndex. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a99e6d5fc0697f982e9af9c1f70fe79ab">More...</a><br /></td></tr>
<tr class="separator:a99e6d5fc0697f982e9af9c1f70fe79ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70c3dac78b84b4f94e8ff349c0a929e1"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a70c3dac78b84b4f94e8ff349c0a929e1">getPixelReferenceFromTileRow</a> (uint16_t tileRowAddress, uint8_t pixelIndex)</td></tr>
<tr class="memdesc:a70c3dac78b84b4f94e8ff349c0a929e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the color reference of a pixel from the address of the row. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a70c3dac78b84b4f94e8ff349c0a929e1">More...</a><br /></td></tr>
<tr class="separator:a70c3dac78b84b4f94e8ff349c0a929e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39e7226eeeb3346d6a040a14ce17f3f8"><td class="memItemLeft" align="right" valign="top">std::vector&lt; uint16_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a39e7226eeeb3346d6a040a14ce17f3f8">getPalette</a> (int nbPalette)</td></tr>
<tr class="memdesc:a39e7226eeeb3346d6a040a14ce17f3f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gives the actual selected palette with all of it's colors. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a39e7226eeeb3346d6a040a14ce17f3f8">More...</a><br /></td></tr>
<tr class="separator:a39e7226eeeb3346d6a040a14ce17f3f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aa1530994bdec0ff7bbe9b6d45d1814"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a4aa1530994bdec0ff7bbe9b6d45d1814">read2BPPValue</a> (uint16_t tileRowAddress, uint8_t pixelIndex)</td></tr>
<tr class="memdesc:a4aa1530994bdec0ff7bbe9b6d45d1814"><td class="mdescLeft">&#160;</td><td class="mdescRight">read the 2bpp value for a pixel (used multple times for 4bpp and 8bpp) <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a4aa1530994bdec0ff7bbe9b6d45d1814">More...</a><br /></td></tr>
<tr class="separator:a4aa1530994bdec0ff7bbe9b6d45d1814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6458f422bfedc2969c36518136dbe6cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a6458f422bfedc2969c36518136dbe6cf">render</a> (uint16_t tileAddress)</td></tr>
<tr class="memdesc:a6458f422bfedc2969c36518136dbe6cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">render the tile (8x8) at the tileAddress <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a6458f422bfedc2969c36518136dbe6cf">More...</a><br /></td></tr>
<tr class="separator:a6458f422bfedc2969c36518136dbe6cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f1a45b6a8f6d4cb85c00ea566259fcd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a8f1a45b6a8f6d4cb85c00ea566259fcd">TileRenderer</a> (<a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a> &amp;vram, <a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a> &amp;cgram)</td></tr>
<tr class="separator:a8f1a45b6a8f6d4cb85c00ea566259fcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3b441752835313aa5302310db8a4e0c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#af3b441752835313aa5302310db8a4e0c">TileRenderer</a> (const <a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a> &amp;)=default</td></tr>
<tr class="memdesc:af3b441752835313aa5302310db8a4e0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">A tile renderer is copy constructable. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#af3b441752835313aa5302310db8a4e0c">More...</a><br /></td></tr>
<tr class="separator:af3b441752835313aa5302310db8a4e0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a6d0ed9b3d1e3dda95e04d64121f8ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a3a6d0ed9b3d1e3dda95e04d64121f8ab">~TileRenderer</a> ()=default</td></tr>
<tr class="memdesc:a3a6d0ed9b3d1e3dda95e04d64121f8ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">A default destructor. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a3a6d0ed9b3d1e3dda95e04d64121f8ab">More...</a><br /></td></tr>
<tr class="separator:a3a6d0ed9b3d1e3dda95e04d64121f8ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26749b5e436bef6dab100887ef1281ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a26749b5e436bef6dab100887ef1281ac">operator=</a> (const <a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a> &amp;)=delete</td></tr>
<tr class="memdesc:a26749b5e436bef6dab100887ef1281ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">A tile render is not assignable. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a26749b5e436bef6dab100887ef1281ac">More...</a><br /></td></tr>
<tr class="separator:a26749b5e436bef6dab100887ef1281ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6f882f901ad458ff37f8a4bebc8c9c3e"><td class="memItemLeft" align="right" valign="top">std::array&lt; std::array&lt; uint32_t, 8 &gt;, 8 &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a6f882f901ad458ff37f8a4bebc8c9c3e">buffer</a></td></tr>
<tr class="memdesc:a6f882f901ad458ff37f8a4bebc8c9c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">internal buffer max rendered tiles are 16x16 <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a6f882f901ad458ff37f8a4bebc8c9c3e">More...</a><br /></td></tr>
<tr class="separator:a6f882f901ad458ff37f8a4bebc8c9c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a41d9e33a710da74b973de4b908511fda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a41d9e33a710da74b973de4b908511fda">_ram</a></td></tr>
<tr class="memdesc:a41d9e33a710da74b973de4b908511fda"><td class="mdescLeft">&#160;</td><td class="mdescRight">ram to render <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a41d9e33a710da74b973de4b908511fda">More...</a><br /></td></tr>
<tr class="separator:a41d9e33a710da74b973de4b908511fda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01e39081ac3f7ea00ad0d1b48d891f6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a01e39081ac3f7ea00ad0d1b48d891f6f">_cgram</a></td></tr>
<tr class="memdesc:a01e39081ac3f7ea00ad0d1b48d891f6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">cgram to access the colors <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a01e39081ac3f7ea00ad0d1b48d891f6f">More...</a><br /></td></tr>
<tr class="separator:a01e39081ac3f7ea00ad0d1b48d891f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a999599f2ceea7d93612db8f33c78be69"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#a999599f2ceea7d93612db8f33c78be69">_bpp</a></td></tr>
<tr class="memdesc:a999599f2ceea7d93612db8f33c78be69"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bpp to use while rendering. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#a999599f2ceea7d93612db8f33c78be69">More...</a><br /></td></tr>
<tr class="separator:a999599f2ceea7d93612db8f33c78be69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0f4a7c5536bcfe4cda98aa066cf8108"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#ac0f4a7c5536bcfe4cda98aa066cf8108">_paletteIndex</a></td></tr>
<tr class="memdesc:ac0f4a7c5536bcfe4cda98aa066cf8108"><td class="mdescLeft">&#160;</td><td class="mdescRight">The palette number to use while rendering. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#ac0f4a7c5536bcfe4cda98aa066cf8108">More...</a><br /></td></tr>
<tr class="separator:ac0f4a7c5536bcfe4cda98aa066cf8108"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:ae2c0fa88624968ec1852a43fa9f7b7e4"><td class="memItemLeft" align="right" valign="top">static constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html#ae2c0fa88624968ec1852a43fa9f7b7e4">TileByteSizeRow</a> = 16</td></tr>
<tr class="memdesc:ae2c0fa88624968ec1852a43fa9f7b7e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">The byte size offset for 1 row in VRAM. <a href="classComSquare_1_1PPU_1_1TileRenderer.html#ae2c0fa88624968ec1852a43fa9f7b7e4">More...</a><br /></td></tr>
<tr class="separator:ae2c0fa88624968ec1852a43fa9f7b7e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a8f1a45b6a8f6d4cb85c00ea566259fcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f1a45b6a8f6d4cb85c00ea566259fcd">&#9670;&nbsp;</a></span>TileRenderer() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ComSquare::PPU::TileRenderer::TileRenderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a> &amp;&#160;</td>
<td class="paramname"><em>vram</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a> &amp;&#160;</td>
<td class="paramname"><em>cgram</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af3b441752835313aa5302310db8a4e0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3b441752835313aa5302310db8a4e0c">&#9670;&nbsp;</a></span>TileRenderer() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ComSquare::PPU::TileRenderer::TileRenderer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A tile renderer is copy constructable. </p>
</div>
</div>
<a id="a3a6d0ed9b3d1e3dda95e04d64121f8ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a6d0ed9b3d1e3dda95e04d64121f8ab">&#9670;&nbsp;</a></span>~TileRenderer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ComSquare::PPU::TileRenderer::~TileRenderer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A default destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab0f6764ac171190eaaa5366fd271a85e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0f6764ac171190eaaa5366fd271a85e">&#9670;&nbsp;</a></span>getBpp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ComSquare::PPU::TileRenderer::getBpp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current bpp. </p>
</div>
</div>
<a id="a39e7226eeeb3346d6a040a14ce17f3f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39e7226eeeb3346d6a040a14ce17f3f8">&#9670;&nbsp;</a></span>getPalette()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; uint16_t &gt; ComSquare::PPU::TileRenderer::getPalette </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>nbPalette</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gives the actual selected palette with all of it's colors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nbPalette</td><td>The index of the palette wanted </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The array of color of the palette </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The return and argument depends on the current bpp </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Values are CGRAM colors use PPU::CGRAMColorToRGBA function to get the actual real color </dd></dl>
</div>
</div>
<a id="aaff14ae8f6b97b429a95ae5c38704b99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaff14ae8f6b97b429a95ae5c38704b99">&#9670;&nbsp;</a></span>getPaletteIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ComSquare::PPU::TileRenderer::getPaletteIndex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of the current palette used. </p>
</div>
</div>
<a id="a99e6d5fc0697f982e9af9c1f70fe79ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e6d5fc0697f982e9af9c1f70fe79ab">&#9670;&nbsp;</a></span>getPixelReferenceFromTile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::PPU::TileRenderer::getPixelReferenceFromTile </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tileAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pixelIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the color pixel reference from the tile address and pixelIndex. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tileAddress</td><td>The starting address of the tile </td></tr>
<tr><td class="paramname">pixelIndex</td><td>The index of the pixel (0 - 255) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The color reference </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is wrapper of getPixelReferenceFromTileRow </dd></dl>
</div>
</div>
<a id="a70c3dac78b84b4f94e8ff349c0a929e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70c3dac78b84b4f94e8ff349c0a929e1">&#9670;&nbsp;</a></span>getPixelReferenceFromTileRow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::PPU::TileRenderer::getPixelReferenceFromTileRow </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tileRowAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pixelIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the color reference of a pixel from the address of the row. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tileRowAddress</td><td>The address of the line of pixel </td></tr>
<tr><td class="paramname">pixelIndex</td><td>The index of the pixel (0 - 7) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The color Reference </dd></dl>
</div>
</div>
<a id="a26749b5e436bef6dab100887ef1281ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26749b5e436bef6dab100887ef1281ac">&#9670;&nbsp;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a>&amp; ComSquare::PPU::TileRenderer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classComSquare_1_1PPU_1_1TileRenderer.html">TileRenderer</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A tile render is not assignable. </p>
</div>
</div>
<a id="a4aa1530994bdec0ff7bbe9b6d45d1814"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aa1530994bdec0ff7bbe9b6d45d1814">&#9670;&nbsp;</a></span>read2BPPValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ComSquare::PPU::TileRenderer::read2BPPValue </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tileRowAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>pixelIndex</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>read the 2bpp value for a pixel (used multple times for 4bpp and 8bpp) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tileRowAddress</td><td>Address where the read is done. Usage: Address of the tile row to render </td></tr>
<tr><td class="paramname">pixelIndex</td><td>The offset form tileRowAddress, Usage: the pixel to read </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6458f422bfedc2969c36518136dbe6cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6458f422bfedc2969c36518136dbe6cf">&#9670;&nbsp;</a></span>render()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComSquare::PPU::TileRenderer::render </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tileAddress</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>render the tile (8x8) at the tileAddress </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tileAddress</td><td>The address of the tile to render </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aca91ac9ac3b1dc3cb0549018dfe28d48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca91ac9ac3b1dc3cb0549018dfe28d48">&#9670;&nbsp;</a></span>setBpp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComSquare::PPU::TileRenderer::setBpp </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>bpp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the bpp to render graphics. </p>
</div>
</div>
<a id="adf5049b7b40c4b96700e24864326f951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf5049b7b40c4b96700e24864326f951">&#9670;&nbsp;</a></span>setPaletteIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ComSquare::PPU::TileRenderer::setPaletteIndex </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>paletteIndex</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the palette to use for render (index of palette) </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a999599f2ceea7d93612db8f33c78be69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a999599f2ceea7d93612db8f33c78be69">&#9670;&nbsp;</a></span>_bpp</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ComSquare::PPU::TileRenderer::_bpp</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The bpp to use while rendering. </p>
</div>
</div>
<a id="a01e39081ac3f7ea00ad0d1b48d891f6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01e39081ac3f7ea00ad0d1b48d891f6f">&#9670;&nbsp;</a></span>_cgram</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a>&amp; ComSquare::PPU::TileRenderer::_cgram</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>cgram to access the colors </p>
</div>
</div>
<a id="ac0f4a7c5536bcfe4cda98aa066cf8108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0f4a7c5536bcfe4cda98aa066cf8108">&#9670;&nbsp;</a></span>_paletteIndex</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ComSquare::PPU::TileRenderer::_paletteIndex</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The palette number to use while rendering. </p>
</div>
</div>
<a id="a41d9e33a710da74b973de4b908511fda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41d9e33a710da74b973de4b908511fda">&#9670;&nbsp;</a></span>_ram</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classComSquare_1_1Ram_1_1Ram.html">Ram::Ram</a>&amp; ComSquare::PPU::TileRenderer::_ram</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>ram to render </p>
</div>
</div>
<a id="a6f882f901ad458ff37f8a4bebc8c9c3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f882f901ad458ff37f8a4bebc8c9c3e">&#9670;&nbsp;</a></span>buffer</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::array&lt;std::array&lt;uint32_t, 8&gt;, 8&gt; ComSquare::PPU::TileRenderer::buffer</td>
</tr>
</table>
</div><div class="memdoc">
<p>internal buffer max rendered tiles are 16x16 </p>
</div>
</div>
<a id="ae2c0fa88624968ec1852a43fa9f7b7e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c0fa88624968ec1852a43fa9f7b7e4">&#9670;&nbsp;</a></span>TileByteSizeRow</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr int ComSquare::PPU::TileRenderer::TileByteSizeRow = 16</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The byte size offset for 1 row in VRAM. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>sources/PPU/<a class="el" href="TileRenderer_8hpp_source.html">TileRenderer.hpp</a></li>
<li>sources/PPU/<a class="el" href="TileRenderer_8cpp.html">TileRenderer.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink