summaryrefslogtreecommitdiffstats
path: root/slv2
diff options
context:
space:
mode:
Diffstat (limited to 'slv2')
-rw-r--r--slv2/plugin.h26
1 files changed, 15 insertions, 11 deletions
diff --git a/slv2/plugin.h b/slv2/plugin.h
index 435f869..8f41677 100644
--- a/slv2/plugin.h
+++ b/slv2/plugin.h
@@ -272,19 +272,23 @@ slv2_plugin_get_num_ports(SLV2Plugin p);
/** Get the port ranges (minimum, maximum and default values) for all ports.
*
- * min_values, max_values and def_values must either point to an array of
- * N floats, where N is the value returned by slv2_plugin_get_num_ports() for
- * this plugin, or NULL. This function will set the elements of the non-NULL
- * array pointers to the minimum, maximum and default values of the ports on
- * this plugin, with array index corresponding to port index. If a port doesn't
- * have a minimum, maximum or default value, the corresponding array element will
- * be set to NAN.
+ * \a min_values, \a max_values and \a def_values must either point to an array
+ * of N floats, where N is the value returned by slv2_plugin_get_num_ports()
+ * for this plugin, or NULL. The elements of the array will be set to the
+ * the minimum, maximum and default values of the ports on this plugin,
+ * with array index corresponding to port index. If a port doesn't have a
+ * minimum, maximum or default value, or the port's type is not float, the
+ * corresponding array element will be set to NAN.
+ *
+ * This is a convenience method for the common case of getting the range of
+ * all float ports on a plugin, and may be significantly faster than
+ * repeated calls to slv2_port_get_range.
*/
void
-slv2_plugin_get_port_ranges(SLV2Plugin p,
- float* min_values,
- float* max_values,
- float* def_values);
+slv2_plugin_get_port_ranges_float(SLV2Plugin p,
+ float* min_values,
+ float* max_values,
+ float* def_values);
/** Get the number of ports on this plugin that are members of some class(es).
*