330 lines
14 KiB
HTML
330 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Adafruit Library: DVHSTX8 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">Adafruit Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_d_v_h_s_t_x8-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">DVHSTX8 Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>An 8-bit canvas displaying to a DVI monitor.
|
|
<a href="class_d_v_h_s_t_x8.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_adafruit__dvhstx_8h_source.html">Adafruit_dvhstx.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for DVHSTX8:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_d_v_h_s_t_x8.png" usemap="#DVHSTX8_map" alt=""/>
|
|
<map id="DVHSTX8_map" name="DVHSTX8_map">
|
|
</map>
|
|
</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:a28aa4c2aaaaae3d6541090e6ee74fba1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_v_h_s_t_x8.html#a28aa4c2aaaaae3d6541090e6ee74fba1">DVHSTX8</a> (DVHSTXPinout pinout, DVHSTXResolution res, bool double_buffered=false)</td></tr>
|
|
<tr class="memdesc:a28aa4c2aaaaae3d6541090e6ee74fba1"><td class="mdescLeft"> </td><td class="mdescRight">Instatiate a DVHSTX 8-bit canvas context for graphics. <a href="#a28aa4c2aaaaae3d6541090e6ee74fba1">More...</a><br /></td></tr>
|
|
<tr class="separator:a28aa4c2aaaaae3d6541090e6ee74fba1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d620885247659693f715384da223f6a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_v_h_s_t_x8.html#a9d620885247659693f715384da223f6a">begin</a> ()</td></tr>
|
|
<tr class="memdesc:a9d620885247659693f715384da223f6a"><td class="mdescLeft"> </td><td class="mdescRight">Start the display. <a href="#a9d620885247659693f715384da223f6a">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d620885247659693f715384da223f6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a87b70c79d1ad2c2c7fbd227f496fc274"><td class="memItemLeft" align="right" valign="top"><a id="a87b70c79d1ad2c2c7fbd227f496fc274"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_v_h_s_t_x8.html#a87b70c79d1ad2c2c7fbd227f496fc274">end</a> ()</td></tr>
|
|
<tr class="memdesc:a87b70c79d1ad2c2c7fbd227f496fc274"><td class="mdescLeft"> </td><td class="mdescRight">Stop the display. <br /></td></tr>
|
|
<tr class="separator:a87b70c79d1ad2c2c7fbd227f496fc274"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac67fc03e6395ceebf1239289ab5b724a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_v_h_s_t_x8.html#ac67fc03e6395ceebf1239289ab5b724a">setColor</a> (uint8_t idx, uint8_t r, uint8_t g, uint8_t b)</td></tr>
|
|
<tr class="memdesc:ac67fc03e6395ceebf1239289ab5b724a"><td class="mdescLeft"> </td><td class="mdescRight">Set the given palette entry to a RGB888 color. <a href="#ac67fc03e6395ceebf1239289ab5b724a">More...</a><br /></td></tr>
|
|
<tr class="separator:ac67fc03e6395ceebf1239289ab5b724a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f9e3f4aa25a16493363922ccab14709"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_v_h_s_t_x8.html#a3f9e3f4aa25a16493363922ccab14709">setColor</a> (uint8_t idx, uint32_t rgb)</td></tr>
|
|
<tr class="memdesc:a3f9e3f4aa25a16493363922ccab14709"><td class="mdescLeft"> </td><td class="mdescRight">Set the given palette entry to a RGB888 color. <a href="#a3f9e3f4aa25a16493363922ccab14709">More...</a><br /></td></tr>
|
|
<tr class="separator:a3f9e3f4aa25a16493363922ccab14709"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8dac30ac535e726d062148b63c3f588"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_d_v_h_s_t_x8.html#af8dac30ac535e726d062148b63c3f588">swap</a> (bool copy_framebuffer=false)</td></tr>
|
|
<tr class="memdesc:af8dac30ac535e726d062148b63c3f588"><td class="mdescLeft"> </td><td class="mdescRight">If double-buffered, wait for retrace and swap buffers. Otherwise, do nothing (returns immediately) <a href="#af8dac30ac535e726d062148b63c3f588">More...</a><br /></td></tr>
|
|
<tr class="separator:af8dac30ac535e726d062148b63c3f588"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>An 8-bit canvas displaying to a DVI monitor. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a28aa4c2aaaaae3d6541090e6ee74fba1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28aa4c2aaaaae3d6541090e6ee74fba1">◆ </a></span>DVHSTX8()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DVHSTX8::DVHSTX8 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">DVHSTXPinout </td>
|
|
<td class="paramname"><em>pinout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">DVHSTXResolution </td>
|
|
<td class="paramname"><em>res</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>double_buffered</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Instatiate a DVHSTX 8-bit canvas context for graphics. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pinout</td><td>Details of the HSTX pinout </td></tr>
|
|
<tr><td class="paramname">res</td><td>Display resolution </td></tr>
|
|
<tr><td class="paramname">double_buffered</td><td>Whether to allocate two buffers </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a9d620885247659693f715384da223f6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d620885247659693f715384da223f6a">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool DVHSTX8::begin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Start the display. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if successful, false in case of error </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac67fc03e6395ceebf1239289ab5b724a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac67fc03e6395ceebf1239289ab5b724a">◆ </a></span>setColor() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DVHSTX8::setColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>r</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>g</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>b</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the given palette entry to a RGB888 color. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">idx</td><td>The palette entry number, from 0 to 255 </td></tr>
|
|
<tr><td class="paramname">r</td><td>The input red value, 0 to 255 </td></tr>
|
|
<tr><td class="paramname">g</td><td>The input red value, 0 to 255 </td></tr>
|
|
<tr><td class="paramname">b</td><td>The input red value, 0 to 255 </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3f9e3f4aa25a16493363922ccab14709"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f9e3f4aa25a16493363922ccab14709">◆ </a></span>setColor() <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">void DVHSTX8::setColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>rgb</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the given palette entry to a RGB888 color. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">idx</td><td>The palette entry number, from 0 to 255 </td></tr>
|
|
<tr><td class="paramname">rgb</td><td>The 24-bit RGB value in the form 0x00RRGGBB </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8dac30ac535e726d062148b63c3f588"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8dac30ac535e726d062148b63c3f588">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DVHSTX8::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>copy_framebuffer</em> = <code>false</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>If double-buffered, wait for retrace and swap buffers. Otherwise, do nothing (returns immediately) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">copy_framebuffer</td><td>if true, copy the new screen to the new back buffer. Otherwise, the content is undefined. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="_adafruit__dvhstx_8h_source.html">Adafruit_dvhstx.h</a></li>
|
|
<li>src/Adafruit_dvhstx.cpp</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- 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.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|