From c3b1ded35b9113bb5f578e6f99c90dd92da32e14 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Mon, 11 Apr 2022 16:23:34 +0200 Subject: [PATCH] Fix links in docs --- nih_plug_vizia/src/lib.rs | 8 ++++---- src/context.rs | 8 ++++---- src/midi.rs | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/nih_plug_vizia/src/lib.rs b/nih_plug_vizia/src/lib.rs index 0d40c33a..feaf0cc4 100644 --- a/nih_plug_vizia/src/lib.rs +++ b/nih_plug_vizia/src/lib.rs @@ -58,8 +58,8 @@ where })) } -/// State for a `nih_plug_vizia` editor. The scale factor can be manipulated at runtime by emitting -/// [`WindowEvent::SetScale`][vizia::WindowEvent::SetScale] events. +/// State for a `nih_plug_vizia` editor. The scale factor can be manipulated at runtime by changing +/// `cx.user_scale_factor`. /// /// # TODO /// @@ -86,7 +86,7 @@ impl ViziaState { /// The same as [`from_size()`][Self::from_size()], 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 emitting [`WindowEvent::SetScale`][vizia::WindowEvent::SetScale] events. + /// runtime by changing `cx.user_scale_factor`. pub fn from_size_with_scale(width: u32, height: u32, scale_factor: f64) -> Arc { Arc::new(ViziaState { size: AtomicCell::new((width, height)), @@ -114,7 +114,7 @@ impl ViziaState { } /// Get the non-DPI related uniform scaling factor the GUI's size will be multiplied with. This - /// can be changed by emitting [`WindowEvent::SetScale`][vizia::WindowEvent::SetScale] events. + /// can be changed by changing `cx.user_scale_factor`. pub fn user_scale_factor(&self) -> f64 { self.scale_factor.load() } diff --git a/src/context.rs b/src/context.rs index e2eec046..cbbd263d 100644 --- a/src/context.rs +++ b/src/context.rs @@ -45,10 +45,10 @@ pub trait ProcessContext { // The implementing wrapper can assume that everything is being called from the main thread. Since // NIH-plug doesn't own the GUI event loop, this invariant cannot be part of the interface. pub trait GuiContext: Send + Sync + 'static { - /// Ask the host to resize the editor window to the size specified by [crate::Editor::size()]. - /// This will return false if the host somehow didn't like this and rejected the resize, in - /// which case the window should revert to its old size. You should only actually resize your - /// embedded window once this returns `true`. + /// Ask the host to resize the editor window to the size specified by + /// [`Editor::size()`][crate::prelude::Editor::size()]. This will return false if the host + /// somehow didn't like this and rejected the resize, in which case the window should revert to + /// its old size. You should only actually resize your embedded window once this returns `true`. /// /// TODO: Host->Plugin resizing has not been implemented yet fn request_resize(&self) -> bool; diff --git a/src/midi.rs b/src/midi.rs index 86e28953..83343ce0 100644 --- a/src/midi.rs +++ b/src/midi.rs @@ -17,8 +17,8 @@ pub enum MidiConfig { } /// Event for (incoming) notes. The set of supported note events depends on the value of -/// [`Plugin::MIDI_INPUT`]. Also check out the [`util`][crate::util] module for convenient -/// conversion functions. +/// [`Plugin::MIDI_INPUT`][crate::prelude::Plugin::MIDI_INPUT]. Also check out the +/// [`util`][crate::util] module for convenient conversion functions. /// /// All of the timings are sample offsets withing the current buffer. #[derive(Debug, Clone, Copy, PartialEq)]