Trait rsynth::backend::vst_backend::vst::editor::Editor

source ·

pub trait Editor {
    // Required methods
    fn size(&self) -> (i32, i32);
    fn position(&self) -> (i32, i32);
    fn open(&mut self, parent: *mut c_void) -> bool;
    fn is_open(&mut self) -> bool;

    // Provided methods
    fn idle(&mut self) { ... }
    fn close(&mut self) { ... }
    fn set_knob_mode(&mut self, mode: KnobMode) -> bool { ... }
    fn key_up(&mut self, keycode: KeyCode) -> bool { ... }
    fn key_down(&mut self, keycode: KeyCode) -> bool { ... }
}

Expand description

Implemented by plugin editors.

Required Methods§

source

fn size(&self) -> (i32, i32)

Get the size of the editor window.

source

fn position(&self) -> (i32, i32)

Get the coordinates of the editor window.

source

fn open(&mut self, parent: *mut c_void) -> bool

Called when the editor window is opened.

parent is a window pointer that the new window should attach itself to. It is dependent upon the platform you are targeting.

A few examples:

On Windows, it should be interpreted as a HWND
On Mac OS X (64 bit), it should be interpreted as a NSView*
On X11 platforms, it should be interpreted as a u32 (the ID number of the parent window)

Return true if the window opened successfully, false otherwise.

source