Classes | |
| struct | _LV2UI_Descriptor |
| struct | _LV2UI_Resize |
| struct | _LV2UI_Port_Map |
| struct | _LV2UI_Port_Subscribe |
| struct | _LV2UI_Touch |
| struct | LV2UI_Request_Value |
| struct | _LV2UI_Idle_Interface |
| struct | _LV2UI_Show_Interface |
| struct | _LV2UI_Peak_Data |
| struct | LV2UI_Descriptor |
| struct | LV2UI_Resize |
| struct | LV2UI_Port_Map |
| struct | LV2UI_Port_Subscribe |
| struct | LV2UI_Touch |
| struct | LV2UI_Idle_Interface |
| struct | LV2UI_Show_Interface |
| struct | LV2UI_Peak_Data |
Functions | |
| LV2_SYMBOL_EXPORT const LV2UI_Descriptor * | lv2ui_descriptor (uint32_t index) |
Detailed Description
User interfaces of any type for plugins, http://lv2plug.in/ns/extensions/ui for details.
User interfaces of any type for plugins.
See http://lv2plug.in/ns/extensions/ui for details.
Macro Definition Documentation
◆ LV2_UI__backgroundColor [1/2]
| #define LV2_UI__backgroundColor LV2_UI_PREFIX "backgroundColor" |
◆ LV2_UI__backgroundColor [2/2]
| #define LV2_UI__backgroundColor LV2_UI_PREFIX "backgroundColor" |
◆ LV2_UI__binary [1/2]
| #define LV2_UI__binary LV2_UI_PREFIX "binary" |
◆ LV2_UI__binary [2/2]
| #define LV2_UI__binary LV2_UI_PREFIX "binary" |
◆ LV2_UI__CocoaUI [1/2]
| #define LV2_UI__CocoaUI LV2_UI_PREFIX "CocoaUI" |
◆ LV2_UI__CocoaUI [2/2]
| #define LV2_UI__CocoaUI LV2_UI_PREFIX "CocoaUI" |
◆ LV2_UI__fixedSize [1/2]
| #define LV2_UI__fixedSize LV2_UI_PREFIX "fixedSize" |
◆ LV2_UI__fixedSize [2/2]
| #define LV2_UI__fixedSize LV2_UI_PREFIX "fixedSize" |
◆ LV2_UI__floatProtocol [1/2]
| #define LV2_UI__floatProtocol LV2_UI_PREFIX "floatProtocol" |
◆ LV2_UI__floatProtocol [2/2]
| #define LV2_UI__floatProtocol LV2_UI_PREFIX "floatProtocol" |
◆ LV2_UI__foregroundColor [1/2]
| #define LV2_UI__foregroundColor LV2_UI_PREFIX "foregroundColor" |
◆ LV2_UI__foregroundColor [2/2]
| #define LV2_UI__foregroundColor LV2_UI_PREFIX "foregroundColor" |
◆ LV2_UI__Gtk3UI [1/2]
| #define LV2_UI__Gtk3UI LV2_UI_PREFIX "Gtk3UI" |
◆ LV2_UI__Gtk3UI [2/2]
| #define LV2_UI__Gtk3UI LV2_UI_PREFIX "Gtk3UI" |
◆ LV2_UI__GtkUI [1/2]
| #define LV2_UI__GtkUI LV2_UI_PREFIX "GtkUI" |
◆ LV2_UI__GtkUI [2/2]
| #define LV2_UI__GtkUI LV2_UI_PREFIX "GtkUI" |
◆ LV2_UI__idleInterface [1/2]
| #define LV2_UI__idleInterface LV2_UI_PREFIX "idleInterface" |
◆ LV2_UI__idleInterface [2/2]
| #define LV2_UI__idleInterface LV2_UI_PREFIX "idleInterface" |
◆ LV2_UI__notifyType [1/2]
| #define LV2_UI__notifyType LV2_UI_PREFIX "notifyType" |
◆ LV2_UI__notifyType [2/2]
| #define LV2_UI__notifyType LV2_UI_PREFIX "notifyType" |
◆ LV2_UI__noUserResize [1/2]
| #define LV2_UI__noUserResize LV2_UI_PREFIX "noUserResize" |
◆ LV2_UI__noUserResize [2/2]
| #define LV2_UI__noUserResize LV2_UI_PREFIX "noUserResize" |
◆ LV2_UI__parent [1/2]
| #define LV2_UI__parent LV2_UI_PREFIX "parent" |
◆ LV2_UI__parent [2/2]
| #define LV2_UI__parent LV2_UI_PREFIX "parent" |
◆ LV2_UI__peakProtocol [1/2]
| #define LV2_UI__peakProtocol LV2_UI_PREFIX "peakProtocol" |
◆ LV2_UI__peakProtocol [2/2]
| #define LV2_UI__peakProtocol LV2_UI_PREFIX "peakProtocol" |
◆ LV2_UI__plugin [1/2]
| #define LV2_UI__plugin LV2_UI_PREFIX "plugin" |
◆ LV2_UI__plugin [2/2]
| #define LV2_UI__plugin LV2_UI_PREFIX "plugin" |
◆ LV2_UI__portIndex [1/2]
| #define LV2_UI__portIndex LV2_UI_PREFIX "portIndex" |
◆ LV2_UI__portIndex [2/2]
| #define LV2_UI__portIndex LV2_UI_PREFIX "portIndex" |
◆ LV2_UI__portMap [1/2]
| #define LV2_UI__portMap LV2_UI_PREFIX "portMap" |
◆ LV2_UI__portMap [2/2]
| #define LV2_UI__portMap LV2_UI_PREFIX "portMap" |
◆ LV2_UI__PortNotification [1/2]
| #define LV2_UI__PortNotification LV2_UI_PREFIX "PortNotification" |
◆ LV2_UI__PortNotification [2/2]
| #define LV2_UI__PortNotification LV2_UI_PREFIX "PortNotification" |
◆ LV2_UI__portNotification [1/2]
| #define LV2_UI__portNotification LV2_UI_PREFIX "portNotification" |
◆ LV2_UI__portNotification [2/2]
| #define LV2_UI__portNotification LV2_UI_PREFIX "portNotification" |
◆ LV2_UI__PortProtocol [1/2]
| #define LV2_UI__PortProtocol LV2_UI_PREFIX "PortProtocol" |
◆ LV2_UI__PortProtocol [2/2]
| #define LV2_UI__PortProtocol LV2_UI_PREFIX "PortProtocol" |
◆ LV2_UI__portSubscribe [1/2]
| #define LV2_UI__portSubscribe LV2_UI_PREFIX "portSubscribe" |
◆ LV2_UI__portSubscribe [2/2]
| #define LV2_UI__portSubscribe LV2_UI_PREFIX "portSubscribe" |
◆ LV2_UI__protocol [1/2]
| #define LV2_UI__protocol LV2_UI_PREFIX "protocol" |
◆ LV2_UI__protocol [2/2]
| #define LV2_UI__protocol LV2_UI_PREFIX "protocol" |
◆ LV2_UI__Qt4UI [1/2]
| #define LV2_UI__Qt4UI LV2_UI_PREFIX "Qt4UI" |
◆ LV2_UI__Qt4UI [2/2]
| #define LV2_UI__Qt4UI LV2_UI_PREFIX "Qt4UI" |
◆ LV2_UI__Qt5UI [1/2]
| #define LV2_UI__Qt5UI LV2_UI_PREFIX "Qt5UI" |
◆ LV2_UI__Qt5UI [2/2]
| #define LV2_UI__Qt5UI LV2_UI_PREFIX "Qt5UI" |
◆ LV2_UI__requestValue [1/2]
| #define LV2_UI__requestValue LV2_UI_PREFIX "requestValue" |
◆ LV2_UI__requestValue [2/2]
| #define LV2_UI__requestValue LV2_UI_PREFIX "requestValue" |
◆ LV2_UI__resize [1/2]
| #define LV2_UI__resize LV2_UI_PREFIX "resize" |
◆ LV2_UI__resize [2/2]
| #define LV2_UI__resize LV2_UI_PREFIX "resize" |
◆ LV2_UI__scaleFactor [1/2]
| #define LV2_UI__scaleFactor LV2_UI_PREFIX "scaleFactor" |
◆ LV2_UI__scaleFactor [2/2]
| #define LV2_UI__scaleFactor LV2_UI_PREFIX "scaleFactor" |
◆ LV2_UI__showInterface [1/2]
| #define LV2_UI__showInterface LV2_UI_PREFIX "showInterface" |
◆ LV2_UI__showInterface [2/2]
| #define LV2_UI__showInterface LV2_UI_PREFIX "showInterface" |
◆ LV2_UI__touch [1/2]
| #define LV2_UI__touch LV2_UI_PREFIX "touch" |
◆ LV2_UI__touch [2/2]
| #define LV2_UI__touch LV2_UI_PREFIX "touch" |
◆ LV2_UI__UI [1/2]
| #define LV2_UI__UI LV2_UI_PREFIX "UI" |
◆ LV2_UI__UI [2/2]
| #define LV2_UI__UI LV2_UI_PREFIX "UI" |
◆ LV2_UI__ui [1/2]
| #define LV2_UI__ui LV2_UI_PREFIX "ui" |
◆ LV2_UI__ui [2/2]
| #define LV2_UI__ui LV2_UI_PREFIX "ui" |
◆ LV2_UI__updateRate [1/2]
| #define LV2_UI__updateRate LV2_UI_PREFIX "updateRate" |
◆ LV2_UI__updateRate [2/2]
| #define LV2_UI__updateRate LV2_UI_PREFIX "updateRate" |
◆ LV2_UI__WindowsUI [1/2]
| #define LV2_UI__WindowsUI LV2_UI_PREFIX "WindowsUI" |
◆ LV2_UI__WindowsUI [2/2]
| #define LV2_UI__WindowsUI LV2_UI_PREFIX "WindowsUI" |
◆ LV2_UI__windowTitle [1/2]
| #define LV2_UI__windowTitle LV2_UI_PREFIX "windowTitle" |
◆ LV2_UI__windowTitle [2/2]
| #define LV2_UI__windowTitle LV2_UI_PREFIX "windowTitle" |
◆ LV2_UI__X11UI [1/2]
| #define LV2_UI__X11UI LV2_UI_PREFIX "X11UI" |
◆ LV2_UI__X11UI [2/2]
| #define LV2_UI__X11UI LV2_UI_PREFIX "X11UI" |
◆ LV2_UI_PREFIX [1/2]
| #define LV2_UI_PREFIX LV2_UI_URI "#" |
◆ LV2_UI_PREFIX [2/2]
| #define LV2_UI_PREFIX LV2_UI_URI "#" |
◆ LV2_UI_URI [1/2]
| #define LV2_UI_URI "http://lv2plug.in/ns/extensions/ui" |
◆ LV2_UI_URI [2/2]
| #define LV2_UI_URI "http://lv2plug.in/ns/extensions/ui" |
◆ LV2UI_INVALID_PORT_INDEX [1/2]
| #define LV2UI_INVALID_PORT_INDEX ((uint32_t)-1) |
The index returned by LV2UI_Port_Map::port_index() for unknown ports.
◆ LV2UI_INVALID_PORT_INDEX [2/2]
| #define LV2UI_INVALID_PORT_INDEX ((uint32_t)-1) |
The index returned by LV2UI_Port_Map::port_index() for unknown ports.
Typedef Documentation
◆ LV2UI_Controller [1/2]
| typedef void* LV2UI_Controller |
A pointer to a controller provided by the host.
The UI may compare this to NULL, but otherwise MUST NOT interpret it.
◆ LV2UI_Controller [2/2]
| typedef void* LV2UI_Controller |
A pointer to a controller provided by the host.
The UI may compare this to NULL, but otherwise MUST NOT interpret it.
◆ LV2UI_Descriptor [1/2]
| typedef struct _LV2UI_Descriptor LV2UI_Descriptor |
A plugin UI.
A pointer to an object of this type is returned by the lv2ui_descriptor() function.
◆ LV2UI_Descriptor [2/2]
| typedef struct LV2UI_Descriptor LV2UI_Descriptor |
A plugin UI.
A pointer to an object of this type is returned by the lv2ui_descriptor() function.
◆ LV2UI_DescriptorFunction [1/2]
| typedef const LV2UI_Descriptor *(* LV2UI_DescriptorFunction) (uint32_t index) |
The type of the lv2ui_descriptor() function.
◆ LV2UI_DescriptorFunction [2/2]
| typedef const LV2UI_Descriptor *(* LV2UI_DescriptorFunction) (uint32_t index) |
The type of the lv2ui_descriptor() function.
◆ LV2UI_Feature_Handle [1/2]
| typedef void* LV2UI_Feature_Handle |
A pointer to opaque data for a feature.
◆ LV2UI_Feature_Handle [2/2]
| typedef void* LV2UI_Feature_Handle |
A pointer to opaque data for a feature.
◆ LV2UI_Handle [1/2]
| typedef void* LV2UI_Handle |
A pointer to UI instance internals.
The host may compare this to NULL, but otherwise MUST NOT interpret it.
◆ LV2UI_Handle [2/2]
| typedef void* LV2UI_Handle |
A pointer to UI instance internals.
The host may compare this to NULL, but otherwise MUST NOT interpret it.
◆ LV2UI_Idle_Interface
| typedef struct _LV2UI_Idle_Interface LV2UI_Idle_Interface |
UI Idle Interface (LV2_UI__idleInterface)
UIs can provide this interface to have an idle() callback called by the host rapidly to update the UI.
◆ LV2UI_Peak_Data
| typedef struct _LV2UI_Peak_Data LV2UI_Peak_Data |
Peak data for a slice of time, the update format for ui:peakProtocol.
◆ LV2UI_Port_Map
| typedef struct _LV2UI_Port_Map LV2UI_Port_Map |
Feature to map port symbols to UIs.
This can be used by the UI to get the index for a port with the given symbol. This makes it possible to implement and distribute a UI separately from the plugin (since symbol, unlike index, is a stable port identifier).
◆ LV2UI_Port_Subscribe
| typedef struct _LV2UI_Port_Subscribe LV2UI_Port_Subscribe |
Feature to subscribe to port updates (LV2_UI__portSubscribe).
◆ LV2UI_Resize
| typedef struct _LV2UI_Resize LV2UI_Resize |
Feature/interface for resizable UIs (LV2_UI__resize).
This structure is used in two ways: as a feature passed by the host via LV2UI_Descriptor::instantiate(), or as an interface provided by a UI via LV2UI_Descriptor::extension_data()).
◆ LV2UI_Show_Interface
| typedef struct _LV2UI_Show_Interface LV2UI_Show_Interface |
UI Show Interface (LV2_UI__showInterface)
UIs can provide this interface to show and hide a window, which allows them to function in hosts unable to embed their widget. This allows any UI to provide a fallback for embedding that works in any host.
If used:
- The host MUST use LV2UI_Idle_Interface to drive the UI.
- The UI MUST return non-zero from LV2UI_Idle_Interface::idle() when it has been closed.
- If idle() returns non-zero, the host MUST call hide() and stop calling idle(). It MAY later call show() then resume calling idle().
◆ LV2UI_Touch
| typedef struct _LV2UI_Touch LV2UI_Touch |
A feature to notify the host that the user has grabbed a UI control.
◆ LV2UI_Widget [1/2]
| typedef void* LV2UI_Widget |
A pointer to some widget or other type of UI handle.
The actual type is defined by the type of the UI.
◆ LV2UI_Widget [2/2]
| typedef void* LV2UI_Widget |
A pointer to some widget or other type of UI handle.
The actual type is defined by the type of the UI.
◆ LV2UI_Write_Function [1/2]
| typedef void(* LV2UI_Write_Function) (LV2UI_Controller controller, uint32_t port_index, uint32_t buffer_size, uint32_t port_protocol, const void *buffer) |
A host-provided function that sends data to a plugin's input ports.
- Parameters
-
controller The opaque controller pointer passed to LV2UI_Descriptor::instantiate(). port_index Index of the port to update. buffer Buffer containing buffer_size bytes of data. buffer_size Size of buffer in bytes. port_protocol Either 0 or the URID for a ui:PortProtocol. If 0, the protocol is implicitly ui:floatProtocol, the port MUST be an lv2:ControlPort input, buffer MUST point to a single float value, and buffer_size MUST be sizeof(float). The UI SHOULD NOT use a protocol not supported by the host, but the host MUST gracefully ignore any protocol it does not understand.
◆ LV2UI_Write_Function [2/2]
| typedef void(* LV2UI_Write_Function) (LV2UI_Controller controller, uint32_t port_index, uint32_t buffer_size, uint32_t port_protocol, const void *buffer) |
A host-provided function that sends data to a plugin's input ports.
- Parameters
-
controller The opaque controller pointer passed to LV2UI_Descriptor::instantiate(). port_index Index of the port to update. buffer Buffer containing buffer_size bytes of data. buffer_size Size of buffer in bytes. port_protocol Either 0 or the URID for a ui:PortProtocol. If 0, the protocol is implicitly ui:floatProtocol, the port MUST be an lv2:ControlPort input, buffer MUST point to a single float value, and buffer_size MUST be sizeof(float). The UI SHOULD NOT use a protocol not supported by the host, but the host MUST gracefully ignore any protocol it does not understand.
Enumeration Type Documentation
◆ LV2UI_Request_Value_Status [1/2]
A status code for LV2UI_Request_Value::request.
◆ LV2UI_Request_Value_Status [2/2]
A status code for LV2UI_Request_Value::request().
Function Documentation
◆ lv2ui_descriptor()
| LV2_SYMBOL_EXPORT const LV2UI_Descriptor * lv2ui_descriptor | ( | uint32_t | index | ) |
Prototype for UI accessor function.
This is the entry point to a UI library, which works in the same way as lv2_descriptor() but for UIs rather than plugins.
Generated on for LMMS by
1.16.1