diff options
author | David Robillard <d@drobilla.net> | 2020-03-22 16:36:44 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-04-10 19:46:04 +0200 |
commit | 430284545345539c9ffb31df889debac1d3888b5 (patch) | |
tree | dc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/resize-port/resize-port.meta.ttl | |
parent | c4514483da1ab4f49148f9c4fe4ff5b559323217 (diff) | |
download | lv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz |
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/resize-port/resize-port.meta.ttl')
-rw-r--r-- | lv2/resize-port/resize-port.meta.ttl | 53 |
1 files changed, 52 insertions, 1 deletions
diff --git a/lv2/resize-port/resize-port.meta.ttl b/lv2/resize-port/resize-port.meta.ttl index 6f7dac4..d44620c 100644 --- a/lv2/resize-port/resize-port.meta.ttl +++ b/lv2/resize-port/resize-port.meta.ttl @@ -1,7 +1,9 @@ @prefix dcs: <http://ontologi.es/doap-changeset#> . @prefix doap: <http://usefulinc.com/ns/doap#> . @prefix foaf: <http://xmlns.com/foaf/0.1/> . +@prefix lv2: <http://lv2plug.in/ns/lv2core#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . +@prefix rsz: <http://lv2plug.in/ns/ext/resize-port#> . <http://lv2plug.in/ns/ext/resize-port> a doap:Project ; @@ -19,5 +21,54 @@ rdfs:label "Initial release." ] ] - ] . + ] ; + lv2:documentation """ + +This extension defines a feature, rsz:resize, which allows plugins to +dynamically resize their output port buffers. + +In addition to the dynamic feature, there are properties which describe the +space required for a particular port buffer which can be used statically in +data files. + +"""^^lv2:Markdown . + +rsz:resize + lv2:documentation """ + +A feature to resize output port buffers in LV2_Plugin_Descriptor::run(). + +To support this feature, the host must pass an LV2_Feature to the plugin's +instantiate method with URI LV2_RESIZE_PORT__resize and a pointer to a +LV2_Resize_Port_Resize structure. This structure provides a resize_port +function which plugins may use to resize output port buffers as necessary. + +"""^^lv2:Markdown . + +rsz:asLargeAs + lv2:documentation """ + +Indicates that a port requires at least as much buffer space as the port with +the given symbol on the same plugin instance. This may be used for any ports, +but is generally most useful to indicate an output port must be at least as +large as some input port (because it will copy from it). If a port is +asLargeAs several ports, it is asLargeAs the largest such port (not the sum of +those ports' sizes). + +The host guarantees that whenever an ObjectPort's run method is called, any +output `O` that is rsz:asLargeAs an input `I` is connected to a buffer large +enough to copy `I`, or `NULL` if the port is lv2:connectionOptional. + +"""^^lv2:Markdown . + +rsz:minimumSize + lv2:documentation """ + +Indicates that a port requires a buffer at least this large, in bytes. Any +host that supports the resize-port feature MUST connect any port with a +minimumSize specified to a buffer at least as large as the value given for this +property. Any host, especially those that do NOT support dynamic port +resizing, SHOULD do so or reduced functionality may result. + +"""^^lv2:Markdown . |