documented config

2019-02-19 03:57:47 -08:00
parent 0f2deb76d9
commit ecf2d9cba3
1073 changed files with 133630 additions and 12986 deletions
@@ -62,28 +62,116 @@ $(function() {
 </div><!-- top -->
 <div class="header">
  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="#pub-attribs">Public Attributes</a> &#124;
 <a href="struct_runtime_config-members.html">List of all members</a>  </div>
  <div class="headertitle">
 <div class="title">RuntimeConfig Struct Reference</div>  </div>
 </div><!--header-->
 <div class="contents">
+
+<p>The <a class="el" href="struct_runtime_config.html" title="The RuntimeConfig struct.">RuntimeConfig</a> struct.  
+ <a href="struct_runtime_config.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="config_8h_source.html">config.h</a>&gt;</code></p>
 <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:aa51a896ec458a69c2a43f22482b75ad2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_runtime_config.html#aa51a896ec458a69c2a43f22482b75ad2">RuntimeConfig</a> ()</td></tr>
+<tr class="memdesc:aa51a896ec458a69c2a43f22482b75ad2"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="struct_runtime_config.html" title="The RuntimeConfig struct.">RuntimeConfig</a> Constructor.  <a href="#aa51a896ec458a69c2a43f22482b75ad2">More...</a><br /></td></tr>
+<tr class="separator:aa51a896ec458a69c2a43f22482b75ad2"><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:a74857512218b41145afd697df666a8c4"><td class="memItemLeft" align="right" valign="top"><a id="a74857512218b41145afd697df666a8c4"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>shaders_are_enabled</b></td></tr>
+<tr class="memitem:a74857512218b41145afd697df666a8c4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_runtime_config.html#a74857512218b41145afd697df666a8c4">shaders_are_enabled</a></td></tr>
+<tr class="memdesc:a74857512218b41145afd697df666a8c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable shaders.  <a href="#a74857512218b41145afd697df666a8c4">More...</a><br /></td></tr>
 <tr class="separator:a74857512218b41145afd697df666a8c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aaf59a8a93e78677ea2b66a04810a97c9"><td class="memItemLeft" align="right" valign="top"><a id="aaf59a8a93e78677ea2b66a04810a97c9"></a>
-bool&#160;</td><td class="memItemRight" valign="bottom"><b>disable_blending</b></td></tr>
+<tr class="memitem:aaf59a8a93e78677ea2b66a04810a97c9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_runtime_config.html#aaf59a8a93e78677ea2b66a04810a97c9">disable_blending</a></td></tr>
+<tr class="memdesc:aaf59a8a93e78677ea2b66a04810a97c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable blending modes.  <a href="#aaf59a8a93e78677ea2b66a04810a97c9">More...</a><br /></td></tr>
 <tr class="separator:aaf59a8a93e78677ea2b66a04810a97c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aedcd25f65e6a9db4e9d20b8117828e39"><td class="memItemLeft" align="right" valign="top"><a id="aedcd25f65e6a9db4e9d20b8117828e39"></a>
-QString&#160;</td><td class="memItemRight" valign="bottom"><b>external_translation_file</b></td></tr>
+<tr class="memitem:aedcd25f65e6a9db4e9d20b8117828e39"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_runtime_config.html#aedcd25f65e6a9db4e9d20b8117828e39">external_translation_file</a></td></tr>
+<tr class="memdesc:aedcd25f65e6a9db4e9d20b8117828e39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load an external translation file.  <a href="#aedcd25f65e6a9db4e9d20b8117828e39">More...</a><br /></td></tr>
 <tr class="separator:aedcd25f65e6a9db4e9d20b8117828e39"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>The <a class="el" href="struct_runtime_config.html" title="The RuntimeConfig struct.">RuntimeConfig</a> struct. </p>
+<p>This struct handles any configuration that's set as a command-line argument to Olive, and shouldn't be persistent between restarts of Olive. </p>
+</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
+<a id="aa51a896ec458a69c2a43f22482b75ad2"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa51a896ec458a69c2a43f22482b75ad2">&#9670;&nbsp;</a></span>RuntimeConfig()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">RuntimeConfig::RuntimeConfig </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p><a class="el" href="struct_runtime_config.html" title="The RuntimeConfig struct.">RuntimeConfig</a> Constructor. </p>
+<p>Sets default runtime configuration </p>
+
+</div>
+</div>
+<h2 class="groupheader">Member Data Documentation</h2>
+<a id="aaf59a8a93e78677ea2b66a04810a97c9"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aaf59a8a93e78677ea2b66a04810a97c9">&#9670;&nbsp;</a></span>disable_blending</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool RuntimeConfig::disable_blending</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Disable blending modes. </p>
+<p>Some users had difficulty utilizing blending modes (provided by shaders). Set this to <b>TRUE</b> to bypass shader-based blending modes and utilize standard (less versatile) OpenGL blending instead. </p>
+
+</div>
+</div>
+<a id="aedcd25f65e6a9db4e9d20b8117828e39"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aedcd25f65e6a9db4e9d20b8117828e39">&#9670;&nbsp;</a></span>external_translation_file</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">QString RuntimeConfig::external_translation_file</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Load an external translation file. </p>
+<p>Overrides <a class="el" href="struct_config.html#a347b9eac28e05a0e07225db0fa4321af" title="Language/translation file.">Config::language_file</a> and sets the path to a language file to use. </p>
+
+</div>
+</div>
+<a id="a74857512218b41145afd697df666a8c4"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a74857512218b41145afd697df666a8c4">&#9670;&nbsp;</a></span>shaders_are_enabled</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool RuntimeConfig::shaders_are_enabled</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Enable shaders. </p>
+<p>Debugging tool. Set to <b>FALSE</b> to bypass OpenGL shaders. </p>
+
+</div>
+</div>
 <hr/>The documentation for this struct was generated from the following files:<ul>
 <li>io/<a class="el" href="config_8h_source.html">config.h</a></li>
-<li>io/config.cpp</li>
+<li>io/<a class="el" href="config_8cpp.html">config.cpp</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->