Initial drop shadow support (#863)

Co-authored-by: Christopher Serr <[email protected]>

Author: Skajdrowski

capi/src/server_protocol.rs

@@ -19,7 +19,8 @@ pub struct ServerProtocol {}
 impl ServerProtocol {
     /// Handles an incoming command and returns the response to be sent.
     pub async unsafe fn handleCommand(command: &str, commandSink: *const CommandSink) -> String {
-        server_protocol::handle_command(command, &*commandSink).await
+        // SAFETY: The caller must ensure that the pointer is valid.
+        server_protocol::handle_command(command, unsafe { &*commandSink }).await
     }
 
     /// Encodes an event that happened to be sent.

capi/src/web_rendering.rs

@@ -41,6 +41,9 @@ impl WebRenderer {
         state: *const LayoutState,
         image_cache: *const ImageCache,
     ) -> Option<Box<[f32]>> {
-        self.inner.render(&*state, &*image_cache).map(Box::from)
+        // SAFETY: The caller must ensure that the pointers are valid.
+        unsafe {
+            self.inner.render(&*state, &*image_cache).map(Box::from)
+        }
     }
 }

src/layout/general_settings.rs

@@ -22,6 +22,8 @@ pub struct GeneralSettings {
     /// The font to use for regular text. `None` means a default font should be
     /// used.
     pub text_font: Option<Font>,
+    /// The color to use for drawn shadows.
+    pub text_shadow: Option<Color>,
     /// The background to show behind the layout.
     pub background: LayoutBackground,
     /// The color to use for when the runner achieved a best segment.
@@ -59,6 +61,7 @@ impl Default for GeneralSettings {
             timer_font: None,
             times_font: None,
             text_font: None,
+            text_shadow: Some(Color::hsla(0.0, 0.0, 0.0, 0.5)),
             background: LayoutBackground::Gradient(Gradient::Plain(Color::hsla(
                 0.0, 0.0, 0.06, 1.0,
             ))),
@@ -109,6 +112,11 @@ impl GeneralSettings {
                     .into(),
                 self.text_font.clone().into(),
             ),
+            Field::new(
+                "Text Shadow".into(),
+                "Allows you to optionally specify a color for text shadows.".into(),
+                self.text_shadow.into(),
+            ),
             Field::new(
                 "Background".into(),
                 "The background shown behind the entire layout.".into(),
@@ -189,18 +197,19 @@ impl GeneralSettings {
             1 => self.timer_font = value.into(),
             2 => self.times_font = value.into(),
             3 => self.text_font = value.into(),
-            4 => self.background = LayoutBackground::from(value).from_cache(image_cache),
-            5 => self.best_segment_color = value.into(),
-            6 => self.ahead_gaining_time_color = value.into(),
-            7 => self.ahead_losing_time_color = value.into(),
-            8 => self.behind_gaining_time_color = value.into(),
-            9 => self.behind_losing_time_color = value.into(),
-            10 => self.not_running_color = value.into(),
-            11 => self.personal_best_color = value.into(),
-            12 => self.paused_color = value.into(),
-            13 => self.thin_separators_color = value.into(),
-            14 => self.separators_color = value.into(),
-            15 => self.text_color = value.into(),
+            4 => self.text_shadow = value.into(),
+            5 => self.background = LayoutBackground::from(value).from_cache(image_cache),
+            6 => self.best_segment_color = value.into(),
+            7 => self.ahead_gaining_time_color = value.into(),
+            8 => self.ahead_losing_time_color = value.into(),
+            9 => self.behind_gaining_time_color = value.into(),
+            10 => self.behind_losing_time_color = value.into(),
+            11 => self.not_running_color = value.into(),
+            12 => self.personal_best_color = value.into(),
+            13 => self.paused_color = value.into(),
+            14 => self.thin_separators_color = value.into(),
+            15 => self.separators_color = value.into(),
+            16 => self.text_color = value.into(),
             _ => panic!("Unsupported Setting Index"),
         }
     }

src/layout/layout_state.rs

@@ -22,6 +22,8 @@ pub struct LayoutState {
     /// The font to use for regular text. `None` means a default font should be
     /// used.
     pub text_font: Option<Font>,
+    /// An optional text shadow color.
+    pub text_shadow: Option<Color>,
     /// The background to show behind the layout.
     pub background: LayoutBackground<ImageId>,
     /// The color of thin separators.

src/layout/mod.rs

@@ -119,6 +119,7 @@ impl Layout {
         state.separators_color = settings.separators_color;
         state.text_color = settings.text_color;
         state.direction = settings.direction;
+        state.text_shadow = settings.text_shadow;
     }
 
     /// Calculates the layout's state based on the timer provided. You can use

src/layout/parser/mod.rs

@@ -3,7 +3,7 @@
 use super::{Component, Layout, LayoutDirection};
 use crate::{
     component::{separator, timer::DeltaGradient},
-    platform::{math::f32::powf, prelude::*},
+    platform::{math::f32::stable_powf, prelude::*},
     settings::{
         Alignment, BackgroundImage, Color, Font, FontStretch, FontStyle, FontWeight, Gradient,
         Image, LayoutBackground, ListGradient,
@@ -321,8 +321,8 @@ where
         // black. Because of that, we use 1.75 as the exponent denominator for
         // the white on black case instead of the usual 2.2 for sRGB.
         let lightness = (r + g + b) * (1.0 / 3.0);
-        color.alpha =
-            (1.0 - lightness) * (1.0 - powf(1.0 - a, 1.0 / 2.2)) + lightness * powf(a, 1.0 / 1.75);
+        color.alpha = (1.0 - lightness) * (1.0 - stable_powf(1.0 - a, 1.0 / 2.2))
+            + lightness * stable_powf(a, 1.0 / 1.75);
 
         func(color);
         Ok(())
@@ -708,6 +708,8 @@ fn parse_general_settings(layout: &mut Layout, reader: &mut Reader<'_>) -> Resul
     let mut background_image = None;
     let mut image_opacity = 1.0;
     let mut image_blur = 0.0;
+    let mut has_text_shadow = false;
+    let mut text_shadow_color = Color::transparent();
 
     parse_children(reader, |reader, tag, _| match tag.name() {
         "TextColor" => color(reader, |color| {
@@ -779,9 +781,13 @@ fn parse_general_settings(layout: &mut Layout, reader: &mut Reader<'_>) -> Resul
         }),
         "ImageOpacity" => percentage(reader, |v| image_opacity = v),
         "ImageBlur" => percentage(reader, |v| image_blur = v),
+        "DropShadows" => parse_bool(reader, |b| has_text_shadow = b),
+        "ShadowsColor" => color(reader, |color| text_shadow_color = color),
         _ => end_tag(reader),
     })?;
 
+    settings.text_shadow = has_text_shadow.then_some(text_shadow_color);
+
     settings.background = match background_builder.build() {
         Some(gradient) => LayoutBackground::Gradient(gradient),
         None => match background_image {

src/platform/math.rs

@@ -1,20 +1,37 @@
-cfg_if::cfg_if! {
-    if #[cfg(all(feature = "std", not(test)))] {
-        pub mod f32 {
+pub mod f32 {
+    cfg_if::cfg_if! {
+        if #[cfg(all(feature = "std"))] {
             #[inline(always)]
             #[allow(clippy::missing_const_for_fn)] // Can't do this for the libm counterpart.
             pub fn abs(x: f32) -> f32 {
                 x.abs()
             }
+        } else {
+            pub use libm::fabsf as abs;
+        }
+    }
 
+    // FIXME: For our tests we need to ensure that the `powf` function behaves
+    // consistently across all platforms. Ideally we would only use it during
+    // testing, but cfg(test) apparently doesn't work for integration tests. We
+    // ensure consistent results by increasing the precision for the powf by
+    // using f64 internally.
+    #[inline(always)]
+    pub fn stable_powf(x: f32, y: f32) -> f32 {
+        super::f64::powf(x as f64, y as f64) as f32
+    }
+}
+
+mod f64 {
+    cfg_if::cfg_if! {
+        if #[cfg(all(feature = "std"))] {
             #[inline(always)]
-            pub fn powf(x: f32, y: f32) -> f32 {
+            #[allow(clippy::missing_const_for_fn)] // Can't do this for the libm counterpart.
+            pub fn powf(x: f64, y: f64) -> f64 {
                 x.powf(y)
             }
-        }
-    } else {
-        pub mod f32 {
-            pub use libm::{fabsf as abs, powf};
+        } else {
+            pub use libm::pow as powf;
         }
     }
 }

src/rendering/component/detailed_timer.rs

@@ -2,12 +2,13 @@ use crate::{
     component::detailed_timer::State,
     layout::LayoutState,
     rendering::{
+        RenderContext,
         component::timer,
-        consts::{vertical_padding, BOTH_PADDINGS, PADDING},
+        consts::{BOTH_PADDINGS, PADDING, vertical_padding},
         font::CachedLabel,
         resource::ResourceAllocator,
         scene::Layer,
-        solid, RenderContext,
+        solid,
     },
 };
 

src/rendering/component/key_value.rs

@@ -2,9 +2,9 @@ use crate::{
     component::key_value::State,
     layout::{LayoutDirection, LayoutState},
     rendering::{
+        RenderContext,
         font::{AbbreviatedLabel, CachedLabel},
         resource::ResourceAllocator,
-        RenderContext,
     },
 };
 
@@ -30,6 +30,7 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
     layout_state: &LayoutState,
 ) {
     context.render_background(dim, &component.background);
+
     context.render_key_value_component(
         &component.key,
         &component.key_abbreviations,

src/rendering/component/text.rs

@@ -2,10 +2,11 @@ use crate::{
     component::text::{State, TextState},
     layout::{LayoutDirection, LayoutState},
     rendering::{
+        RenderContext,
         consts::{DEFAULT_TEXT_SIZE, PADDING, TEXT_ALIGN_TOP},
         font::{AbbreviatedLabel, CachedLabel},
         resource::ResourceAllocator,
-        solid, RenderContext,
+        solid,
     },
 };
 
@@ -31,6 +32,7 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
     layout_state: &LayoutState,
 ) {
     context.render_background([width, height], &component.background);
+
     match &component.text {
         TextState::Center(text) => context.render_text_centered(
             text,