xaymar/VST2SDK
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 9 Wiki Activity

87b3e2bcfc

Browse Source
This commit is contained in:
GitHub Actions
2025-08-07 23:08:08 +00:00
parent 5b5752818b
commit 5d195e55a0
49 changed files with 4717 additions and 5267 deletions
Download Patch File Download Diff File Expand all files Collapse all files
structvst__effect__t.html
+26 -26
View File
@@ -171,7 +171,7 @@ Data Fields</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Plug-in Effect definition. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02278">2278</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02089">2089</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa7b1aaa0a269f355ae70dd7e98d2e88d" name="aa7b1aaa0a269f355ae70dd7e98d2e88d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7b1aaa0a269f355ae70dd7e98d2e88d">&#9670;&#160;</a></span>_unknown</h2>
@@ -185,7 +185,7 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02434">2434</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02245">2245</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -201,7 +201,7 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02355">2355</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02166">2166</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -217,7 +217,7 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02356">2356</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02167">2167</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -233,7 +233,7 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02367">2367</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02178">2178</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -249,7 +249,7 @@ Data Fields</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02368">2368</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02179">2179</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -270,7 +270,7 @@ Data Fields</h2></td></tr>
<dd>
<a class="el" href="vst_8h.html#abfb1cdba3c236829cb63d4196f33d696" title="Host to Plug-in Op-Codes These Op-Codes are emitted by the host and we must either handle them or ret...">VST_EFFECT_OPCODE</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02291">2291</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02102">2102</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -292,7 +292,7 @@ Data Fields</h2></td></tr>
Should be reinitialized when the effect is resumed.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a223eb6814e8e03b7f89687280db8b8eca3365f17c1b25e26e5b7ef3d3e1da82e0">VST_HOST_OPCODE_IO_MODIFIED</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02365">2365</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02176">2176</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -311,7 +311,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Effect Internal Pointer. </p>
<p>You can freely set this to point at some sort of class or similar for use in your own effect. The host must never modify this or the data available through this. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02385">2385</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02196">2196</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -330,7 +330,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Effect Flags. </p>
<dl class="section see"><dt>See also</dt><dd>VST_EFFECT_FLAGS </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02353">2353</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02164">2164</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -349,7 +349,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Get Parameter Function. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#af0c37ddc3ece0563a356589b330db697" title="Retrieve the current value of the parameter at the given index, or do nothing if out of bounds.">vst_effect_get_parameter_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02308">2308</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02119">2119</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -368,7 +368,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Host Internal Pointer. </p>
<p>The host may set this to point at data related to your effect instance that the host needs. The effect must never modify this or the data available through this. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02392">2392</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02203">2203</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -388,7 +388,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Example: A ratio of 2.0 means we produce twice as much output as we receive input.</p>
<p>Range: &gt;0.0 to Infinity Default: 1.0 </p><dl class="section note"><dt>Note</dt><dd>Ignored in VST 2.4 or with VST_EFFECT_FLAG_SUPPORTS_FLOAT. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02378">2378</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02189">2189</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -408,7 +408,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Should always be VST_FOURCC('VstP')</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a09521790f0fb9c38d6dbd3602d621053" title="Magic Number identifying a VST 2.x plug-in structure.">VST_MAGICNUMBER</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02285">2285</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02096">2096</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -431,7 +431,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<dd>
<a class="el" href="vst_8h.html#a223eb6814e8e03b7f89687280db8b8eca3365f17c1b25e26e5b7ef3d3e1da82e0">VST_HOST_OPCODE_IO_MODIFIED</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02339">2339</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02150">2150</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -454,7 +454,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<dd>
<a class="el" href="vst_8h.html#a223eb6814e8e03b7f89687280db8b8eca3365f17c1b25e26e5b7ef3d3e1da82e0">VST_HOST_OPCODE_IO_MODIFIED</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02347">2347</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02158">2158</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -474,7 +474,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>All programs must have at least this many parameters.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a223eb6814e8e03b7f89687280db8b8eca3365f17c1b25e26e5b7ef3d3e1da82e0">VST_HOST_OPCODE_IO_MODIFIED</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02330">2330</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02141">2141</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -511,7 +511,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<dd>
<a class="el" href="vst_8h.html#abfb1cdba3c236829cb63d4196f33d696abd3d276216b8b4f2786ae6ed8aefa099">VST_EFFECT_OPCODE_GET_CHUNK_DATA</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02323">2323</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02134">2134</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -529,9 +529,9 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Process Function. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a10245b388a012f0007c6b64446377ab2" title="Process the given number of samples in inputs and outputs.">vst_effect_process_t</a> </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>(VST 2.4+) Deprecated and practically unsupported in all VST 2.4 compatible hosts and may treat it as just another <a class="el" href="structvst__effect__t.html#a784b4b31eb7146fc3519c02e291a52ef">vst_effect_t::process_float</a>. </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>(VST 2.4+) Deprecated and practically unsupported in all VST 2.4 compatible hosts and may treat it as just another <a class="el" href="structvst__effect__t.html#a784b4b31eb7146fc3519c02e291a52ef">vst_effect_t::process_float</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02298">2298</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02109">2109</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -551,7 +551,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a2e0a659f8b4b8857a799a0b9c683a216" title="Process the given number of double samples in inputs and outputs.">vst_effect_process_double_t</a> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>(VST 2.4+) Available from VST 2.4 and later. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02431">2431</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02242">2242</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -571,7 +571,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<dl class="section see"><dt>See also</dt><dd>vst_effect_process_single_t </dd></dl>
<dl class="section note"><dt>Note</dt><dd>(VST 2.0+) Available from VST 2.0 and later. </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02421">2421</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02232">2232</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -590,7 +590,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Set Parameter Function. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="vst_8h.html#a20f63b4dc3f1f96b3c57820f99362a0d" title="Updates the value for the parameter at the given index, or does nothing if out of bounds.">vst_effect_set_parameter_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02303">2303</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02114">2114</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -611,7 +611,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Used in combination with <a class="el" href="vst_8h.html#a468e652fc0ccfa68fecbb35dce162640afe90e5f201f698e238ab1efb144047d8">VST_EFFECT_CATEGORY_CONTAINER</a>.</p>
<p>BUG: Some broken hosts rely on this alone to save information about VST plug-ins. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02405">2405</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02216">2216</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -630,7 +630,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<p>Plugin version. </p>
<p>Unrelated to the minimum VST Version, but often the same. </p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02411">2411</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l02222">2222</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
</div>
</div>
@@ -643,7 +643,7 @@ Should be reinitialized when the effect is resumed.</dd></dl>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structvst__effect__t.html">vst_effect_t</a></li>
<li class="footer">Generated on Thu Aug 7 2025 22:26:22 for VST2SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
<li class="footer">Generated on Thu Aug 7 2025 23:08:07 for VST2SDK by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>