Struct IcedEditor 

pub struct IcedEditor<P, M>
where
    P: Params + 'static,
    M: IcedPlugin<P>,
{ /* private fields */ }

Iced-based plugin editor.

Type parameters:

• P - the plugin’s Params type
• M - the plugin’s IcedPlugin implementation

Implementations

impl<P: Params + 'static> IcedEditor<P, AutoPlugin>

pub fn from_layout(params: Arc<P>, layout: GridLayout) -> Self

Create an editor that auto-generates the UI from a GridLayout.

impl<P: Params + 'static, M: IcedPlugin<P> + 'static> IcedEditor<P, M>

pub fn new(params: Arc<P>, size: (u32, u32)) -> Self

Create an editor with a custom IcedPlugin implementation.

pub fn with_font(self, family: &'static str, data: &'static [u8]) -> Self

Set a custom default font (family name + TrueType data).

IcedEditor::new(params, (250, 330))
    .with_font("JetBrains Mono", truce_gui::font::JETBRAINS_MONO)

pub fn with_meter_ids(self, ids: Vec<impl Into<u32>>) -> Self

Set meter IDs to poll each tick.

Trait Implementations

impl<P: Params + 'static, M: IcedPlugin<P> + 'static> Drop for IcedEditor<P, M>

fn drop(&mut self)

Defensive cleanup for hosts that drop the editor without first calling Editor::close. Pro Tools AAX has been seen to do this on plugin removal under certain conditions; live-coding hosts and unit tests can also short-circuit the lifecycle. On Linux baseview::WindowHandle has no Drop, so without an explicit close the render thread would keep running against a freed *mut IcedEditor and later panic inside wgpu as surfaces tear down. close() is idempotent - baseview_window.take() no-ops on the second call - so calling it here on top of a well-behaved host’s earlier close() is safe.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<P: Params + 'static, M: IcedPlugin<P>> Editor for IcedEditor<P, M>

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

Initial window size in logical points.

fn open(&mut self, parent: RawWindowHandle, context: PluginContext)

Create the GUI as a child of the host-provided parent window.

fn close(&mut self)

Destroy the GUI.

fn idle(&mut self)

Called ~60fps on the host’s UI thread for repaint/animation.

fn can_resize(&self) -> bool

Whether the plugin supports resizing.

fn screenshot( &mut self, _params: Arc<dyn Params>, ) -> Option<(Vec<u8>, u32, u32)>

Render a headless screenshot of the editor at its natural size.

fn set_size(&mut self, width: u32, height: u32) -> bool

Host requests a resize. Return true to accept.

fn set_scale_factor(&mut self, factor: f64)

Host notifies the editor of a new content scale factor.

fn state_changed(&mut self)

Plugin state was restored (preset recall, undo, session load).

impl<P: Params, M: IcedPlugin<P>> Send for IcedEditor<P, M>