Module nih_plug_vizia::widgets

source ·
Expand description

Widgets and utilities for making widgets to integrate VIZIA with NIH-plug.

Note

None of these widgets are finalized, and their sizes or looks can change at any point. Feel free to copy the widgets and modify them to your personal taste.

Modules

  • param_base
    A base widget for creating other widgets that integrate with NIH-plug’s Param types.
  • util
    Utilities for writing VIZIA widgets.

Structs

  • GenericUi
    Shows a generic UI for a Params object. For additional flexibility you can either use the new() method to have the generic UI decide which widget to use for your parameters, or you can use the new_custom() method to determine this yourself.
  • ParamButton
    A toggleable button that integrates with NIH-plug’s Param types. Only makes sense with BoolParams. Clicking on the button will toggle between the parameter’s minimum and maximum value. The :checked pseudoclass indicates whether or not the button is currently pressed.
  • ParamSlider
    A slider that integrates with NIH-plug’s Param types. Use the set_style() method to change how the value gets displayed.
  • PeakMeter
    A simple horizontal peak meter.
  • ResizeHandle
    A resize handle placed at the bottom right of the window that lets you resize the window.

Enums

  • GuiContextEvent
    Events that directly interact with the GuiContext. Used to trigger resizes.
  • ParamEvent
    An event that updates a parameter’s value. Since NIH-plug manages the parameters, interacting with parameter values with VIZIA works a little different from updating any other state. These events are automatically handled by nih_plug_vizia.
  • ParamSliderStyle
    How the ParamSlider should display its values. Set this using ParamSliderExt::set_style().
  • RawParamEvent
    The same as ParamEvent, but type erased. Use ParamEvent as an easier way to construct these if you are working with regular parameter objects.

Traits

Functions