Merge remote-tracking branch 'origin/master' into wip/rename

 Conflicts:
	api/cpp/cbindgen.rs
	api/cpp/include/slint.h
	examples/CMakeLists.txt
	examples/imagefilter/Cargo.toml
	examples/plotter/main.rs
	internal/backends/mcu/lib.rs

Author: tronical

.github/workflows/nightly_snapshot.yaml

@@ -286,7 +286,7 @@ jobs:
             rm -rf snapshots/$target_branch/demos
             mkdir -p snapshots/$target_branch/demos
 
-            for demo_subdir in gallery, printerdemo,rust printerdemo_old,rust todo,rust slide_puzzle, memory, imagefilter, plotter,; do
+            for demo_subdir in gallery, printerdemo,rust printerdemo_old,rust todo,rust slide_puzzle, memory, imagefilter, plotter, opengl_underlay,; do
                 IFS=',' read demo subdir <<< "${demo_subdir}"
 
                 mkdir -p snapshots/$target_branch/demos/$demo

.github/workflows/wasm_demos.yaml

@@ -64,6 +64,11 @@ jobs:
         sed -i "s/#wasm# //" Cargo.toml
         wasm-pack build --release --target web
       working-directory: examples/plotter
+    - name: OpenGL underlay example WASM build
+      run: |
+        sed -i "s/#wasm# //" Cargo.toml
+        wasm-pack build --release --target web
+      working-directory: examples/opengl_underlay
     - name: "Upload Demo Artifacts"
       uses: actions/upload-artifact@v2
       with:
@@ -77,6 +82,7 @@ jobs:
               examples/slide_puzzle/
               examples/imagefilter/
               examples/plotter/
+              examples/opengl_underlay/
     - name: Clean cache # Otherwise the cache is much too big
       run: |
           du -hs target

CHANGELOG.md

@@ -28,6 +28,8 @@ as well as the [Rust migration guide for the `sixtyfps` crate](api/rs/slint/migr
 ### Added
 
  - `TextEdit::font-size` and `LineEdit::font-size` have been added to control the size of these widgets.
+ - Added `sixtyfps::Window::set_rendering_notifier` to get a callback before and after a new frame is being rendered.
+ - Added `sixtyfps::Window::request_redraw()` to schedule redrawing of the window contents.
 
 ### Fixed
 

Cargo.toml

@@ -14,6 +14,7 @@ members = [
     'examples/gallery',
     'examples/imagefilter',
     'examples/memory',
+    'examples/opengl_underlay',
     'examples/plotter',
     'examples/printerdemo_old/rust',
     'examples/printerdemo/rust',

api/cpp/cbindgen.rs

@@ -128,6 +128,9 @@ fn gen_corelib(
     .map(|x| x.to_string())
     .collect();
 
+    let mut private_exported_types: std::collections::HashSet<String> =
+        config.export.include.iter().cloned().collect();
+
     config.export.exclude = [
         "SharedString",
         "SharedVector",
@@ -157,8 +160,10 @@ fn gen_corelib(
         "slint_color_darker",
         "slint_image_size",
         "slint_image_path",
-        "TimerMode", // included in generated_public.h
-        "IntSize",   // included in generated_public.h
+        "TimerMode",                 // included in generated_public.h
+        "IntSize",                   // included in generated_public.h
+        "RenderingState",            // included in generated_public.h
+        "SetRenderingNotifierError", // included in generated_public.h
     ]
     .iter()
     .map(|x| x.to_string())
@@ -201,6 +206,7 @@ fn gen_corelib(
         .insert("StateInfo".to_owned(), "    using Instant = uint64_t;".into());
     properties_config.structure.derive_eq = true;
     properties_config.structure.derive_neq = true;
+    private_exported_types.extend(properties_config.export.include.iter().cloned());
     cbindgen::Builder::new()
         .with_config(properties_config)
         .with_src(crate_dir.join("properties.rs"))
@@ -252,6 +258,8 @@ fn gen_corelib(
             "slint_windowrc_set_focus_item",
             "slint_windowrc_set_component",
             "slint_windowrc_show_popup",
+            "slint_windowrc_set_rendering_notifier",
+            "slint_windowrc_request_redraw",
             "slint_new_path_elements",
             "slint_new_path_events",
             "slint_color_brighter",
@@ -280,6 +288,9 @@ fn gen_corelib(
         // Property<> fields uses the public `slint::Blah` type
         special_config.namespaces =
             Some(vec!["slint".into(), "cbindgen_private".into(), "types".into()]);
+
+        private_exported_types.extend(special_config.export.include.iter().cloned());
+
         cbindgen::Builder::new()
             .with_config(special_config)
             .with_src(crate_dir.join("graphics.rs"))
@@ -300,8 +311,15 @@ fn gen_corelib(
     let mut public_config = config.clone();
     public_config.namespaces = Some(vec!["slint".into()]);
     public_config.export.item_types = vec![cbindgen::ItemType::Enums, cbindgen::ItemType::Structs];
-    public_config.export.include = vec!["TimerMode".into(), "IntSize".into()];
-    public_config.export.exclude.clear();
+    // Previously included types are now excluded (to avoid duplicates)
+    public_config.export.exclude = private_exported_types.into_iter().collect();
+    public_config.export.exclude.push("Point".into());
+    public_config.export.include = vec![
+        "TimerMode".into(),
+        "IntSize".into(),
+        "RenderingState".into(),
+        "SetRenderingNotifierError".into(),
+    ];
 
     public_config.export.body.insert(
         "IntSize".to_owned(),
@@ -315,6 +333,8 @@ fn gen_corelib(
         .with_config(public_config)
         .with_src(crate_dir.join("timers.rs"))
         .with_src(crate_dir.join("graphics.rs"))
+        .with_src(crate_dir.join("window.rs"))
+        .with_src(crate_dir.join("api.rs"))
         .with_after_include(format!(
             r"
 /// This macro expands to the to the numeric value of the major version of Slint you're

api/cpp/include/slint.h

@@ -141,6 +141,25 @@ class WindowRc
         cbindgen_private::slint_windowrc_show_popup(&inner, &popup, p, &parent_item);
     }
 
+    template<typename F>
+    std::optional<SetRenderingNotifierError> set_rendering_notifier(F callback) const
+    {
+        auto actual_cb = [](RenderingState state, void *data) {
+            (*reinterpret_cast<F *>(data))(state);
+        };
+        SetRenderingNotifierError err;
+        if (cbindgen_private::sixtyfps_windowrc_set_rendering_notifier(
+                    &inner, actual_cb,
+                    [](void *user_data) { delete reinterpret_cast<F *>(user_data); },
+                    new F(std::move(callback)), &err)) {
+            return {};
+        } else {
+            return err;
+        }
+    }
+
+    void request_redraw() const { cbindgen_private::sixtyfps_windowrc_request_redraw(&inner); }
+
 private:
     cbindgen_private::WindowRcOpaque inner;
 };
@@ -314,6 +333,19 @@ class Window
     /// De-registers the window from the windowing system, therefore hiding it.
     void hide() { inner.hide(); }
 
+    /// This function allows registering a callback that's invoked during the different phases of
+    /// rendering. This allows custom rendering on top or below of the scene.
+    /// On success, the function returns a std::optional without value. On error, the function
+    /// returns the error code as value in the std::optional.
+    template<typename F>
+    std::optional<SetRenderingNotifierError> set_rendering_notifier(F &&callback) const
+    {
+        return inner.set_rendering_notifier(std::forward<F>(callback));
+    }
+
+    /// This function issues a request to the windowing system to redraw the contents of the window.
+    void request_redraw() const { inner.request_redraw(); }
+
     /// \private
     private_api::WindowRc &window_handle() { return inner; }
     /// \private

cmake/FindOpenGLES2.cmake

@@ -0,0 +1,52 @@
+# Copyright © SixtyFPS GmbH <[email protected]>
+# SPDX-License-Identifier: (GPL-3.0-only OR LicenseRef-SixtyFPS-commercial)
+
+include(CheckCXXSourceCompiles)
+
+find_path(OPENGLES2_INCLUDE_DIR NAMES "GLES2/gl2.h" "OpenGLES/ES2/gl.h" DOC "The path where the OpenGL ES 2.0 headers are located")
+find_library(OPENGLES2_LIBRARY NAMES GLESv2 OpenGLES)
+
+# Sometimes EGL linkage is required, so look it up and always use if available.
+find_package(OpenGL COMPONENTS EGL)
+
+# See if we can compile some example code with what we've found.
+set(saved_libraries "${CMAKE_REQUIRED_LIBRARIES}")
+set(saved_includes "${CMAKE_REQUIRED_INCLUDES}")
+
+if (OPENGLES2_LIBRARY)
+    list(APPEND CMAKE_REQUIRED_INCLUDES "${OPENGLES2_INCLUDE_DIR}")
+    list(APPEND CMAKE_REQUIRED_LIBRARIES "${OPENGLES2_LIBRARY}")
+endif()
+
+if(OPENGL_egl_LIBRARY)
+    list(APPEND CMAKE_REQUIRED_INCLUDES "${OPENGL_EGL_INCLUDE_DIRS}")
+    list(APPEND CMAKE_REQUIRED_LIBRARIES "${OPENGL_egl_LIBRARY}")
+endif()
+
+check_cxx_source_compiles("
+#include <GLES2/gl2.h>
+#include <GLES2/gl2platform.h>
+
+int main(int argc, char *argv[]) {
+    glClear(GL_STENCIL_BUFFER_BIT);
+    glUseProgram(0);
+}" HAVE_OPENGLES2)
+
+set(CMAKE_REQUIRED_INCLUDES "${saved_includes}")
+set(CMAKE_REQUIRED_LIBRARIES "${saved_libraries}")
+
+# Standard CMake package dance
+set(package_args OPENGLES2_INCLUDE_DIR OPENGLES2_LIBRARY HAVE_OPENGLES2)
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(OpenGLES2 DEFAULT_MSG ${package_args})
+mark_as_advanced(${package_args})
+
+# Create a convenience target for linkage
+if (OPENGLES2_FOUND AND NOT TARGET OpenGLES2::OpenGLES2)
+    add_library(OpenGLES2::OpenGLES2 UNKNOWN IMPORTED)
+    set_property(TARGET OpenGLES2::OpenGLES2 PROPERTY INTERFACE_INCLUDE_DIRECTORIES "${OPENGLES2_INCLUDE_DIR}")
+    set_property(TARGET OpenGLES2::OpenGLES2 PROPERTY IMPORTED_LOCATION "${OPENGLES2_LIBRARY}")
+    if (TARGET OpenGL::EGL)
+        target_link_libraries(OpenGLES2::OpenGLES2 INTERFACE OpenGL::EGL)
+    endif()
+endif()

docs/langref.md

@@ -678,7 +678,8 @@ Animation can be configured with the following parameter:
 
 * `delay`: the amount of time to wait before starting the animation
 * `duration`: the amount of time it takes for the animation to complete
-* `loop-count`: FIXME
+* `iteration-count`: The number of times a animation should run. A negative value specifies
+    infinite reruns. Fractual values are possible.
 * `easing`: can be `linear`, `ease`, `ease-in`, `ease-out`, `ease-in-out`, `cubic-bezier(a, b, c, d)` as in CSS
 
 It is also possible to animate several properties with the same animation:

examples/CMakeLists.txt

@@ -3,8 +3,12 @@
 cmake_minimum_required(VERSION 3.19)
 project(SlintExamples LANGUAGES CXX)
 
+list(PREPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake")
+
+find_package(OpenGLES2 QUIET)
+
 if (NOT TARGET Slint::Slint)
-    find_package(Slint REQUIRED)
+    find_package(SixtyFPS REQUIRED)
     include(FetchContent)
 endif()
 
@@ -22,3 +26,6 @@ endif()
 if (SLINT_FEATURE_INTERPRETER)
     add_subdirectory(iot-dashboard/)
 endif()
+if (OpenGLES2_FOUND AND SIXTYFPS_FEATURE_BACKEND_GL)
+    add_subdirectory(opengl_underlay)
+endif()

examples/README.md

@@ -91,6 +91,16 @@ graph and integrate the result into Slint.
 
 Some examples of how to use the `slint-viewer` to add a GUI to shell scripts.
 
+### [`opengl_underlay`](./opengl_underlay)
+
+A Rust and C++ example that shows how render SixtyFPS on top of graphical effect rendered using custom OpenGL code. For more details check out the [Readme](./opengl_underlay).
+
+| `.60` Design | Rust Source | C++ Source | Online wasm Preview |
+| --- | --- | --- | --- |
+| [`scene.60`](./opengl_underlay/scene.60) | [`main.rs`](./opengl_underlay/main.rs) | [`main.cpp`](./opengl_underlay/main.cpp) | [Online simulation](https://sixtyfps.io/snapshots/master/demos/opengl_underlay/) |
+
+![Screenshot of the OpenGL Underlay Example on Windows](https://sixtyfps.io/resources/opengl_underlay_screenshot.png "OpenGL Underlay")
+
 ### External examples
 
 * [Cargo UI](https://github.com/sixtyfpsui/cargo-ui): A rust application that makes use of threads in the background.