Significant speed-up when using FVTerm::copyArea with multipl overlapping and transparent layers

Author: gansm

.github/workflows/netbsd.yml

@@ -30,8 +30,8 @@ jobs:
           sudo -E pkgin clean
           sudo -E pkgin update
           # https://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/index-all.html
-          sudo -E pkgin -y install gcc13 automake autoconf autoconf-archive libtool pkgconf cppunit
-          export CXX=/usr/pkg/gcc13/bin/g++
+          sudo -E pkgin -y install gcc14 automake autoconf autoconf-archive libtool pkgconf cppunit
+          export CXX=/usr/pkg/gcc14/bin/g++
           $CXX --version
           autoreconf -v --install --force
           ./configure --prefix=/usr

ChangeLog

@@ -1,3 +1,8 @@
+2025-02-09  Markus Gans  <[email protected]>
+	* Significant speed-up when using FVTerm::copyArea with multiple 
+	  overlapping and transparent layers. This reduces the CPU load 
+	  of the process by ⅔.
+
 2024-12-24  Markus Gans  <[email protected]>
 	* Better FChar color value direct access
 

README.md

@@ -78,6 +78,9 @@ Explore the power of FINAL CUT with these examples:
 ![FProgressbar](doc/progress-bar.png)
 <br />*FProgressbar widget*<br /><br />
 
+![XPM Viewer](doc/xpmview.png)
+<br />*X PixMap (XPM) viewer example*<br /><br />
+
 ![FTextView](doc/textview.png)
 <br />*Scrollable text in an FTextView widget*<br /><br />
 

doc/xpmview.png

@@ -3,7 +3,7 @@
 *                                                                      *
 * This file is part of the FINAL CUT widget toolkit                    *
 *                                                                      *
-* Copyright 2023 Andreas Noe                                           *
+* Copyright 2023-2025 Andreas Noe                                      *
 *                                                                      *
 * FINAL CUT is free software; you can redistribute it and/or modify    *
 * it under the terms of the GNU Lesser General Public License as       *
@@ -42,6 +42,8 @@ struct Global
 struct termios Global::original_term_io_settings{};
 std::atomic<bool> Global::wait{true};
 
+// Function prototype
+void wait_5_seconds (const finalcut::BackendMonitor*);
 
 //----------------------------------------------------------------------
 static void onExit()

examples/eventloop.cpp

@@ -3,7 +3,7 @@
 *                                                                      *
 * This file is part of the FINAL CUT widget toolkit                    *
 *                                                                      *
-* Copyright 2021-2024 Markus Gans                                      *
+* Copyright 2021-2025 Markus Gans                                      *
 *                                                                      *
 * FINAL CUT is free software; you can redistribute it and/or modify    *
 * it under the terms of the GNU Lesser General Public License as       *
@@ -133,34 +133,6 @@ constexpr std::array<const char*, 97> saturn_xpm = \
   "                    "
 }};
 
-struct restoreOverlaid : public fc::FVTerm
-{
-  ~restoreOverlaid() override;
-
-  void operator () (fc::FVTerm& obj) const
-  {
-    const auto* win_list = getWindowList();
-
-    if ( ! win_list || win_list->empty() )
-      return;
-
-    auto obj_vwin = obj.getVWin();
-    bool overlaid{false};
-
-    for (const auto* window : *win_list)
-    {
-      const auto* win = static_cast<const fc::FWidget*>(window);
-      const auto* win_vwin = win->getVWin();
-
-      if ( overlaid && win_vwin && win_vwin->visible )
-        putArea (win->getTermPos(), win_vwin);
-      else if ( obj_vwin == win_vwin )
-        overlaid = true;
-    }
-  }
-};
-
-restoreOverlaid::~restoreOverlaid() = default;
 
 template <>
 struct std::hash<fc::FPoint>
@@ -206,7 +178,6 @@ void TextWindow::setPos (const fc::FPoint& pos, bool)
 {
   fc::FWindow::setPos (pos, false);
   putArea (getTermPos(), getVWin());
-  restoreOverlaid{}(*this);
 }
 
 //----------------------------------------------------------------------
@@ -272,7 +243,6 @@ void SpaceWindow::setPos (const fc::FPoint& pos, bool)
 {
   fc::FWindow::setPos (pos, false);
   putArea (getTermPos(), getVWin());
-  restoreOverlaid{}(*this);
 }
 
 //----------------------------------------------------------------------
@@ -323,26 +293,42 @@ void SpaceWindow::adjustSize()
 //----------------------------------------------------------------------
 // class PictureSpaceWindow
 //----------------------------------------------------------------------
-class PictureSpaceWindow final : public SpaceWindow
+class PictureSpaceWindow final : public fc::FWindow
 {
   public:
     // Constructor
-    explicit PictureSpaceWindow (fc::FColor, fc::FColor, fc::FWidget* = nullptr);
+    explicit PictureSpaceWindow (fc::FWidget* = nullptr);
+    void setPos (const fc::FPoint&, bool = true) override;
 
   private:
     // Method
     void draw() override;
+    void initLayout() override;
+    void adjustSize() override;
 };
 
 //----------------------------------------------------------------------
-PictureSpaceWindow::PictureSpaceWindow (fc::FColor fg, fc::FColor bg, fc::FWidget* parent)
-  : SpaceWindow{fg, bg, parent}
-{ }
+PictureSpaceWindow::PictureSpaceWindow (fc::FWidget* parent)
+  : fc::FWindow{parent}
+{
+  fc::FWidget::setForegroundColor (fc::FColor::White);
+  fc::FWidget::setBackgroundColor (fc::FColor::Black);
+}
+
+//----------------------------------------------------------------------
+void PictureSpaceWindow::setPos (const fc::FPoint& pos, bool)
+{
+  fc::FWindow::setPos (pos, false);
+  putArea (getTermPos(), getVWin());
+}
 
 //----------------------------------------------------------------------
 void PictureSpaceWindow::draw()
 {
-  SpaceWindow::draw();
+  setColor();
+  setTransparent();
+  clearArea();
+  unsetTransparent();
 
   if ( fc::FVTerm::getFOutput()->getMaxColor() < 16 )
     return;
@@ -362,6 +348,20 @@ void PictureSpaceWindow::draw()
   copyArea (getVWin(), fc::FPoint(10, 10), planet.get());
 }
 
+//----------------------------------------------------------------------
+void PictureSpaceWindow::initLayout()
+{
+  auto term_size = fc::FSize({getDesktopWidth(), getDesktopHeight()});
+  setSize(term_size, false);
+  fc::FWidget::initLayout();
+}
+
+//----------------------------------------------------------------------
+void PictureSpaceWindow::adjustSize()
+{
+  fc::FWindow::adjustSize();
+  initLayout();
+}
 
 //----------------------------------------------------------------------
 // class ParallaxScrolling
@@ -385,13 +385,14 @@ class ParallaxScrolling final : public fc::FWidget
     void onClose (fc::FCloseEvent*) override;
 
     // Data members
-    TextWindow          text_layer{fc::FColor::Yellow, fc::FColor::Black, this};
     SpaceWindow         layer1_lhs{fc::FColor::DarkGray, fc::FColor::Black, this};
     SpaceWindow         layer1_rhs{fc::FColor::DarkGray, fc::FColor::Black, this};
     SpaceWindow         layer2_lhs{fc::FColor::LightGray, fc::FColor::Black, this};
     SpaceWindow         layer2_rhs{fc::FColor::LightGray, fc::FColor::Black, this};
     SpaceWindow         layer3_lhs{fc::FColor::White, fc::FColor::Black, this};
-    PictureSpaceWindow  layer3_rhs{fc::FColor::White, fc::FColor::Black, this};
+    SpaceWindow         layer3_rhs{fc::FColor::White, fc::FColor::Black, this};
+    PictureSpaceWindow  picture{this};
+    TextWindow          text_layer{fc::FColor::Yellow, fc::FColor::Black, this};
     int                 timer1{-1};
     int                 timer2{-1};
     int                 timer3{-1};
@@ -427,6 +428,7 @@ void ParallaxScrolling::initLayout()
   setGeometry({1, 1}, term_size, false);
   auto lhs_pos = fc::FPoint{1, 1};
   auto rhs_pos = fc::FPoint{int(getDesktopWidth() + 1), 1};
+  picture.setPos(rhs_pos, false);
   layer1_lhs.setPos(lhs_pos, false);
   layer2_lhs.setPos(lhs_pos, false);
   layer3_lhs.setPos(lhs_pos, false);
@@ -478,6 +480,7 @@ void ParallaxScrolling::onTimer (fc::FTimerEvent* ev)
   else if ( timer3 == timer_id )
   {
     scrollLeft (layer3_lhs, layer3_rhs);
+    picture.setPos (layer3_rhs.getPos());
   }
 
   forceTerminalUpdate();