yair/picovga-RGsB
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Documentation improvements

Browse Source
This commit is contained in:
Wayne Venables
2025-08-26 20:47:11 -07:00
parent 4753b270f6
commit faef620629
517 changed files with 8124 additions and 4888 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/mat2d_8h_source.html
View File

@@ -3,7 +3,7 @@
<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="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PicoVGA: src/util/mat2d.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -29,7 +29,7 @@
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PicoVGA
&#160;<span id="projectnumber">1.0-cmake</span>
&#160;<span id="projectnumber">1.2-cmake</span>
</div>
<div id="projectbrief">VGA/TV display on Raspberry Pico</div>
</td>
@@ -38,10 +38,10 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- 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');
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
@@ -256,38 +256,36 @@ $(document).ready(function(){initNavTree('mat2d_8h_source.html',''); initResizab
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;};</div>
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160; </div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160; </div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="preprocessor">#endif // _MAT2D_H</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclasscMat2D_html_adfd4450d81833a7f267bb9532e596616"><div class="ttname"><a href="classcMat2D.html#adfd4450d81833a7f267bb9532e596616">cMat2D::ShearY</a></div><div class="ttdeci">void ShearY(m2type dy)</div><div class="ttdoc">Shear in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:210</div></div>
<div class="ttc" id="aclasscMat2Df_html_a3665cc793ee74c64da3186b9eaf86b57"><div class="ttname"><a href="classcMat2Df.html#a3665cc793ee74c64da3186b9eaf86b57">cMat2Df::ExportInt</a></div><div class="ttdeci">void ExportInt(int *mat) const</div><div class="ttdoc">Export matrix to int array[6].</div><div class="ttdef"><b>Definition:</b> mat2d.cpp:53</div></div>
<div class="ttc" id="aclasscMat2D_html_a32cc6bce7146c3c6a590fcfab9a8bea3"><div class="ttname"><a href="classcMat2D.html#a32cc6bce7146c3c6a590fcfab9a8bea3">cMat2D::ScaleX</a></div><div class="ttdeci">void ScaleX(m2type sx)</div><div class="ttdoc">Scale in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:86</div></div>
<div class="ttc" id="aclasscMat2D_html_a585eeb0380be7dd93270c9cc29a38b66"><div class="ttname"><a href="classcMat2D.html#a585eeb0380be7dd93270c9cc29a38b66">cMat2D::TransX</a></div><div class="ttdeci">void TransX(m2type tx)</div><div class="ttdoc">Translate in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:58</div></div>
<div class="ttc" id="aclasscMat2Df_html"><div class="ttname"><a href="classcMat2Df.html">cMat2Df</a></div><div class="ttdoc">2D Transformation Matrix</div><div class="ttdef"><b>Definition:</b> mat2d.h:262</div></div>
<div class="ttc" id="aclasscMat2D_html_a4808e7a6806717eccd1bf783d13924fa"><div class="ttname"><a href="classcMat2D.html#a4808e7a6806717eccd1bf783d13924fa">cMat2D::Rot180</a></div><div class="ttdeci">void Rot180()</div><div class="ttdoc">Rotate by 180 deg (=flipX and flipY) (sina=0, cosa=-1)</div><div class="ttdef"><b>Definition:</b> mat2d.h:159</div></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="preprocessor">#endif </span><span class="comment">// _MAT2D_H</span></div>
<div class="ttc" id="aclasscMat2D_html"><div class="ttname"><a href="classcMat2D.html">cMat2D</a></div><div class="ttdoc">Transformation matrix.</div><div class="ttdef"><b>Definition:</b> mat2d.h:16</div></div>
<div class="ttc" id="aclasscMat2D_html_a07273c2b2c4ed4bb8a85209454f3e35e"><div class="ttname"><a href="classcMat2D.html#a07273c2b2c4ed4bb8a85209454f3e35e">cMat2D::TransY</a></div><div class="ttdeci">void TransY(m2type ty)</div><div class="ttdoc">Translate in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:72</div></div>
<div class="ttc" id="aclasscMat2D_html_a0f2893809c7da4e1e65ba83afdb39fbf"><div class="ttname"><a href="classcMat2D.html#a0f2893809c7da4e1e65ba83afdb39fbf">cMat2D::RotSC</a></div><div class="ttdeci">void RotSC(m2type sina, m2type cosa)</div><div class="ttdoc">Rotate, using sin and cos.</div><div class="ttdef"><b>Definition:</b> mat2d.h:118</div></div>
<div class="ttc" id="aclasscMat2D_html_a1b2ec49c61df84feb3dbcb410489588f"><div class="ttname"><a href="classcMat2D.html#a1b2ec49c61df84feb3dbcb410489588f">cMat2D::Unit</a></div><div class="ttdeci">void Unit()</div><div class="ttdoc">Set unit matrix.</div><div class="ttdef"><b>Definition:</b> mat2d.h:36</div></div>
<div class="ttc" id="aclasscMat2D_html_a07273c2b2c4ed4bb8a85209454f3e35e"><div class="ttname"><a href="classcMat2D.html#a07273c2b2c4ed4bb8a85209454f3e35e">cMat2D::TransY</a></div><div class="ttdeci">void TransY(m2type ty)</div><div class="ttdoc">Translate in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:72</div></div>
<div class="ttc" id="aclasscMat2D_html_ab6801fcd2e70176ee42cea2dbb02d115"><div class="ttname"><a href="classcMat2D.html#ab6801fcd2e70176ee42cea2dbb02d115">cMat2D::Rot270</a></div><div class="ttdeci">void Rot270()</div><div class="ttdoc">Rotate by 270 deg (sina=-1, cosa=0)</div><div class="ttdef"><b>Definition:</b> mat2d.h:170</div></div>
<div class="ttc" id="aclasscMat2D_html_acff590836167542b5337812c0691d1f8"><div class="ttname"><a href="classcMat2D.html#acff590836167542b5337812c0691d1f8">cMat2D::ScaleY</a></div><div class="ttdeci">void ScaleY(m2type sy)</div><div class="ttdoc">Scale in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:102</div></div>
<div class="ttc" id="aclasscMat2D_html_aca9180cae53757382050e363b9d8eaa0"><div class="ttname"><a href="classcMat2D.html#aca9180cae53757382050e363b9d8eaa0">cMat2D::GetX</a></div><div class="ttdeci">m2type GetX(m2type x, m2type y) const</div><div class="ttdoc">Transform X.</div><div class="ttdef"><b>Definition:</b> mat2d.h:24</div></div>
<div class="ttc" id="aclasscMat2D_html_aebb11b71a3767fed49c1cec087610814"><div class="ttname"><a href="classcMat2D.html#aebb11b71a3767fed49c1cec087610814">cMat2D::FlipY</a></div><div class="ttdeci">void FlipY()</div><div class="ttdoc">Flip in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:226</div></div>
<div class="ttc" id="aclasscMat2Df_html_a529afacb6148a067dd3a5a488cb97e13"><div class="ttname"><a href="classcMat2Df.html#a529afacb6148a067dd3a5a488cb97e13">cMat2Df::PrepDrawImg</a></div><div class="ttdeci">void PrepDrawImg(int ws, int hs, int x0, int y0, int wd, int hd, float shearx, float sheary, float r, float tx, float ty)</div><div class="ttdoc">Prepare transformation matrix (for DrawImgMat() function)</div><div class="ttdef"><b>Definition:</b> mat2d.cpp:22</div></div>
<div class="ttc" id="aclasscMat2D_html_ac08bd03c42e3a4d193f0bcdb04185f51"><div class="ttname"><a href="classcMat2D.html#ac08bd03c42e3a4d193f0bcdb04185f51">cMat2D::FlipX</a></div><div class="ttdeci">void FlipX()</div><div class="ttdoc">Flip in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:242</div></div>
<div class="ttc" id="aclasscMat2D_html_a4d08fd444c5bc11af5f69d69a9853454"><div class="ttname"><a href="classcMat2D.html#a4d08fd444c5bc11af5f69d69a9853454">cMat2D::Rot</a></div><div class="ttdeci">void Rot(m2type a)</div><div class="ttdoc">Rotate, using angle.</div><div class="ttdef"><b>Definition:</b> mat2d.h:137</div></div>
<div class="ttc" id="aclasscMat2D_html_afa5390c7e164a77456d61477b5f152b1"><div class="ttname"><a href="classcMat2D.html#afa5390c7e164a77456d61477b5f152b1">cMat2D::GetY</a></div><div class="ttdeci">m2type GetY(m2type x, m2type y) const</div><div class="ttdoc">Transform Y.</div><div class="ttdef"><b>Definition:</b> mat2d.h:30</div></div>
<div class="ttc" id="adefine_8h_html"><div class="ttname"><a href="define_8h.html">define.h</a></div><div class="ttdoc">VGA common definitions of C and ASM.</div></div>
<div class="ttc" id="aclasscMat2D_html_af12ccdd989e177278663981a9099557f"><div class="ttname"><a href="classcMat2D.html#af12ccdd989e177278663981a9099557f">cMat2D::ShearX</a></div><div class="ttdeci">void ShearX(m2type dx)</div><div class="ttdoc">Shear in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:194</div></div>
<div class="ttc" id="aclasscMat2D_html"><div class="ttname"><a href="classcMat2D.html">cMat2D</a></div><div class="ttdoc">Transformation matrix.</div><div class="ttdef"><b>Definition:</b> mat2d.h:15</div></div>
<div class="ttc" id="aclasscMat2D_html_a32cc6bce7146c3c6a590fcfab9a8bea3"><div class="ttname"><a href="classcMat2D.html#a32cc6bce7146c3c6a590fcfab9a8bea3">cMat2D::ScaleX</a></div><div class="ttdeci">void ScaleX(m2type sx)</div><div class="ttdoc">Scale in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:86</div></div>
<div class="ttc" id="aclasscMat2D_html_a4127207cc8695b12793cc27f66cb9d7b"><div class="ttname"><a href="classcMat2D.html#a4127207cc8695b12793cc27f66cb9d7b">cMat2D::Copy</a></div><div class="ttdeci">void Copy(const cMat2D *m)</div><div class="ttdoc">Copy matrix.</div><div class="ttdef"><b>Definition:</b> mat2d.h:43</div></div>
<div class="ttc" id="aclasscMat2D_html_a4808e7a6806717eccd1bf783d13924fa"><div class="ttname"><a href="classcMat2D.html#a4808e7a6806717eccd1bf783d13924fa">cMat2D::Rot180</a></div><div class="ttdeci">void Rot180()</div><div class="ttdoc">Rotate by 180 deg (=flipX and flipY) (sina=0, cosa=-1)</div><div class="ttdef"><b>Definition:</b> mat2d.h:159</div></div>
<div class="ttc" id="aclasscMat2D_html_a4d08fd444c5bc11af5f69d69a9853454"><div class="ttname"><a href="classcMat2D.html#a4d08fd444c5bc11af5f69d69a9853454">cMat2D::Rot</a></div><div class="ttdeci">void Rot(m2type a)</div><div class="ttdoc">Rotate, using angle.</div><div class="ttdef"><b>Definition:</b> mat2d.h:137</div></div>
<div class="ttc" id="aclasscMat2D_html_a585eeb0380be7dd93270c9cc29a38b66"><div class="ttname"><a href="classcMat2D.html#a585eeb0380be7dd93270c9cc29a38b66">cMat2D::TransX</a></div><div class="ttdeci">void TransX(m2type tx)</div><div class="ttdoc">Translate in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:58</div></div>
<div class="ttc" id="aclasscMat2D_html_ab6801fcd2e70176ee42cea2dbb02d115"><div class="ttname"><a href="classcMat2D.html#ab6801fcd2e70176ee42cea2dbb02d115">cMat2D::Rot270</a></div><div class="ttdeci">void Rot270()</div><div class="ttdoc">Rotate by 270 deg (sina=-1, cosa=0)</div><div class="ttdef"><b>Definition:</b> mat2d.h:170</div></div>
<div class="ttc" id="aclasscMat2D_html_ac08bd03c42e3a4d193f0bcdb04185f51"><div class="ttname"><a href="classcMat2D.html#ac08bd03c42e3a4d193f0bcdb04185f51">cMat2D::FlipX</a></div><div class="ttdeci">void FlipX()</div><div class="ttdoc">Flip in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:242</div></div>
<div class="ttc" id="aclasscMat2D_html_aca9180cae53757382050e363b9d8eaa0"><div class="ttname"><a href="classcMat2D.html#aca9180cae53757382050e363b9d8eaa0">cMat2D::GetX</a></div><div class="ttdeci">m2type GetX(m2type x, m2type y) const</div><div class="ttdoc">Transform X.</div><div class="ttdef"><b>Definition:</b> mat2d.h:24</div></div>
<div class="ttc" id="aclasscMat2D_html_acff590836167542b5337812c0691d1f8"><div class="ttname"><a href="classcMat2D.html#acff590836167542b5337812c0691d1f8">cMat2D::ScaleY</a></div><div class="ttdeci">void ScaleY(m2type sy)</div><div class="ttdoc">Scale in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:102</div></div>
<div class="ttc" id="aclasscMat2D_html_ade219f1406c1ca8b55d3d7202636824a"><div class="ttname"><a href="classcMat2D.html#ade219f1406c1ca8b55d3d7202636824a">cMat2D::Rot90</a></div><div class="ttdeci">void Rot90()</div><div class="ttdoc">Rotate by 90 deg (sina=1, cosa=0)</div><div class="ttdef"><b>Definition:</b> mat2d.h:143</div></div>
<div class="ttc" id="aclasscMat2D_html_adfd4450d81833a7f267bb9532e596616"><div class="ttname"><a href="classcMat2D.html#adfd4450d81833a7f267bb9532e596616">cMat2D::ShearY</a></div><div class="ttdeci">void ShearY(m2type dy)</div><div class="ttdoc">Shear in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:210</div></div>
<div class="ttc" id="aclasscMat2D_html_aebb11b71a3767fed49c1cec087610814"><div class="ttname"><a href="classcMat2D.html#aebb11b71a3767fed49c1cec087610814">cMat2D::FlipY</a></div><div class="ttdeci">void FlipY()</div><div class="ttdoc">Flip in Y direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:226</div></div>
<div class="ttc" id="aclasscMat2D_html_af12ccdd989e177278663981a9099557f"><div class="ttname"><a href="classcMat2D.html#af12ccdd989e177278663981a9099557f">cMat2D::ShearX</a></div><div class="ttdeci">void ShearX(m2type dx)</div><div class="ttdoc">Shear in X direction.</div><div class="ttdef"><b>Definition:</b> mat2d.h:194</div></div>
<div class="ttc" id="aclasscMat2D_html_afa5390c7e164a77456d61477b5f152b1"><div class="ttname"><a href="classcMat2D.html#afa5390c7e164a77456d61477b5f152b1">cMat2D::GetY</a></div><div class="ttdeci">m2type GetY(m2type x, m2type y) const</div><div class="ttdoc">Transform Y.</div><div class="ttdef"><b>Definition:</b> mat2d.h:30</div></div>
<div class="ttc" id="aclasscMat2Df_html"><div class="ttname"><a href="classcMat2Df.html">cMat2Df</a></div><div class="ttdoc">2D Transformation Matrix</div><div class="ttdef"><b>Definition:</b> mat2d.h:263</div></div>
<div class="ttc" id="aclasscMat2Df_html_a3665cc793ee74c64da3186b9eaf86b57"><div class="ttname"><a href="classcMat2Df.html#a3665cc793ee74c64da3186b9eaf86b57">cMat2Df::ExportInt</a></div><div class="ttdeci">void ExportInt(int *mat) const</div><div class="ttdoc">Export matrix to int array[6].</div><div class="ttdef"><b>Definition:</b> mat2d.cpp:53</div></div>
<div class="ttc" id="aclasscMat2Df_html_a529afacb6148a067dd3a5a488cb97e13"><div class="ttname"><a href="classcMat2Df.html#a529afacb6148a067dd3a5a488cb97e13">cMat2Df::PrepDrawImg</a></div><div class="ttdeci">void PrepDrawImg(int ws, int hs, int x0, int y0, int wd, int hd, float shearx, float sheary, float r, float tx, float ty)</div><div class="ttdoc">Prepare transformation matrix (for DrawImgMat() function)</div><div class="ttdef"><b>Definition:</b> mat2d.cpp:22</div></div>
<div class="ttc" id="adefine_8h_html"><div class="ttname"><a href="define_8h.html">define.h</a></div><div class="ttdoc">VGA common definitions of C and ASM.</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7878ad5ecbf2506f4125b9d34c97e45.html">util</a></li><li class="navelem"><a class="el" href="mat2d_8h.html">mat2d.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </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>