feat(display): flashing rendered rects (#180) (#190)

Signed-off-by: Vasilyy Balyasnyy <v.balyasnyy@gmail.com>

Author: vbalyasnyy

src/display.c

@@ -29,12 +29,13 @@
 
 #include "config.h"
 
-#include <time.h>
-#include <stdio.h>
-#include <stdlib.h>
 #ifdef USE_OPENMP
 #include <omp.h>
 #endif
+#include <time.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
 #include <LCUI_Build.h>
 #include <LCUI/LCUI.h>
 #include <LCUI/input.h>
@@ -62,13 +63,23 @@
 #define PARALLEL_RENDERING_THREADS 1
 #endif
 
+#define FLASH_DURATION	1000.0
+
+typedef struct FlashRectRec_ {
+	int64_t paint_time;
+	LCUI_Rect rect;
+} FlashRectRec, *FlashRect;
+
 typedef struct SurfaceRecordRec_ {
-	/**< whether new content has been rendered */
+	/** whether new content has been rendered */
 	LCUI_BOOL rendered;
 
 	/** dirty rectangles for rendering */
 	LinkedList rects;
 
+	/** flashing rect list */
+	LinkedList flash_rects;
+
 	LCUI_Surface surface;
 	LCUI_Widget widget;
 } SurfaceRecordRec, *SurfaceRecord;
@@ -88,29 +99,102 @@ static struct LCUI_DisplayModule {
 #define LCUIDisplay_CleanSurfaces() \
 	LinkedList_Clear(&display.surfaces, OnDestroySurfaceRecord)
 
+INLINE int is_rect_equals(const LCUI_Rect *a, const LCUI_Rect *b)
+{
+	return a->x == b->x && a->y == b->y && a->width == b->width &&
+	       a->height == b->height;
+}
+
 static void OnDestroySurfaceRecord(void *data)
 {
 	SurfaceRecord record = data;
+
 	Surface_Close(record->surface);
 	LinkedList_Clear(&record->rects, free);
+	LinkedList_Clear(&record->flash_rects, free);
 	free(record);
 }
 
-static void DrawBorder(LCUI_PaintContext paint)
+static void DrawBorder(LCUI_Graph *mask)
 {
 	LCUI_Pos pos;
 	LCUI_Color color;
-	int end_x = paint->rect.width - 1;
-	int end_y = paint->rect.height - 1;
+	int end_x = mask->width - 1;
+	int end_y = mask->height - 1;
 	pos.x = pos.y = 0;
-	color = RGB(255, 0, 0);
-	Graph_DrawHorizLine(&paint->canvas, color, 1, pos, end_x);
-	Graph_DrawVertiLine(&paint->canvas, color, 1, pos, end_y);
-	pos.x = paint->rect.width - 1;
-	Graph_DrawVertiLine(&paint->canvas, color, 1, pos, end_y);
+	color = RGB(124, 179, 5);
+	Graph_DrawHorizLine(mask, color, 1, pos, end_x);
+	Graph_DrawVertiLine(mask, color, 1, pos, end_y);
+	pos.x = mask->width - 1;
+	Graph_DrawVertiLine(mask, color, 1, pos, end_y);
 	pos.x = 0;
-	pos.y = paint->rect.height - 1;
-	Graph_DrawHorizLine(&paint->canvas, color, 1, pos, end_x);
+	pos.y = mask->height - 1;
+	Graph_DrawHorizLine(mask, color, 1, pos, end_x);
+}
+
+static size_t LCUIDisplay_UpdateFlashRects(SurfaceRecord record)
+{
+	int64_t period;
+	size_t count = 0;
+	LCUI_Graph mask;
+	LCUI_PaintContext paint;
+	FlashRect flash_rect;
+	LinkedListNode *node, *prev;
+
+	for (LinkedList_Each(node, &record->flash_rects)) {
+		flash_rect = node->data;
+		if (flash_rect->paint_time == 0) {
+			prev = node->prev;
+			free(node->data);
+			LinkedList_DeleteNode(&record->flash_rects, node);
+			node = prev;
+			continue;
+		}
+		period = LCUI_GetTimeDelta(flash_rect->paint_time);
+		if (period >= FLASH_DURATION) {
+			flash_rect->paint_time = 0;
+		} else {
+			Graph_Init(&mask);
+			mask.color_type = LCUI_COLOR_TYPE_ARGB;
+			Graph_Create(&mask, flash_rect->rect.width,
+				     flash_rect->rect.height);
+			Graph_FillRect(&mask, ARGB(125, 124, 179, 5), NULL, TRUE);
+			mask.opacity =
+			    0.6 * (FLASH_DURATION - (float)period) / FLASH_DURATION;
+		}
+		paint = Surface_BeginPaint(record->surface, &flash_rect->rect);
+		if (!paint) {
+			continue;
+		}
+		count += Widget_Render(record->widget, paint);
+		if (flash_rect->paint_time != 0) {
+			DrawBorder(&mask);
+			Graph_Mix(&paint->canvas, &mask, 0, 0, TRUE);
+			Graph_Free(&mask);
+		}
+		Surface_EndPaint(record->surface, paint);
+		record->rendered = TRUE;
+	}
+	return count;
+}
+
+static void LCUIDisplay_AppendFlashRects(SurfaceRecord record, LCUI_Rect *rect)
+{
+	LinkedListNode *node;
+	FlashRect flash_rect;
+
+	for (LinkedList_Each(node, &record->flash_rects)) {
+		flash_rect = node->data;
+		if (is_rect_equals(&flash_rect->rect, rect)) {
+			flash_rect->paint_time = LCUI_GetTime();
+			return;
+		}
+	}
+
+	flash_rect = NEW(FlashRectRec, 1);
+	flash_rect->rect = *rect;
+	flash_rect->paint_time = LCUI_GetTime();
+	LinkedList_Append(&record->flash_rects, flash_rect);
 }
 
 static void SurfaceRecord_DumpRects(SurfaceRecord record, LinkedList *rects)
@@ -227,13 +311,8 @@ static size_t LCUIDisplay_RenderSurface(SurfaceRecord record)
 		DEBUG_MSG("rect: (%d,%d,%d,%d)\n", paint->rect.x, paint->rect.y,
 			  paint->rect.width, paint->rect.height);
 		count += Widget_Render(record->widget, paint);
-		/**
-		 * FIXME: Improve highlighting of repainted areas
-		 * Let the highlighted areas disappear after a short
-		 * period of time, just like flashing
-		 */
 		if (display.show_rect_border) {
-			DrawBorder(paint);
+			LCUIDisplay_AppendFlashRects(record, &paint->rect);
 		}
 		if (display.mode != LCUI_DMODE_SEAMLESS) {
 			LCUICursor_Paint(paint);
@@ -242,6 +321,7 @@ static size_t LCUIDisplay_RenderSurface(SurfaceRecord record)
 	}
 	RectList_Clear(&rects);
 	record->rendered = count > 0;
+	count += LCUIDisplay_UpdateFlashRects(record);
 	return count;
 }
 
@@ -260,7 +340,6 @@ void LCUIDisplay_Update(void)
 		if (record->widget && surface && Surface_IsReady(surface)) {
 			Surface_Update(surface);
 		}
-		/* 收集无效区域记录 */
 		Widget_GetInvalidArea(record->widget, &record->rects);
 	}
 	if (display.mode == LCUI_DMODE_SEAMLESS || !record) {
@@ -387,6 +466,7 @@ static void LCUIDisplay_BindSurface(LCUI_Widget widget)
 	record->surface = Surface_New();
 	record->widget = widget;
 	record->rendered = FALSE;
+	LinkedList_Init(&record->flash_rects);
 	LCUIMetrics_ComputeRectActual(&rect, &widget->box.canvas);
 	if (Widget_CheckStyleValid(widget, key_top) &&
 	    Widget_CheckStyleValid(widget, key_left)) {