Struct nih_plug_vizia::ViziaState

pub struct ViziaState { /* private fields */ }

State for an nih_plug_vizia editor. The scale factor can be manipulated at runtime using cx.set_user_scale_factor().

Implementations

impl ViziaState

pub fn new( size_fn: impl Fn() -> (u32, u32) + Send + Sync + 'static ) -> Arc<ViziaState>

Initialize the GUI’s state. This value can be passed to create_vizia_editor(). The callback always returns the window’s current size is in logical pixels, so before it is multiplied by the DPI scaling factor. This size can be computed based on the plugin’s current state.

pub fn new_with_default_scale_factor( size_fn: impl Fn() -> (u32, u32) + Send + Sync + 'static, default_scale_factor: f64 ) -> Arc<ViziaState>

The same as new(), but with a separate initial scale factor. This scale factor gets applied on top of any HiDPI scaling, and it can be modified at runtime by changing cx.set_user_scale_factor().

pub fn scaled_logical_size(&self) -> (u32, u32)

Returns a (width, height) pair for the current size of the GUI in logical pixels, after applying the user scale factor.

pub fn inner_logical_size(&self) -> (u32, u32)

Returns a (width, height) pair for the current size of the GUI in logical pixels before applying the user scale factor.

pub fn user_scale_factor(&self) -> f64

Get the non-DPI related uniform scaling factor the GUI’s size will be multiplied with. This can be changed by changing cx.user_scale_factor.

pub fn is_open(&self) -> bool

Whether the GUI is currently visible.

Trait Implementations

impl Debug for ViziaState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ViziaState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PersistentField<'a, ViziaState> for Arc<ViziaState>

fn set(&self, new_value: ViziaState)

Update the stored T value using interior mutability.

fn map<F, R>(&self, f: F) -> Rwhere F: Fn(&ViziaState) -> R,

Get a reference to the stored T value, and apply a function to it. This is used to serialize the T value.

impl Serialize for ViziaState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.