From 3c45957cdb38a115d013dd5d96f60b6ee1320229 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Mon, 25 Mar 2013 00:33:10 +0000 Subject: Allow lilv_state_restore() to be used without passing an instance, for restoring port values via a callback only. git-svn-id: http://svn.drobilla.net/lad/trunk/lilv@5100 a436a847-0d15-0410-975c-d299462d15a1 --- lilv/lilv.h | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) (limited to 'lilv') diff --git a/lilv/lilv.h b/lilv/lilv.h index f2dd17a..d349fb1 100644 --- a/lilv/lilv.h +++ b/lilv/lilv.h @@ -1393,21 +1393,21 @@ typedef void (*LilvSetPortValueFunc)(const char* port_symbol, /** Restore a plugin instance from a state snapshot. @param state The state to restore, which must apply to the correct plugin. - @param instance An instance of the plugin @c state applies to. + @param instance An instance of the plugin @c state applies to, or NULL. @param set_value A function to set a port value (may be NULL). @param flags Bitwise OR of LV2_State_Flags values. @param features Features to pass LV2_State_Interface.restore(). - This will set all the properties of @c instance to the values stored in @c - state. If @c set_value is provided, it will be called (with the given @c - user_data) to restore each port value, otherwise the host must restore the - port values itself (using lilv_state_get_port_value) in order to completely - restore @c state. + This will set all the properties of @c instance, if given, to the values + stored in @c state. If @c set_value is provided, it will be called (with + the given @c user_data) to restore each port value, otherwise the host must + restore the port values itself (using lilv_state_get_port_value) in order to + completely restore @c state. - If the state has properties, this function is in the "instantiation" - threading class, i.e. it MUST NOT be called simultaneously with any function - on the same plugin instance. If the state has no properties, only port - values are set via @c set_value. + If the state has properties and @c instance is given, this function is in + the "instantiation" threading class, i.e. it MUST NOT be called + simultaneously with any function on the same plugin instance. If the state + has no properties, only port values are set via @c set_value. See state.h from the LV2 State extension for details on the @c flags and @c features parameters. -- cgit v1.2.1