alex/nih-plug
1
0
Fork 0
Code Activity

Add more documentation for disabled vizia fonts

Browse source
This commit is contained in:
Robbert van der Helm 2022-11-06 14:09:13 +01:00
parent c6a2be41f4
commit 1df1a646a0
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
nih_plug_vizia/src/lib.rs
View file

@ -33,7 +33,10 @@ pub mod widgets;
/// The `theming` argument controls what level of theming to apply. If you use /// The `theming` argument controls what level of theming to apply. If you use
/// [`ViziaTheming::Custom`], then you **need** to call /// [`ViziaTheming::Custom`], then you **need** to call
/// [`nih_plug_vizia::assets::register_noto_sans_light()`][assets::register_noto_sans_light()] at /// [`nih_plug_vizia::assets::register_noto_sans_light()`][assets::register_noto_sans_light()] at
/// the start of your app function. /// the start of your app function. Vizia's included fonts are also not registered by default. If
/// you use the Roboto font that normally comes with Vizia or any of its emoji or icon fonts, you
/// also need to register those using the functions in
/// [`nih_plug_vizia::vizia_assets`][crate::vizia_assets].
/// ///
/// See [VIZIA](https://github.com/vizia/vizia)'s repository for examples on how to use this. /// See [VIZIA](https://github.com/vizia/vizia)'s repository for examples on how to use this.
pub fn create_vizia_editor<F>( pub fn create_vizia_editor<F>(
@ -64,7 +67,10 @@ where
pub enum ViziaTheming { pub enum ViziaTheming {
/// Disable both `nih_plug_vizia`'s and vizia's built-in theming. /// Disable both `nih_plug_vizia`'s and vizia's built-in theming.
None, None,
/// Disable `nih_plug_vizia`'s custom theming. /// Disable `nih_plug_vizia`'s custom theming. Vizia's included fonts are also not registered by
/// default. If you use the Roboto font that normally comes with Vizia or any of its emoji or
/// icon fonts, you need to register those using the functions in
/// [`nih_plug_vizia::vizia_assets`][crate::vizia_assets].
Builtin, Builtin,
/// Apply `nih_plug_vizia`'s custom theming. This is the default. You **need** to call /// Apply `nih_plug_vizia`'s custom theming. This is the default. You **need** to call
/// [`nih_plug_vizia::assets::register_noto_sans_light()`][assets::register_noto_sans_light()] /// [`nih_plug_vizia::assets::register_noto_sans_light()`][assets::register_noto_sans_light()]