SimLeek/displayarray
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
displayarray/docs/input/index.html
T
simleek e14ae5f45e fixed frame documentation
2020-04-07 22:26:07 -07:00

153 lines
7.2 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>displayarray.input &#8212; DisplayArray documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="index" title="Index" href="../genindex/" />
<link rel="search" title="Search" href="../search/" />
<link rel="next" title="displayarray cli" href="../displayarray_bash/" />
<link rel="prev" title="displayarray.effects" href="../effects/" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="displayarray-input">
<h1>displayarray.input<a class="headerlink" href="#displayarray-input" title="Permalink to this headline"></a></h1>
<div class="section" id="mouse-input">
<h2>Mouse Input<a class="headerlink" href="#mouse-input" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="displayarray.input.mouse_loop">
<em class="property">class </em><code class="sig-name descname">mouse_loop</code><span class="sig-paren">(</span><em class="sig-param">f</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/displayarray/input/#mouse_loop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#displayarray.input.mouse_loop" title="Permalink to this definition"></a></dt>
<dd><p>Run a function on mouse information that is received by the window, continuously in a new thread.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nd">@mouse_loop</span>
<span class="gp">... </span><span class="k">def</span> <span class="nf">fun</span><span class="p">(</span><span class="n">mouse_event</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">print</span><span class="p">(</span><span class="s2">&quot;x:{}, y:{}&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">mouse_event</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">mouse_event</span><span class="o">.</span><span class="n">y</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
<dl class="class">
<dt id="displayarray.input.MouseEvent">
<em class="property">class </em><code class="sig-name descname">MouseEvent</code><span class="sig-paren">(</span><em class="sig-param">event</em>, <em class="sig-param">x</em>, <em class="sig-param">y</em>, <em class="sig-param">flags</em>, <em class="sig-param">param</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/displayarray/input/#MouseEvent"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#displayarray.input.MouseEvent" title="Permalink to this definition"></a></dt>
<dd><p>Holds all the OpenCV mouse event information.</p>
</dd></dl>
</div>
<div class="section" id="key-input">
<h2>Key Input<a class="headerlink" href="#key-input" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="displayarray.input.key_loop">
<em class="property">class </em><code class="sig-name descname">key_loop</code><span class="sig-paren">(</span><em class="sig-param">f: Callable[[str], None]</em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/displayarray/input/#key_loop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#displayarray.input.key_loop" title="Permalink to this definition"></a></dt>
<dd><p>Run a function on mouse information that is received by the window, continuously in a new thread.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nd">@key_loop</span>
<span class="gp">... </span><span class="k">def</span> <span class="nf">fun</span><span class="p">(</span><span class="n">key</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">print</span><span class="p">(</span><span class="s2">&quot;key pressed:{}&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">key</span><span class="p">))</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../">DisplayArray</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Python API</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../display/">display</a></li>
<li class="toctree-l1"><a class="reference internal" href="../frame/">frame</a></li>
<li class="toctree-l1"><a class="reference internal" href="../effects/">effects</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">input</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#mouse-input">Mouse Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="#key-input">Key Input</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Bash API</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../displayarray_bash/">displayarray</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../">Documentation overview</a><ul>
<li>Previous: <a href="../effects/" title="previous chapter">displayarray.effects</a></li>
<li>Next: <a href="../displayarray_bash/" title="next chapter">displayarray cli</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search/" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2019, Simulator Leek.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/input.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink