Crate nih_plug_egui
source ·Expand description
egui editor support for NIH plug.
TODO: Proper usage example, for now check out the gain_gui example
Re-exports
pub use egui;
Modules
- Custom egui widgets for displaying parameter values.
Structs
- State for an
nih_plug_egui
editor.
Functions
- Create an
Editor
instance using an [egui
][::egui] GUI. Using the user state parameter is optional, but it can be useful for keeping track of some temporary GUI-only settings. See thegui_gain
example for more information on how to use this. TheEguiState
passed to this function contains the GUI’s intitial size, and this is kept in sync whenever the GUI gets resized. You can also use this to know if the GUI is open, so you can avoid performing potentially expensive calculations while the GUI is not open. If you want this size to be persisted when restoring a plugin instance, then you can store it in a#[persist = "key"]
field on your parameters struct.