Public Member Functions | Static Public Member Functions | Protected Member Functions
LV2::GUI Class Reference

#include <lv2gui.hpp>

Inherits LV2::MixinTree< Derived, Ext1, Ext2, Ext3, Ext4, Ext5, Ext6, Ext7, Ext8, Ext9 >.

List of all members.

Public Member Functions

void port_event (uint32_t port, uint32_t buffer_size, uint32_t format, void const *buffer)
void * controller ()

Static Public Member Functions

static int register_class (char const *uri)

Protected Member Functions

void write (uint32_t port, uint32_t buffer_size, uint32_t format, void const *buffer)
void write_control (uint32_t port, float value)
LV2::Feature const *const * features ()
char const * bundle_path () const

Detailed Description

This is the base class for a plugin GUI. You should inherit it and override any public member functions you want to provide implementations for. All subclasses must have a constructor with the signature

      MyGUI(char const* plugin_uri);

where plugin_uri is the URI of the plugin that this GUI will control (not the URI for the GUI itself).

You can extend your GUI classes, for example adding support for GUI extensions, by passing GUI mixin classes as template parameters to GUI (second template parameter and onwards).


Member Function Documentation

char const* LV2::GUI::bundle_path ( ) const [inline, protected]

Get the filesystem path to the bundle that contains this GUI.

void* LV2::GUI::controller ( ) [inline]

Get the controller - a handle on the plugin instance this GUI is controlling. You only need it if you want to handle extensions yourself.

LV2::Feature const* const* LV2::GUI::features ( ) [inline, protected]

Get the feature array that was passed by the host. This may only be valid while the constructor is running.

void LV2::GUI::port_event ( uint32_t  port,
uint32_t  buffer_size,
uint32_t  format,
void const *  buffer 
) [inline]

Override this if you want your GUI to do something when a control port value changes in the plugin instance.

static int LV2::GUI::register_class ( char const *  uri) [inline, static]

Use this template function to register a class as a LV2 GUI.

void LV2::GUI::write ( uint32_t  port,
uint32_t  buffer_size,
uint32_t  format,
void const *  buffer 
) [inline, protected]

Send a chunk of data to a plugin port. The format of the chunk is determined by the port type and the transfer mechanisms used, you should probably use a wrapper function instead such as write_control().

Referenced by write_control().

void LV2::GUI::write_control ( uint32_t  port,
float  value 
) [inline, protected]

Set the value of a control input port in the plugin instance.

References write().


The documentation for this class was generated from the following file: