yair/picovga-cmake
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
Files
c149b77db285ffd79618eb04bb22652ad89f03ff
picovga-cmake/docs/group__UtilsGroup.html
Wayne Venables faef620629 Documentation improvements
2025-08-26 20:47:11 -07:00

410 lines
17 KiB
HTML
Raw 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PicoVGA: Utility Functions</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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom.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="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.2-cmake</span>
</div>
<div id="projectbrief">VGA/TV display on Raspberry Pico</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('group__UtilsGroup.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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Utility Functions</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>Utility functions. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab8207741ed267ed4fbaa28c4d5a7bad9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UtilsGroup.html#gab8207741ed267ed4fbaa28c4d5a7bad9">Attr8Conv</a> (u8 *dst, u8 *attr, const u8 *src, int w, int h, const u8 *pal)</td></tr>
<tr class="memdesc:gab8207741ed267ed4fbaa28c4d5a7bad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert image from 16-color to 8x8 attribute format. <a href="group__UtilsGroup.html#gab8207741ed267ed4fbaa28c4d5a7bad9">More...</a><br /></td></tr>
<tr class="separator:gab8207741ed267ed4fbaa28c4d5a7bad9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9d2f98a08bf609f9969298eb2e9d7761"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UtilsGroup.html#ga9d2f98a08bf609f9969298eb2e9d7761">Plane2Conv</a> (u8 *plane0, u8 *plane1, const u8 *src, int w, int h)</td></tr>
<tr class="memdesc:ga9d2f98a08bf609f9969298eb2e9d7761"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert image from 4-color to 2-plane format (width must be multiply of 8) <a href="group__UtilsGroup.html#ga9d2f98a08bf609f9969298eb2e9d7761">More...</a><br /></td></tr>
<tr class="separator:ga9d2f98a08bf609f9969298eb2e9d7761"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga268e6976f0e415330c26c1f3d4d73cc9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UtilsGroup.html#ga268e6976f0e415330c26c1f3d4d73cc9">ImgInvert</a> (u8 *dst, int num)</td></tr>
<tr class="memdesc:ga268e6976f0e415330c26c1f3d4d73cc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invert image. <a href="group__UtilsGroup.html#ga268e6976f0e415330c26c1f3d4d73cc9">More...</a><br /></td></tr>
<tr class="separator:ga268e6976f0e415330c26c1f3d4d73cc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d2664ea6a63954346a80ca93cfb3b74"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UtilsGroup.html#ga6d2664ea6a63954346a80ca93cfb3b74">DecUNum</a> (char *buf, u32 num)</td></tr>
<tr class="memdesc:ga6d2664ea6a63954346a80ca93cfb3b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode unsigned number into ASCIIZ text buffer. <a href="group__UtilsGroup.html#ga6d2664ea6a63954346a80ca93cfb3b74">More...</a><br /></td></tr>
<tr class="separator:ga6d2664ea6a63954346a80ca93cfb3b74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga31e41cec17ed79dc0bd026b6d45237a0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UtilsGroup.html#ga31e41cec17ed79dc0bd026b6d45237a0">DecNum</a> (char *buf, s32 num)</td></tr>
<tr class="memdesc:ga31e41cec17ed79dc0bd026b6d45237a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Decode signed number into ASCIIZ text buffer. <a href="group__UtilsGroup.html#ga31e41cec17ed79dc0bd026b6d45237a0">More...</a><br /></td></tr>
<tr class="separator:ga31e41cec17ed79dc0bd026b6d45237a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga49a4978da9e0f15dcdc9ebfc9d6c520e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__UtilsGroup.html#ga49a4978da9e0f15dcdc9ebfc9d6c520e">CopyWhiteImg</a> (u8 *dst, const u8 *src, int num)</td></tr>
<tr class="memdesc:ga49a4978da9e0f15dcdc9ebfc9d6c520e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prepare image with white key transparency (copy and increment pixels) <a href="group__UtilsGroup.html#ga49a4978da9e0f15dcdc9ebfc9d6c520e">More...</a><br /></td></tr>
<tr class="separator:ga49a4978da9e0f15dcdc9ebfc9d6c520e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gab8207741ed267ed4fbaa28c4d5a7bad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab8207741ed267ed4fbaa28c4d5a7bad9">&#9670;&nbsp;</a></span>Attr8Conv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Attr8Conv </td>
<td>(</td>
<td class="paramtype">u8 *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8 *&#160;</td>
<td class="paramname"><em>attr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u8 *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u8 *&#160;</td>
<td class="paramname"><em>pal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert image from 16-color to 8x8 attribute format. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Destination image </td></tr>
<tr><td class="paramname">attr</td><td>Destination attribute data </td></tr>
<tr><td class="paramname">src</td><td>Source image </td></tr>
<tr><td class="paramname">w</td><td>Image width </td></tr>
<tr><td class="paramname">h</td><td>Image height </td></tr>
<tr><td class="paramname">pal</td><td>Palette </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9d2f98a08bf609f9969298eb2e9d7761"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d2f98a08bf609f9969298eb2e9d7761">&#9670;&nbsp;</a></span>Plane2Conv()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Plane2Conv </td>
<td>(</td>
<td class="paramtype">u8 *&#160;</td>
<td class="paramname"><em>plane0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u8 *&#160;</td>
<td class="paramname"><em>plane1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u8 *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>h</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert image from 4-color to 2-plane format (width must be multiply of 8) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plane0</td><td>First plane destination </td></tr>
<tr><td class="paramname">plane1</td><td>Second plane destionation </td></tr>
<tr><td class="paramname">src</td><td>Soure image </td></tr>
<tr><td class="paramname">w</td><td>Image width </td></tr>
<tr><td class="paramname">h</td><td>Image height </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga268e6976f0e415330c26c1f3d4d73cc9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga268e6976f0e415330c26c1f3d4d73cc9">&#9670;&nbsp;</a></span>ImgInvert()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImgInvert </td>
<td>(</td>
<td class="paramtype">u8 *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Invert image. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Image data </td></tr>
<tr><td class="paramname">num</td><td>Length of image in bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6d2664ea6a63954346a80ca93cfb3b74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d2664ea6a63954346a80ca93cfb3b74">&#9670;&nbsp;</a></span>DecUNum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DecUNum </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">u32&#160;</td>
<td class="paramname"><em>num</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode unsigned number into ASCIIZ text buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Destination buffer </td></tr>
<tr><td class="paramname">num</td><td>Number to decode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of digits </dd></dl>
</div>
</div>
<a id="ga31e41cec17ed79dc0bd026b6d45237a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31e41cec17ed79dc0bd026b6d45237a0">&#9670;&nbsp;</a></span>DecNum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DecNum </td>
<td>(</td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">s32&#160;</td>
<td class="paramname"><em>num</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode signed number into ASCIIZ text buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>Destination buffer </td></tr>
<tr><td class="paramname">num</td><td>Number to decode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of digits </dd></dl>
</div>
</div>
<a id="ga49a4978da9e0f15dcdc9ebfc9d6c520e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49a4978da9e0f15dcdc9ebfc9d6c520e">&#9670;&nbsp;</a></span>CopyWhiteImg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CopyWhiteImg </td>
<td>(</td>
<td class="paramtype">u8 *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const u8 *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>num</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prepare image with white key transparency (copy and increment pixels) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Destination image </td></tr>
<tr><td class="paramname">src</td><td>Source image </td></tr>
<tr><td class="paramname">num</td><td>Number of bytes to copy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
Reference in New Issue View Git Blame Copy Permalink