Merge pull request #92 from notgull/font-system-new-warning

docs: Add a warning about FontSystem::new()
This commit is contained in:
Jeremy Soller 2023-03-02 14:54:23 -07:00 committed by GitHub
commit 0548d7ae59
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -24,6 +24,12 @@ pub struct FontSystem(FontSystemInner);
impl FontSystem {
/// Create a new [`FontSystem`], that allows access to any installed system fonts
///
/// # Timing
///
/// This function takes some time to run. On the release build, it can take up to a second,
/// while debug builds can take up to ten times longer. For this reason, it should only be
/// called once, and the resulting [`FontSystem`] should be shared.
pub fn new() -> Self {
Self::new_with_fonts(std::iter::empty())
}