add AnimationDriver support

Author: rectalogic

.github/workflows/ci.yml

@@ -114,9 +114,5 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: clang-format
-        uses: jidicula/[email protected]
-        with:
-          clang-format-version: "17"
-      - name: clang-tidy/clazy
+      - name: lint
         run: builders/Linux/docker-run.sh /renderwindow/builders/Linux/lint.sh

builders/Linux/Dockerfile

@@ -86,7 +86,7 @@ RUN <<EOF
     apt-get -y update && apt-get -y install \
         bash \
         build-essential \
-        clang-format \
+        clang-format-17 \
         clang-tidy \
         clazy \
         ffmpeg \

builders/Linux/lint.sh

@@ -14,6 +14,9 @@ cd /renderwindow
 git config --global --add safe.directory /renderwindow
 FILES=$(git ls-files '**/*.cpp' '**/*.h')
 
+echo clang-format
+/usr/bin/clang-format-17 --dry-run --Werror $FILES || exit 1
+
 echo clang-tidy
 CLANGTIDY=$(/usr/bin/clang-tidy --quiet -p "${RENDERWINDOW_BUILD}" $FILES 2>&1 || exit 1)
 # Manually suppress bogus error https://github.com/llvm/llvm-project/issues/58820

com/rectalogic/RenderWindow/CMakeLists.txt

@@ -10,7 +10,3 @@ qt_add_qml_module(renderwindow
 )
 
 target_link_libraries(renderwindow PUBLIC Qt6::Core Qt6::Gui Qt6::GuiPrivate Qt6::Qml Qt6::Quick)
-
-set_target_properties(renderwindow PROPERTIES
-    COMPONENT "${CMAKE_INSTALL_DEFAULT_COMPONENT_NAME}"
-)

com/rectalogic/RenderWindow/animation.h

@@ -0,0 +1,35 @@
+// Copyright (C) 2025 Andrew Wason
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#pragma once
+
+#include <QAnimationDriver>
+
+const qint32 FRAMERATE_MILLIS = 40;
+
+class AnimationDriver : public QAnimationDriver {
+public:
+    AnimationDriver(QObject* parent = nullptr)
+        : QAnimationDriver(parent)
+    {
+    }
+
+    void setElapsed(qint64 elapsedMillis)
+    {
+        m_elapsed = elapsedMillis;
+    }
+
+    void advance() override
+    {
+        advanceAnimation();
+    }
+
+    qint64 elapsed() const override
+    {
+        return m_elapsed;
+    }
+
+private:
+    qint32 m_increment = 0;
+    qint64 m_elapsed = 0;
+};

com/rectalogic/RenderWindow/render_control.h

@@ -13,7 +13,7 @@ class RenderControl : public QQuickRenderControl {
     Q_OBJECT
 public:
     RenderControl(QObject* parent = nullptr)
-        : QQuickRenderControl(parent) { };
+        : QQuickRenderControl(parent) {};
     RenderControl(RenderControl&&) = delete;
     RenderControl& operator=(RenderControl&&) = delete;
     ~RenderControl() override = default;

com/rectalogic/RenderWindow/render_window.cpp

@@ -1,6 +1,7 @@
 // Copyright (C) 2025 Andrew Wason
 // SPDX-License-Identifier: GPL-3.0-or-later
 #include "render_window.h"
+#include "animation.h"
 #include "render_control.h"
 #include <QByteArray>
 #include <QDebug>
@@ -17,12 +18,14 @@
 RenderWindow::RenderWindow(RenderControl* renderControl)
     : QQuickWindow(renderControl)
     , m_renderControl(renderControl)
+    , m_animationDriver(new AnimationDriver())
 {
 }
 
 RenderWindow::RenderWindow()
     : RenderWindow(new RenderControl())
 {
+    m_animationDriver->install();
 #ifdef RENDERWINDOW_ENABLE_VULKAN
     if (rendererInterface()->graphicsApi() == QSGRendererInterface::Vulkan) {
         m_vulkanInstance.setExtensions(QQuickGraphicsConfiguration::preferredInstanceExtensions());
@@ -51,12 +54,16 @@ void RenderWindow::componentComplete()
     contentItem()->setSize(size());
 }
 
-QByteArray RenderWindow::render()
+QByteArray RenderWindow::render(qint64 elapsedMillis)
 {
     if (!m_isValid) {
         emit qmlEngine(this)->exit(1);
         return QByteArray();
     }
+
+    m_animationDriver->setElapsed(elapsedMillis);
+    m_animationDriver->advance();
+
     QByteArray data = m_renderControl->renderFrame();
     if (data.isNull()) {
         emit qmlEngine(this)->exit(1);

com/rectalogic/RenderWindow/render_window.h

@@ -10,6 +10,7 @@
 #include <QtQmlIntegration>
 #include <memory>
 #include <qtgui-config.h>
+class AnimationDriver;
 class RenderControl;
 #if (QT_CONFIG(vulkan) && __has_include(<vulkan/vulkan.h>))
 #define RENDERWINDOW_ENABLE_VULKAN
@@ -32,7 +33,7 @@ class RenderWindow : public QQuickWindow, public QQmlParserStatus {
     RenderWindow& operator=(RenderWindow&&) = delete;
     ~RenderWindow() override;
 
-    Q_INVOKABLE QByteArray render();
+    Q_INVOKABLE QByteArray render(qint64 elapsedMillis);
 
 protected:
     void classBegin() override { }
@@ -47,5 +48,6 @@ class RenderWindow : public QQuickWindow, public QQmlParserStatus {
     QVulkanInstance m_vulkanInstance;
 #endif
     std::unique_ptr<RenderControl> m_renderControl;
+    std::unique_ptr<AnimationDriver> m_animationDriver;
     bool m_isValid = false;
 };