documented config

2019-02-19 03:57:47 -08:00
parent 0f2deb76d9
commit ecf2d9cba3
1073 changed files with 133630 additions and 12986 deletions
@@ -70,6 +70,8 @@ $(function() {
 <div class="title">Cacher Class Reference</div>  </div>
 </div><!--header-->
 <div class="contents">
+
+<p><code>#include &lt;<a class="el" href="cacher_8h_source.html">cacher.h</a>&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for Cacher:</div>
 <div class="dyncontent">
@@ -79,49 +81,210 @@ Inheritance diagram for Cacher:</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:aebe3cd3649b6a62f1fd8fb72f0e0f929"><td class="memItemLeft" align="right" valign="top"><a id="aebe3cd3649b6a62f1fd8fb72f0e0f929"></a>
-&#160;</td><td class="memItemRight" valign="bottom"><b>Cacher</b> (<a class="el" href="class_clip.html">Clip</a> *c)</td></tr>
-<tr class="separator:aebe3cd3649b6a62f1fd8fb72f0e0f929"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a89edaa9400682322f6f9311b2cdc2a0a"><td class="memItemLeft" align="right" valign="top"><a id="a89edaa9400682322f6f9311b2cdc2a0a"></a>
-void&#160;</td><td class="memItemRight" valign="bottom"><b>run</b> ()</td></tr>
+<tr class="memitem:a0eda328c5746dc42704f648f4333c3cd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#a0eda328c5746dc42704f648f4333c3cd">Cacher</a> (<a class="el" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a> c)</td></tr>
+<tr class="separator:a0eda328c5746dc42704f648f4333c3cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a89edaa9400682322f6f9311b2cdc2a0a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#a89edaa9400682322f6f9311b2cdc2a0a">run</a> ()</td></tr>
 <tr class="separator:a89edaa9400682322f6f9311b2cdc2a0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 Public Attributes</h2></td></tr>
-<tr class="memitem:a797742db18b4cb59ced0c8881d983b71"><td class="memItemLeft" align="right" valign="top"><a id="a797742db18b4cb59ced0c8881d983b71"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>caching</b></td></tr>
+<tr class="memitem:a797742db18b4cb59ced0c8881d983b71"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#a797742db18b4cb59ced0c8881d983b71">caching</a></td></tr>
 <tr class="separator:a797742db18b4cb59ced0c8881d983b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5d0b9f109d61adb78ea1f9f9f20b7891"><td class="memItemLeft" align="right" valign="top"><a id="a5d0b9f109d61adb78ea1f9f9f20b7891"></a>
-long&#160;</td><td class="memItemRight" valign="bottom"><b>playhead</b></td></tr>
+<tr class="memitem:a5d0b9f109d61adb78ea1f9f9f20b7891"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#a5d0b9f109d61adb78ea1f9f9f20b7891">playhead</a></td></tr>
 <tr class="separator:a5d0b9f109d61adb78ea1f9f9f20b7891"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab45149cd0e420bceba0ffa01814f4cfb"><td class="memItemLeft" align="right" valign="top"><a id="ab45149cd0e420bceba0ffa01814f4cfb"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b></td></tr>
+<tr class="memitem:ab45149cd0e420bceba0ffa01814f4cfb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#ab45149cd0e420bceba0ffa01814f4cfb">reset</a></td></tr>
 <tr class="separator:ab45149cd0e420bceba0ffa01814f4cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:abd1d896c094bc916cf2a070e2c94864a"><td class="memItemLeft" align="right" valign="top"><a id="abd1d896c094bc916cf2a070e2c94864a"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>scrubbing</b></td></tr>
+<tr class="memitem:abd1d896c094bc916cf2a070e2c94864a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#abd1d896c094bc916cf2a070e2c94864a">scrubbing</a></td></tr>
 <tr class="separator:abd1d896c094bc916cf2a070e2c94864a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a5751327ff0ac50991f75d1cb977c1819"><td class="memItemLeft" align="right" valign="top"><a id="a5751327ff0ac50991f75d1cb977c1819"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>interrupt</b></td></tr>
+<tr class="memitem:a5751327ff0ac50991f75d1cb977c1819"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#a5751327ff0ac50991f75d1cb977c1819">interrupt</a></td></tr>
 <tr class="separator:a5751327ff0ac50991f75d1cb977c1819"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aaaf89c47568bed8658f96008b12af46f"><td class="memItemLeft" align="right" valign="top"><a id="aaaf89c47568bed8658f96008b12af46f"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>queued</b></td></tr>
+<tr class="memitem:aaaf89c47568bed8658f96008b12af46f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#aaaf89c47568bed8658f96008b12af46f">queued</a></td></tr>
 <tr class="separator:aaaf89c47568bed8658f96008b12af46f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab5f5700dc48c5cca9c461f07ca46318a"><td class="memItemLeft" align="right" valign="top"><a id="ab5f5700dc48c5cca9c461f07ca46318a"></a>
-int&#160;</td><td class="memItemRight" valign="bottom"><b>playback_speed</b></td></tr>
+<tr class="memitem:ab5f5700dc48c5cca9c461f07ca46318a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#ab5f5700dc48c5cca9c461f07ca46318a">playback_speed</a></td></tr>
 <tr class="separator:ab5f5700dc48c5cca9c461f07ca46318a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a26029d8a0f4a484a4bf782558ea970d9"><td class="memItemLeft" align="right" valign="top"><a id="a26029d8a0f4a484a4bf782558ea970d9"></a>
-QVector&lt; <a class="el" href="class_clip.html">Clip</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>nests</b></td></tr>
-<tr class="separator:a26029d8a0f4a484a4bf782558ea970d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac8fbf7205b43f64c5e1147734fad78bc"><td class="memItemLeft" align="right" valign="top">QVector&lt; <a class="el" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#ac8fbf7205b43f64c5e1147734fad78bc">nests</a></td></tr>
+<tr class="separator:ac8fbf7205b43f64c5e1147734fad78bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
 Private Attributes</h2></td></tr>
-<tr class="memitem:a7977a799bddf42d73b8057c763045e47"><td class="memItemLeft" align="right" valign="top"><a id="a7977a799bddf42d73b8057c763045e47"></a>
-<a class="el" href="class_clip.html">Clip</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>clip</b></td></tr>
-<tr class="separator:a7977a799bddf42d73b8057c763045e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae4c0f8fff07c174698a79c7a4b199d34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cacher.html#ae4c0f8fff07c174698a79c7a4b199d34">clip</a></td></tr>
+<tr class="separator:ae4c0f8fff07c174698a79c7a4b199d34"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
+<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="a0eda328c5746dc42704f648f4333c3cd"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0eda328c5746dc42704f648f4333c3cd">&#9670;&nbsp;</a></span>Cacher()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Cacher::Cacher </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a>&#160;</td>
+          <td class="paramname"><em>c</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a id="a89edaa9400682322f6f9311b2cdc2a0a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a89edaa9400682322f6f9311b2cdc2a0a">&#9670;&nbsp;</a></span>run()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void Cacher::run </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<h2 class="groupheader">Member Data Documentation</h2>
+<a id="a797742db18b4cb59ced0c8881d983b71"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a797742db18b4cb59ced0c8881d983b71">&#9670;&nbsp;</a></span>caching</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Cacher::caching</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="ae4c0f8fff07c174698a79c7a4b199d34"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae4c0f8fff07c174698a79c7a4b199d34">&#9670;&nbsp;</a></span>clip</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a> Cacher::clip</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">private</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a5751327ff0ac50991f75d1cb977c1819"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5751327ff0ac50991f75d1cb977c1819">&#9670;&nbsp;</a></span>interrupt</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Cacher::interrupt</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="ac8fbf7205b43f64c5e1147734fad78bc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac8fbf7205b43f64c5e1147734fad78bc">&#9670;&nbsp;</a></span>nests</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QVector&lt;<a class="el" href="cacher_8h.html#a06b2300f462978e17d9b586991a0af3f">ClipPtr</a>&gt; Cacher::nests</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="ab5f5700dc48c5cca9c461f07ca46318a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab5f5700dc48c5cca9c461f07ca46318a">&#9670;&nbsp;</a></span>playback_speed</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int Cacher::playback_speed</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="a5d0b9f109d61adb78ea1f9f9f20b7891"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5d0b9f109d61adb78ea1f9f9f20b7891">&#9670;&nbsp;</a></span>playhead</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">long Cacher::playhead</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="aaaf89c47568bed8658f96008b12af46f"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aaaf89c47568bed8658f96008b12af46f">&#9670;&nbsp;</a></span>queued</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Cacher::queued</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="ab45149cd0e420bceba0ffa01814f4cfb"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ab45149cd0e420bceba0ffa01814f4cfb">&#9670;&nbsp;</a></span>reset</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Cacher::reset</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a id="abd1d896c094bc916cf2a070e2c94864a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#abd1d896c094bc916cf2a070e2c94864a">&#9670;&nbsp;</a></span>scrubbing</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool Cacher::scrubbing</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+</div>
+</div>
 <hr/>The documentation for this class was generated from the following files:<ul>
 <li>playback/<a class="el" href="cacher_8h_source.html">cacher.h</a></li>
-<li>playback/cacher.cpp</li>
+<li>playback/<a class="el" href="cacher_8cpp.html">cacher.cpp</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->