473 lines
28 KiB
HTML
473 lines
28 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>VST2SDK: vst_parameter_properties_t Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">VST2SDK
|
|
</div>
|
|
<div id="projectbrief">A recreation of the popular Steinberg VST 2.x SDK.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('structvst__parameter__properties__t.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle"><div class="title">vst_parameter_properties_t Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Information about a parameter.
|
|
<a href="structvst__parameter__properties__t.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="vst_8h_source.html">vst.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a88ecf0593c5a680fbcf273f3a21f9d06" id="r_a88ecf0593c5a680fbcf273f3a21f9d06"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a88ecf0593c5a680fbcf273f3a21f9d06">step_f32</a></td></tr>
|
|
<tr class="memdesc:a88ecf0593c5a680fbcf273f3a21f9d06"><td class="mdescLeft"> </td><td class="mdescRight">Float Step value. <br /></td></tr>
|
|
<tr class="separator:a88ecf0593c5a680fbcf273f3a21f9d06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7633adf7c9bfd344844a9ababa1d078" id="r_ad7633adf7c9bfd344844a9ababa1d078"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#ad7633adf7c9bfd344844a9ababa1d078">step_small_f32</a></td></tr>
|
|
<tr class="memdesc:ad7633adf7c9bfd344844a9ababa1d078"><td class="mdescLeft"> </td><td class="mdescRight">Float small step value This is used for "tiny" changes. <br /></td></tr>
|
|
<tr class="separator:ad7633adf7c9bfd344844a9ababa1d078"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94755e0b6feacf58e9de4b4a622fcddd" id="r_a94755e0b6feacf58e9de4b4a622fcddd"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a94755e0b6feacf58e9de4b4a622fcddd">step_large_f32</a></td></tr>
|
|
<tr class="memdesc:a94755e0b6feacf58e9de4b4a622fcddd"><td class="mdescLeft"> </td><td class="mdescRight">Float large step value This is used for "huge" changes. <br /></td></tr>
|
|
<tr class="separator:a94755e0b6feacf58e9de4b4a622fcddd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83d812684b3fde93c09913d06574dfd4" id="r_a83d812684b3fde93c09913d06574dfd4"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a83d812684b3fde93c09913d06574dfd4">name</a> [<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0adf371e519b4fe11ea463a31ced5b23b7">VST_BUFFER_SIZE_PARAM_LONG_NAME</a>]</td></tr>
|
|
<tr class="memdesc:a83d812684b3fde93c09913d06574dfd4"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name for this parameter. <br /></td></tr>
|
|
<tr class="separator:a83d812684b3fde93c09913d06574dfd4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a536d12f74400069aa4dfaec620b47bdd" id="r_a536d12f74400069aa4dfaec620b47bdd"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a536d12f74400069aa4dfaec620b47bdd">flags</a></td></tr>
|
|
<tr class="memdesc:a536d12f74400069aa4dfaec620b47bdd"><td class="mdescLeft"> </td><td class="mdescRight">Parameter Flags. <br /></td></tr>
|
|
<tr class="separator:a536d12f74400069aa4dfaec620b47bdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad471b50780abc9105eba9ac9ed561e52" id="r_ad471b50780abc9105eba9ac9ed561e52"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#ad471b50780abc9105eba9ac9ed561e52">min_value_i32</a></td></tr>
|
|
<tr class="memdesc:ad471b50780abc9105eba9ac9ed561e52"><td class="mdescLeft"> </td><td class="mdescRight">Minimum Integer value. <br /></td></tr>
|
|
<tr class="separator:ad471b50780abc9105eba9ac9ed561e52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a781a76eec41f0337b2389f181681eb60" id="r_a781a76eec41f0337b2389f181681eb60"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a781a76eec41f0337b2389f181681eb60">max_value_i32</a></td></tr>
|
|
<tr class="memdesc:a781a76eec41f0337b2389f181681eb60"><td class="mdescLeft"> </td><td class="mdescRight">Maximum Integer value. <br /></td></tr>
|
|
<tr class="separator:a781a76eec41f0337b2389f181681eb60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b1ace1183e9e315f77f51a66334357a" id="r_a9b1ace1183e9e315f77f51a66334357a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a9b1ace1183e9e315f77f51a66334357a">step_i32</a></td></tr>
|
|
<tr class="memdesc:a9b1ace1183e9e315f77f51a66334357a"><td class="mdescLeft"> </td><td class="mdescRight">Integer Step value. <br /></td></tr>
|
|
<tr class="separator:a9b1ace1183e9e315f77f51a66334357a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02ac161f41598c9140cad6394bed1e3d" id="r_a02ac161f41598c9140cad6394bed1e3d"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a02ac161f41598c9140cad6394bed1e3d">label</a> [<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0a7b36831c844989a8f852aa37c612394f">VST_BUFFER_SIZE_PARAM_LABEL</a>]</td></tr>
|
|
<tr class="memdesc:a02ac161f41598c9140cad6394bed1e3d"><td class="mdescLeft"> </td><td class="mdescRight">Short Human-readable label for this parameter. <br /></td></tr>
|
|
<tr class="separator:a02ac161f41598c9140cad6394bed1e3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9bbc613a559dfc92086ba0b638ab91e4" id="r_a9bbc613a559dfc92086ba0b638ab91e4"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a9bbc613a559dfc92086ba0b638ab91e4">index</a></td></tr>
|
|
<tr class="memdesc:a9bbc613a559dfc92086ba0b638ab91e4"><td class="mdescLeft"> </td><td class="mdescRight">Display order index. <br /></td></tr>
|
|
<tr class="separator:a9bbc613a559dfc92086ba0b638ab91e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a63e39667345b6e1fff1a966d16940323" id="r_a63e39667345b6e1fff1a966d16940323"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a63e39667345b6e1fff1a966d16940323">category</a></td></tr>
|
|
<tr class="memdesc:a63e39667345b6e1fff1a966d16940323"><td class="mdescLeft"> </td><td class="mdescRight">Category index. <br /></td></tr>
|
|
<tr class="separator:a63e39667345b6e1fff1a966d16940323"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7377da7bb0d90b3cf6de336f94caa54" id="r_ae7377da7bb0d90b3cf6de336f94caa54"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#ae7377da7bb0d90b3cf6de336f94caa54">num_parameters_in_category</a></td></tr>
|
|
<tr class="memdesc:ae7377da7bb0d90b3cf6de336f94caa54"><td class="mdescLeft"> </td><td class="mdescRight">How many parameters are in this category? This allows the plug-in to specify the same category multiple times. <br /></td></tr>
|
|
<tr class="separator:ae7377da7bb0d90b3cf6de336f94caa54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5cfe12a6ec0e20578728cd92d64a473" id="r_ad5cfe12a6ec0e20578728cd92d64a473"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#ad5cfe12a6ec0e20578728cd92d64a473">_unknown_00</a></td></tr>
|
|
<tr class="separator:ad5cfe12a6ec0e20578728cd92d64a473"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b2fbabc3c1d3bd6a33242df7d32d026" id="r_a4b2fbabc3c1d3bd6a33242df7d32d026"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a4b2fbabc3c1d3bd6a33242df7d32d026">category_label</a> [<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0ab6d00e5e5b66c8f846e5bee4e94c5a65">VST_BUFFER_SIZE_CATEGORY_LABEL</a>]</td></tr>
|
|
<tr class="memdesc:a4b2fbabc3c1d3bd6a33242df7d32d026"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name for the category this parameter is in. <br /></td></tr>
|
|
<tr class="separator:a4b2fbabc3c1d3bd6a33242df7d32d026"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0979487731dfdc09f40df4a65c403a97" id="r_a0979487731dfdc09f40df4a65c403a97"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structvst__parameter__properties__t.html#a0979487731dfdc09f40df4a65c403a97">_reserved</a> [16]</td></tr>
|
|
<tr class="separator:a0979487731dfdc09f40df4a65c403a97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Information about a parameter. </p>
|
|
<p>@important Many VST hosts and plug-ins expect their parameters to be normalized within 0.0 and 1.0. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00448">448</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
</div><h2 class="groupheader">Field Documentation</h2>
|
|
<a id="a0979487731dfdc09f40df4a65c403a97" name="a0979487731dfdc09f40df4a65c403a97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0979487731dfdc09f40df4a65c403a97">◆ </a></span>_reserved</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char vst_parameter_properties_t::_reserved[16]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00551">551</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5cfe12a6ec0e20578728cd92d64a473" name="ad5cfe12a6ec0e20578728cd92d64a473"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5cfe12a6ec0e20578728cd92d64a473">◆ </a></span>_unknown_00</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t vst_parameter_properties_t::_unknown_00</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00542">542</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63e39667345b6e1fff1a966d16940323" name="a63e39667345b6e1fff1a966d16940323"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63e39667345b6e1fff1a966d16940323">◆ </a></span>category</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t vst_parameter_properties_t::category</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Category index. </p>
|
|
<p>Must either be 0 for no category, or any number increasing from 1 onwards.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca6c9b21c53b749fb380081214e08ed07b">VST_PARAMETER_FLAG_CATEGORY</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00532">532</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b2fbabc3c1d3bd6a33242df7d32d026" name="a4b2fbabc3c1d3bd6a33242df7d32d026"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b2fbabc3c1d3bd6a33242df7d32d026">◆ </a></span>category_label</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char vst_parameter_properties_t::category_label[<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0ab6d00e5e5b66c8f846e5bee4e94c5a65">VST_BUFFER_SIZE_CATEGORY_LABEL</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Human-readable name for the category this parameter is in. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca6c9b21c53b749fb380081214e08ed07b">VST_PARAMETER_FLAG_CATEGORY</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00549">549</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a536d12f74400069aa4dfaec620b47bdd" name="a536d12f74400069aa4dfaec620b47bdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a536d12f74400069aa4dfaec620b47bdd">◆ </a></span>flags</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t vst_parameter_properties_t::flags</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parameter Flags. </p>
|
|
<p>Any combination of <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7c">VST_PARAMETER_FLAG</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00488">488</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9bbc613a559dfc92086ba0b638ab91e4" name="a9bbc613a559dfc92086ba0b638ab91e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9bbc613a559dfc92086ba0b638ab91e4">◆ </a></span>index</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t vst_parameter_properties_t::index</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Display order index. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca531eeef82327950ca4727e29035b754d">VST_PARAMETER_FLAG_INDEX</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00523">523</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a02ac161f41598c9140cad6394bed1e3d" name="a02ac161f41598c9140cad6394bed1e3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a02ac161f41598c9140cad6394bed1e3d">◆ </a></span>label</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char vst_parameter_properties_t::label[<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0a7b36831c844989a8f852aa37c612394f">VST_BUFFER_SIZE_PARAM_LABEL</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Short Human-readable label for this parameter. </p>
|
|
<p>I have no idea why this exists? </p><dl class="section note"><dt>Note</dt><dd>Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00516">516</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a781a76eec41f0337b2389f181681eb60" name="a781a76eec41f0337b2389f181681eb60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a781a76eec41f0337b2389f181681eb60">◆ </a></span>max_value_i32</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t vst_parameter_properties_t::max_value_i32</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Maximum Integer value. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca3bfc2b92d6147ccf802f0b31f236d559">VST_PARAMETER_FLAG_INTEGER_LIMITS</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00502">502</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad471b50780abc9105eba9ac9ed561e52" name="ad471b50780abc9105eba9ac9ed561e52"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad471b50780abc9105eba9ac9ed561e52">◆ </a></span>min_value_i32</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t vst_parameter_properties_t::min_value_i32</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Minimum Integer value. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca3bfc2b92d6147ccf802f0b31f236d559">VST_PARAMETER_FLAG_INTEGER_LIMITS</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00495">495</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a83d812684b3fde93c09913d06574dfd4" name="a83d812684b3fde93c09913d06574dfd4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a83d812684b3fde93c09913d06574dfd4">◆ </a></span>name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char vst_parameter_properties_t::name[<a class="el" href="vst_8h.html#a7abc836e88df867216049fa8f4645bc0adf371e519b4fe11ea463a31ced5b23b7">VST_BUFFER_SIZE_PARAM_LONG_NAME</a>]</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Human-readable name for this parameter. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00482">482</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7377da7bb0d90b3cf6de336f94caa54" name="ae7377da7bb0d90b3cf6de336f94caa54"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7377da7bb0d90b3cf6de336f94caa54">◆ </a></span>num_parameters_in_category</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t vst_parameter_properties_t::num_parameters_in_category</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>How many parameters are in this category? This allows the plug-in to specify the same category multiple times. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca6c9b21c53b749fb380081214e08ed07b">VST_PARAMETER_FLAG_CATEGORY</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00540">540</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88ecf0593c5a680fbcf273f3a21f9d06" name="a88ecf0593c5a680fbcf273f3a21f9d06"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88ecf0593c5a680fbcf273f3a21f9d06">◆ </a></span>step_f32</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_parameter_properties_t::step_f32</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Float Step value. </p>
|
|
<p>Some hosts and plug-ins expect this to be within 0 and 1.0.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca497f96438fb88122f606d61841d1ca4a">VST_PARAMETER_FLAG_STEP_FLOAT</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00456">456</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b1ace1183e9e315f77f51a66334357a" name="a9b1ace1183e9e315f77f51a66334357a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b1ace1183e9e315f77f51a66334357a">◆ </a></span>step_i32</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t vst_parameter_properties_t::step_i32</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Integer Step value. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca8eef7e865d0623c61c71b2cc94675724">VST_PARAMETER_FLAG_STEP_INT</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00509">509</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a94755e0b6feacf58e9de4b4a622fcddd" name="a94755e0b6feacf58e9de4b4a622fcddd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a94755e0b6feacf58e9de4b4a622fcddd">◆ </a></span>step_large_f32</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_parameter_properties_t::step_large_f32</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Float large step value This is used for "huge" changes. </p>
|
|
<p>Some hosts and plug-ins expect this to be within 0 and 1.0.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca497f96438fb88122f606d61841d1ca4a">VST_PARAMETER_FLAG_STEP_FLOAT</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00476">476</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7633adf7c9bfd344844a9ababa1d078" name="ad7633adf7c9bfd344844a9ababa1d078"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7633adf7c9bfd344844a9ababa1d078">◆ </a></span>step_small_f32</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float vst_parameter_properties_t::step_small_f32</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Float small step value This is used for "tiny" changes. </p>
|
|
<p>Some hosts and plug-ins expect this to be within 0 and 1.0.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>Requires <a class="el" href="vst_8h.html#a968fd930e4a6bcab267aa77da72b2c7ca497f96438fb88122f606d61841d1ca4a">VST_PARAMETER_FLAG_STEP_FLOAT</a> to be set. </dd>
|
|
<dd>
|
|
Ignored if <a class="el" href="vst_8h.html#a7174d634349acbda34c34af9fe706bd2a8fffe35d5bbfb226cb49b38ceed4c69e">VST_EFFECT_FLAG_EDITOR</a> is set. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="vst_8h_source.html#l00466">466</a> of file <a class="el" href="vst_8h_source.html">vst.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>include/<a class="el" href="vst_8h_source.html">vst.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="structvst__parameter__properties__t.html">vst_parameter_properties_t</a></li>
|
|
<li class="footer">Generated on Mon Aug 18 2025 00:22:20 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>
|
|
</html>
|