From 430284545345539c9ffb31df889debac1d3888b5 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 22 Mar 2020 16:36:44 +0100 Subject: Move documentation to metadata files and convert it to Markdown --- lv2/resize-port/resize-port.meta.ttl | 53 +++++++++++++++++++++++++++++++++++- lv2/resize-port/resize-port.ttl | 43 +++++------------------------ 2 files changed, 59 insertions(+), 37 deletions(-) (limited to 'lv2/resize-port') 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: . @prefix doap: . @prefix foaf: . +@prefix lv2: . @prefix rdfs: . +@prefix rsz: . 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 . diff --git a/lv2/resize-port/resize-port.ttl b/lv2/resize-port/resize-port.ttl index 37c6a9b..d9dae1d 100644 --- a/lv2/resize-port/resize-port.ttl +++ b/lv2/resize-port/resize-port.ttl @@ -7,27 +7,15 @@ a lv2:Specification ; + rdfs:label "LV2 Resize Port" ; + rdfs:comment "Dynamically sized LV2 port buffers." ; rdfs:seeAlso , - ; - 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.

-""" . + . rsz:resize a lv2:Feature ; - 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.

-""" . + rdfs:label "resize" ; + rdfs:comment "A feature for resizing output port buffers." . rsz:asLargeAs a rdf:Property , @@ -35,18 +23,7 @@ rsz:asLargeAs rdfs:domain lv2:Port ; rdfs:range lv2:Symbol ; rdfs:label "as large as" ; - 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 asLargeAs an input I is connected to a buffer large enough -to copy I, or NULL if the port is lv2:connectionOptional.

-""" . + rdfs:comment "Port that this port must have at least as much buffer space as." . rsz:minimumSize a rdf:Property , @@ -55,11 +32,5 @@ rsz:minimumSize rdfs:domain lv2:Port ; rdfs:range xsd:nonNegativeInteger ; rdfs:label "minimum size" ; - rdfs:comment """ -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. -""" . + rdfs:comment "Minimum buffer size required by a port, in bytes." . -- cgit v1.2.1