Final cleanup

The text shadow support should now mostly be ready.

Author: CryZe

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,12 +22,10 @@ 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 drawn shadows.
-    pub shadow_color: Option<Color>,
-    /// Draw drop shadow
-    pub drop_shadow: bool,
     /// The color to use for when the runner achieved a best segment.
     pub best_segment_color: Color,
     /// The color to use for when the runner is ahead of the comparison and is
@@ -63,11 +61,10 @@ 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,
             ))),
-            shadow_color: Some(Color::hsla(0.0, 0.0, 0.0, 0.5)),
-            drop_shadow: false,
             best_segment_color: Color::hsla(50.0, 1.0, 0.5, 1.0),
             ahead_gaining_time_color: Color::hsla(136.0, 1.0, 0.4, 1.0),
             ahead_losing_time_color: Color::hsla(136.0, 0.55, 0.6, 1.0),
@@ -116,14 +113,9 @@ impl GeneralSettings {
                 self.text_font.clone().into(),
             ),
             Field::new(
-                "Drop Shadow".into(),
-                "Draws shadow behind timer & splits".into(),
-                self.drop_shadow.into(),
-            ),
-            Field::new(
-                "Shadow".into(),
-                "The color to use for drawn shadows.".into(),
-                self.shadow_color.into(),
+                "Text Shadow".into(),
+                "Allows you to optionally specify a color for text shadows.".into(),
+                self.text_shadow.into(),
             ),
             Field::new(
                 "Background".into(),
@@ -205,20 +197,19 @@ impl GeneralSettings {
             1 => self.timer_font = value.into(),
             2 => self.times_font = value.into(),
             3 => self.text_font = value.into(),
-            4 => self.drop_shadow = value.into(),
-            5 => self.shadow_color = value.into(),
-            6 => self.background = LayoutBackground::from(value).from_cache(image_cache),
-            7 => self.best_segment_color = value.into(),
-            8 => self.ahead_gaining_time_color = value.into(),
-            9 => self.ahead_losing_time_color = value.into(),
-            10 => self.behind_gaining_time_color = value.into(),
-            11 => self.behind_losing_time_color = value.into(),
-            12 => self.not_running_color = value.into(),
-            13 => self.personal_best_color = value.into(),
-            14 => self.paused_color = value.into(),
-            15 => self.thin_separators_color = value.into(),
-            16 => self.separators_color = value.into(),
-            17 => 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.
@@ -30,10 +32,6 @@ pub struct LayoutState {
     pub separators_color: Color,
     /// The text color to use for text that doesn't specify its own color.
     pub text_color: Color,
-    /// Draws drop shadow
-    pub drop_shadow: bool,
-    /// The color to use for drawn shadows.
-    pub shadow_color: Option<Color>,
 }
 
 #[cfg(feature = "std")]

src/layout/mod.rs

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

src/layout/parser/mod.rs

@@ -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,13 +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| settings.drop_shadow = b),
-        "ShadowsColor" => color(reader, |color| {
-            settings.shadow_color = Some(color);
-        }),
+        "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/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,
     },
 };
 
@@ -43,9 +44,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
     layout_state: &LayoutState,
 ) {
     context.render_background([width, height], &component.background);
-    
-    let shadow_offset = [0.05, 0.05];
-    let shadow_color = solid(&layout_state.shadow_color.unwrap_or_default());
 
     let vertical_padding = vertical_padding(height);
     let icon_size = height - 2.0 * vertical_padding;
@@ -81,8 +79,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
             [left_side, 0.6 * top_height],
             0.5 * top_height,
             segment_name_color,
-            shadow_offset,
-            shadow_color,
             timer_end,
         );
     }
@@ -117,8 +113,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
                 [left_side, comparison2_y],
                 comparison_text_scale,
                 comparison_names_color,
-                shadow_offset,
-                shadow_color,
                 segment_timer_end,
             )
             .max(name_end);
@@ -144,8 +138,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
                 [left_side, comparison1_y],
                 comparison_text_scale,
                 comparison_names_color,
-                shadow_offset,
-                shadow_color,
                 segment_timer_end,
             )
             .max(name_end);
@@ -174,8 +166,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
             [time_x, comparison2_y],
             comparison_text_scale,
             comparison_times_color,
-            shadow_offset,
-            shadow_color,
         );
     }
     if let Some(comparison) = &component.comparison1 {
@@ -186,8 +176,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
             [time_x, comparison1_y],
             comparison_text_scale,
             comparison_times_color,
-            shadow_offset,
-            shadow_color,
         );
     }
 }

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,
     },
 };
 
@@ -31,8 +31,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
 ) {
     context.render_background(dim, &component.background);
 
-    let shadow_offset = [0.05, 0.05];
-    let shadow_color = layout_state.shadow_color;
     context.render_key_value_component(
         &component.key,
         &component.key_abbreviations,
@@ -41,9 +39,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
         &mut cache.value,
         component.updates_frequently,
         dim,
-        shadow_offset,
-        shadow_color.unwrap_or_default(),
-        shadow_color.unwrap_or_default(),
         component.key_color.unwrap_or(layout_state.text_color),
         component.value_color.unwrap_or(layout_state.text_color),
         component.display_two_rows || layout_state.direction == LayoutDirection::Horizontal,

src/rendering/component/splits.rs

@@ -185,8 +185,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
     let transform = context.transform;
     let text_color = solid(&layout_state.text_color);
 
-    let shadow_offset = [0.05, 0.05];
-    let shadow_color = solid(&layout_state.shadow_color.unwrap_or_default());
     if let Some(column_labels) = &component.column_labels {
         if layout_state.direction == LayoutDirection::Vertical {
             cache
@@ -206,8 +204,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
                     [right_x, TEXT_ALIGN_TOP],
                     DEFAULT_TEXT_SIZE,
                     text_color,
-                    shadow_offset,
-                    shadow_color,
                 );
                 let label_width = right_x - left_x;
                 if label_width > *max_width {
@@ -281,8 +277,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
                         [right_x, split_height + TEXT_ALIGN_BOTTOM],
                         DEFAULT_TEXT_SIZE,
                         solid(&column.visual_color),
-                        shadow_offset,
-                        shadow_color,
                     );
                 }
                 right_x -= max_width + PADDING;
@@ -298,8 +292,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
                 [icon_right, TEXT_ALIGN_TOP],
                 DEFAULT_TEXT_SIZE,
                 text_color,
-                shadow_offset,
-                shadow_color,
                 left_x - PADDING,
             );
         }

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,8 +32,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
     layout_state: &LayoutState,
 ) {
     context.render_background([width, height], &component.background);
-    let shadow_offset = [0.05, 0.05];
-    let shadow_color = layout_state.shadow_color;
 
     match &component.text {
         TextState::Center(text) => context.render_text_centered(
@@ -47,8 +46,6 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
                     .left_center_color
                     .unwrap_or(layout_state.text_color),
             ),
-            shadow_offset,
-            solid(&shadow_color.unwrap_or_default()),
         ),
         TextState::Split(left, right) => context.render_key_value_component(
             left,
@@ -58,10 +55,9 @@ pub(in crate::rendering) fn render<A: ResourceAllocator>(
             &mut cache.label2,
             false,
             [width, height],
-            shadow_offset,
-            shadow_color.unwrap_or_default(),
-            shadow_color.unwrap_or_default(),
-            component.left_center_color.unwrap_or(layout_state.text_color),
+            component
+                .left_center_color
+                .unwrap_or(layout_state.text_color),
             component.right_color.unwrap_or(layout_state.text_color),
             component.display_two_rows || layout_state.direction == LayoutDirection::Horizontal,
         ),