diff options
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/uri-map')
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/uri-map/uri-map.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h index 6767cd1..df22cc7 100644 --- a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h +++ b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h @@ -17,7 +17,7 @@ /** @file C header for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>. - + This extension defines a simple mechanism for plugins to map URIs to integers, usually for performance reasons (e.g. processing events typed by URIs in real time). The expected use case is for plugins to map URIs to @@ -41,7 +41,7 @@ typedef void* LV2_URI_Map_Callback_Data; /** URI Map Feature. - + To support this feature the host must pass an LV2_Feature struct to the plugin's instantiate method with URI "http://lv2plug.in/ns/ext/uri-map" and data pointed to an instance of this struct. @@ -50,7 +50,7 @@ typedef struct { /** Opaque pointer to host data. - + The plugin MUST pass this to any call to functions in this struct. Otherwise, it must not be interpreted in any way. */ @@ -58,7 +58,7 @@ typedef struct { /** Get the numeric ID of a URI from the host. - + @param callback_data Must be the callback_data member of this struct. @param map The 'context' of this URI. Certain extensions may define a URI that must be passed here with certain restrictions on the return @@ -67,14 +67,14 @@ typedef struct { unless there is a specific need to do so, e.g. to restrict the range of the returned value. @param uri The URI to be mapped to an integer ID. - + This function is referentially transparent; any number of calls with the same arguments is guaranteed to return the same value over the life of a plugin instance (though the same URI may return different values with a different map parameter). However, this function is not necessarily very fast: plugins SHOULD cache any IDs they might need in performance critical situations. - + The return value 0 is reserved and indicates that an ID for that URI could not be created for whatever reason. Extensions MAY define more precisely what this means in a certain context, but in general plugins |