vello_tests/tests/emoji.rs

// Copyright 2024 the Vello Authors
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Snapshot tests for Emoji [`scenes`].

// The following lints are part of the Linebender standard set,
// but resolving them has been deferred for now.
// Feel free to send a PR that solves one or more of these.
#![allow(
    clippy::cast_possible_truncation,
    clippy::allow_attributes_without_reason
)]

use scenes::SimpleText;
#[cfg(target_os = "macos")]
use std::sync::Arc;
#[cfg(target_os = "macos")]
use vello::peniko::color::palette;
#[cfg(target_os = "macos")]
use vello::peniko::{Blob, Brush, Font};
use vello::{Scene, kurbo::Affine, peniko::Fill};
use vello_tests::{TestParams, snapshot_test_sync};

fn encode_noto_colr(text: &str, font_size: f32) -> Scene {
    let mut scene = Scene::new();
    let mut simple_text = SimpleText::new();
    simple_text.add_colr_emoji_run(
        &mut scene,
        font_size,
        Affine::translate((0., f64::from(font_size))),
        None,
        Fill::EvenOdd,
        text,
    );
    scene
}

fn encode_noto_bitmap(text: &str, font_size: f32) -> Scene {
    let mut scene = Scene::new();
    let mut simple_text = SimpleText::new();
    simple_text.add_bitmap_emoji_run(
        &mut scene,
        font_size,
        Affine::translate((0., f64::from(font_size))),
        None,
        Fill::EvenOdd,
        text,
    );
    scene
}

#[cfg(target_os = "macos")]
fn encode_apple_bitmap(text: &str, font_size: f32) -> Scene {
    let font = Font::new(
        Blob::new(Arc::new(
            std::fs::read("/System/Library/Fonts/Apple Color Emoji.ttc").unwrap(),
        )),
        0,
    );
    let mut scene = Scene::new();
    let mut simple_text = SimpleText::new();
    simple_text.add_var_run(
        &mut scene,
        Some(&font),
        font_size,
        &[],
        // This should be unused
        &Brush::Solid(palette::css::WHITE),
        Affine::translate((0., f64::from(font_size))),
        None,
        Fill::EvenOdd,
        text,
        false,
    );
    scene
}

/// The Emoji supported by our font subset.
const TEXT: &str = "✅👀🎉🤠";

#[test]
#[cfg_attr(skip_gpu_tests, ignore)]
fn big_colr() {
    let font_size = 48.;
    let scene = encode_noto_colr(TEXT, font_size);
    let params = TestParams::new(
        "big_colr",
        (font_size * 10.) as _,
        // Noto Emoji seem to be about 25% bigger than the actual font_size suggests
        (font_size * 1.25).ceil() as _,
    );
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.002);
}

#[test]
#[cfg_attr(skip_gpu_tests, ignore)]
fn little_colr() {
    let font_size = 10.;
    let scene = encode_noto_colr(TEXT, font_size);
    let params = TestParams::new(
        "little_colr",
        (font_size * 10.) as _,
        (font_size * 1.25).ceil() as _,
    );
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.002);
}

#[test]
#[cfg_attr(skip_gpu_tests, ignore)]
fn colr_undef() {
    let font_size = 10.;
    // This emoji isn't in the subset we have made
    let scene = encode_noto_colr("🤷", font_size);
    let params = TestParams::new(
        "colr_undef",
        (font_size * 10.) as _,
        (font_size * 1.25).ceil() as _,
    );
    // TODO: Work out why the undef glyph is nothing - is it an issue with our font subset or with our renderer?
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.001);
}

#[test]
#[cfg_attr(skip_gpu_tests, ignore)]
fn big_bitmap() {
    let font_size = 48.;
    let scene = encode_noto_bitmap(TEXT, font_size);
    let params = TestParams::new(
        "big_bitmap",
        (font_size * 10.) as _,
        (font_size * 1.25).ceil() as _,
    );
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.001);
}

#[test]
#[cfg(target_os = "macos")]
#[cfg_attr(skip_gpu_tests, ignore)]
fn big_bitmap_apple() {
    let font_size = 48.;
    let scene = encode_apple_bitmap(TEXT, font_size);
    let params = TestParams::new(
        "big_bitmap_apple",
        (font_size * 10.) as _,
        (font_size * 1.25).ceil() as _,
    );
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.001);
}

#[test]
#[cfg_attr(skip_gpu_tests, ignore)]
fn little_bitmap() {
    let font_size = 10.;
    let scene = encode_noto_bitmap(TEXT, font_size);
    let params = TestParams::new(
        "little_bitmap",
        (font_size * 10.) as _,
        (font_size * 1.25).ceil() as _,
    );
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.001);
}

#[test]
#[cfg_attr(skip_gpu_tests, ignore)]
fn bitmap_undef() {
    let font_size = 10.;
    // This emoji isn't in the subset we have made
    let scene = encode_noto_bitmap("🤷", font_size);
    let params = TestParams::new(
        "bitmap_undef",
        (font_size * 10.) as _,
        (font_size * 1.25).ceil() as _,
    );
    // TODO: Work out why the undef glyph is nothing - is it an issue with our font subset or with our renderer?
    snapshot_test_sync(scene, &params)
        .unwrap()
        .assert_mean_less_than(0.001);
}