summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2012-07-09 04:48:26 +0000
committerDavid Robillard <d@drobilla.net>2012-07-09 04:48:26 +0000
commit8e4508482b3f8abcd997d527ddcbce25bbd63384 (patch)
tree5be935d01ab09d8297795a23e1f6aea282d596d4
parentb9ae60a072a21b59764bfc5a524c8b1581aed681 (diff)
downloadsuil-8e4508482b3f8abcd997d527ddcbce25bbd63384.tar.gz
suil-8e4508482b3f8abcd997d527ddcbce25bbd63384.tar.bz2
suil-8e4508482b3f8abcd997d527ddcbce25bbd63384.zip
Add proper documentation for suil_instance_port_event().
git-svn-id: http://svn.drobilla.net/lad/trunk/suil@4525 a436a847-0d15-0410-975c-d299462d15a1
-rw-r--r--suil/suil.h13
1 files changed, 13 insertions, 0 deletions
diff --git a/suil/suil.h b/suil/suil.h
index cf7cf8f..35ed29b 100644
--- a/suil/suil.h
+++ b/suil/suil.h
@@ -211,6 +211,19 @@ suil_instance_get_widget(SuilInstance* instance);
/**
Notify the UI about a change in a plugin port.
+ @param instance UI instance.
+ @param port_index Index of the port which has changed.
+ @param buffer_size Size of @p buffer in bytes.
+ @param format Format of @p buffer (mapped URI, or 0 for float).
+ @param buffer Change data, e.g. the new port value.
+
+ This function can be used to notify the UI about any port change, but in the
+ simplest case is used to set the value of lv2:ControlPort ports. For
+ simplicity, this is a special case where @p format is 0, @p buffer_size is
+ 4, and @p buffer should point to a single float.
+
+ The @p buffer must be valid only for the duration of this call, the UI must
+ not keep a reference to it.
*/
SUIL_API
void