mirror of
https://github.com/zoriya/ComSquare.git
synced 2026-05-07 05:39:01 +00:00
141 lines
20 KiB
HTML
141 lines
20 KiB
HTML
<!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: sources/Memory/RectangleShadow.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="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&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&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="dir_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_b6b0f0b7471b46e8c4cfc0f00c8af2f6.html">Memory</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">RectangleShadow.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="RectangleShadow_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Created by anonymus-raccoon on 2/4/20.</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  </div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "<a class="code" href="ARectangleMemory_8hpp.html">ARectangleMemory.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="MemoryShadow_8hpp.html">MemoryShadow.hpp</a>"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1RectangleShadow.html"> 13</a></span>  <span class="keyword">class </span><a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html">RectangleShadow</a> : <span class="keyword">public</span> <a class="code" href="classComSquare_1_1Memory_1_1ARectangleMemory.html">ARectangleMemory</a> {</div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1RectangleShadow.html#af2fa7c3726a966734401c9d74efb9857"> 16</a></span>  <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &<a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#af2fa7c3726a966734401c9d74efb9857">_initial</a>;</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a281490c83f087fed5b4ab9abbaa80e32"> 18</a></span>  <span class="keywordtype">int</span> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a281490c83f087fed5b4ab9abbaa80e32">_bankOffset</a> = 0;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#aee4593f936633db7ab0045b8838312ad">RectangleShadow</a>(<a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &initial, uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage);</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#aee4593f936633db7ab0045b8838312ad">RectangleShadow</a>(<span class="keyword">const</span> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html">RectangleShadow</a> &) = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html">RectangleShadow</a> &<a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a5ddf968ddbfb1767d78ffe6ad6a6ee12">operator=</a>(<span class="keyword">const</span> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html">RectangleShadow</a> &) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#abc88d4a0ec2b74cff09efb6080728d26">~RectangleShadow</a>() <span class="keyword">override</span> = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  uint8_t <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#ac4edb47abc275812298f1314ed0cd959">read</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#abd2c3a785eb5c43249965650d8b53574">write</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr, uint8_t data) <span class="keyword">override</span>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  [[nodiscard]] <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a8e9ecd31b62134e08a811a8583a0af3c">getRelativeAddress</a>(<a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> addr) <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  [[nodiscard]] <a class="code" href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#aa009d6ceb2d3ef951fecf54b1e25811e">getSize</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  [[nodiscard]] std::string <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a1a940ad2e7ed79dc2af3b4682caab527">getName</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  [[nodiscard]] <a class="code" href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">Component</a> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a6f15e3bb70408dd939a7178b243c60f6">getComponent</a>() <span class="keyword">const override</span>;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  [[nodiscard]] <a class="code" href="classComSquare_1_1Memory_1_1IMemory.html">IMemory</a> &<a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#a9552aedaed64347f56201f743a9cb42d">getMirrored</a>() <span class="keyword">const</span>;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> <a class="code" href="classComSquare_1_1Memory_1_1RectangleShadow.html#aed4a58c4ef9a27a40a1f17838db745f9">setBankOffset</a>(<span class="keywordtype">int</span> bankOffset);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  };</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> }</div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_a9552aedaed64347f56201f743a9cb42d"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#a9552aedaed64347f56201f743a9cb42d">ComSquare::Memory::RectangleShadow::getMirrored</a></div><div class="ttdeci">IMemory & getMirrored() const</div><div class="ttdoc">Return the memory accessor this accessor mirror if any.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:46</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_a6f15e3bb70408dd939a7178b243c60f6"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#a6f15e3bb70408dd939a7178b243c60f6">ComSquare::Memory::RectangleShadow::getComponent</a></div><div class="ttdeci">Component getComponent() const override</div><div class="ttdoc">Get the component of this accessor (used for debug purpose)</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:56</div></div>
|
|
<div class="ttc" id="anamespaceComSquare_html_a891b49feb5c3e0aaa4873ff19b49968c"><div class="ttname"><a href="namespaceComSquare.html#a891b49feb5c3e0aaa4873ff19b49968c">ComSquare::Component</a></div><div class="ttdeci">Component</div><div class="ttdef"><b>Definition:</b> Components.hpp:9</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_a281490c83f087fed5b4ab9abbaa80e32"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#a281490c83f087fed5b4ab9abbaa80e32">ComSquare::Memory::RectangleShadow::_bankOffset</a></div><div class="ttdeci">int _bankOffset</div><div class="ttdoc">The number of banks to add to the memory before accessing it from the initial data.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.hpp:18</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1ARectangleMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1ARectangleMemory.html">ComSquare::Memory::ARectangleMemory</a></div><div class="ttdoc">Base memory class to map non continuous rectangle to the memory. (A rectangle that spam across more t...</div><div class="ttdef"><b>Definition:</b> ARectangleMemory.hpp:13</div></div>
|
|
<div class="ttc" id="aInts_8hpp_html_a89f009aaf5d1964a000f44f09fa0bcf8"><div class="ttname"><a href="Ints_8hpp.html#a89f009aaf5d1964a000f44f09fa0bcf8">uint24_t</a></div><div class="ttdeci">unsigned uint24_t</div><div class="ttdef"><b>Definition:</b> Ints.hpp:10</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_a8e9ecd31b62134e08a811a8583a0af3c"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#a8e9ecd31b62134e08a811a8583a0af3c">ComSquare::Memory::RectangleShadow::getRelativeAddress</a></div><div class="ttdeci">uint24_t getRelativeAddress(uint24_t addr) const override</div><div class="ttdoc">Translate an absolute address to a relative address.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:20</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1IMemory_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1IMemory.html">ComSquare::Memory::IMemory</a></div><div class="ttdoc">Common interface implemented by all components mapping memory.</div><div class="ttdef"><b>Definition:</b> IMemory.hpp:17</div></div>
|
|
<div class="ttc" id="aARectangleMemory_8hpp_html"><div class="ttname"><a href="ARectangleMemory_8hpp.html">ARectangleMemory.hpp</a></div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_abc88d4a0ec2b74cff09efb6080728d26"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#abc88d4a0ec2b74cff09efb6080728d26">ComSquare::Memory::RectangleShadow::~RectangleShadow</a></div><div class="ttdeci">~RectangleShadow() override=default</div><div class="ttdoc">A default destructor.</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_aa009d6ceb2d3ef951fecf54b1e25811e"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#aa009d6ceb2d3ef951fecf54b1e25811e">ComSquare::Memory::RectangleShadow::getSize</a></div><div class="ttdeci">uint24_t getSize() const override</div><div class="ttdoc">Get the size of the data. This size can be lower than the mapped data.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:41</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html">ComSquare::Memory::RectangleShadow</a></div><div class="ttdef"><b>Definition:</b> RectangleShadow.hpp:13</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_aee4593f936633db7ab0045b8838312ad"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#aee4593f936633db7ab0045b8838312ad">ComSquare::Memory::RectangleShadow::RectangleShadow</a></div><div class="ttdeci">RectangleShadow(IMemory &initial, uint8_t startBank, uint8_t endBank, uint16_t startPage, uint16_t endPage)</div><div class="ttdoc">Create a shadow for the memory given as parameter.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:10</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_a1a940ad2e7ed79dc2af3b4682caab527"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#a1a940ad2e7ed79dc2af3b4682caab527">ComSquare::Memory::RectangleShadow::getName</a></div><div class="ttdeci">std::string getName() const override</div><div class="ttdoc">Get the name of this accessor (used for debug purpose)</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:51</div></div>
|
|
<div class="ttc" id="anamespaceComSquare_1_1Memory_html"><div class="ttname"><a href="namespaceComSquare_1_1Memory.html">ComSquare::Memory</a></div><div class="ttdef"><b>Definition:</b> AMemory.cpp:7</div></div>
|
|
<div class="ttc" id="aMemoryShadow_8hpp_html"><div class="ttname"><a href="MemoryShadow_8hpp.html">MemoryShadow.hpp</a></div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_aed4a58c4ef9a27a40a1f17838db745f9"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#aed4a58c4ef9a27a40a1f17838db745f9">ComSquare::Memory::RectangleShadow::setBankOffset</a></div><div class="ttdeci">void setBankOffset(int bankOffset)</div><div class="ttdoc">Set the number of bank this component do not shadow. Referring to the first byte of this component wi...</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:36</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_af2fa7c3726a966734401c9d74efb9857"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#af2fa7c3726a966734401c9d74efb9857">ComSquare::Memory::RectangleShadow::_initial</a></div><div class="ttdeci">IMemory & _initial</div><div class="ttdoc">Memory to shadow from.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.hpp:16</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_abd2c3a785eb5c43249965650d8b53574"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#abd2c3a785eb5c43249965650d8b53574">ComSquare::Memory::RectangleShadow::write</a></div><div class="ttdeci">void write(uint24_t addr, uint8_t data) override</div><div class="ttdoc">Write data to the ram.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:31</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_a5ddf968ddbfb1767d78ffe6ad6a6ee12"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#a5ddf968ddbfb1767d78ffe6ad6a6ee12">ComSquare::Memory::RectangleShadow::operator=</a></div><div class="ttdeci">RectangleShadow & operator=(const RectangleShadow &)=delete</div><div class="ttdoc">@brrief A rectangle shadow is not assignable</div></div>
|
|
<div class="ttc" id="aclassComSquare_1_1Memory_1_1RectangleShadow_html_ac4edb47abc275812298f1314ed0cd959"><div class="ttname"><a href="classComSquare_1_1Memory_1_1RectangleShadow.html#ac4edb47abc275812298f1314ed0cd959">ComSquare::Memory::RectangleShadow::read</a></div><div class="ttdeci">uint8_t read(uint24_t addr) override</div><div class="ttdoc">Read from the initial AMemory given.</div><div class="ttdef"><b>Definition:</b> RectangleShadow.cpp:26</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|