RiveQtQuickPlugin

RiveQtQuickPlugin is a Qt/QtQuick renderer that enables the integration of Rive animations in QtQuick / QML. For more information on Rive, visit https://www.rive.app.

The QML API Documentation can be found here: https://basyskom.github.io/RiveQtQuickPlugin/index.html

This plugin allows you to display Rive animations, interact with them, and bind data to and from the animations in your Qt Quick applications.

RiveQtQuickSimpleViewer2.mp4

State of Implementation

Platform	OpenGL	Direct3D	Vulkan	Metal	SoftwareRendering
Qt5.15.2 Windows	-	-	-	-	✅(no texture meshes)
Qt5.15.2 Linux	-	-	-	-	✅(no texture meshes)
Qt5.15.2 macOS	-	-	-	-	✅(no texture meshes)
Qt6.5+ Windows	✅	✅	✅	-	✅(no texture meshes)
Qt6.5+ Linux	✅	-	✅	-	✅(no texture meshes)
Qt6.5+ macOS	✅	-	-	✅	✅(no texture meshes)

Lines noted with - are not implemented (and wont be) since they are not possible (like Direct3D on Mac). As for Qt5 support, this is maintained by keeping the Software Rendering compatible, but there wont be any extra effort to have native opengl rendering in Qt5.

Features

Display Rive animations in QML
All Rive Features are supported. (State November 2023)
Windows, Linux, MacOS
Hardware Rendering in OpenGL, Metal, Vulkan, Direct3D
Software Rendering
Interactive animations with support for user input and triggers
Data bindings for reading and writing data to and from Rive animations
Support for managing multiple artboards, animations, and state machines

Compatibility

The plugin has been tested on:

Windows using the MSVC 2019 compiler and Qt 5.15.2+, Qt6.5+
Linux (Ubuntu 22.04 LTS) and Qt 5.15.2+, Qt 6.5+
- Clang14 and gcc 11.4 (or newer versions) are supported
- If you are using Clang14, ensure that all clang dependencies are installed
- apt-get install clang-format clang-tidy clang-tools clang clangd libc++-dev libc++1 libc++abi-dev libc++abi1 libclang-dev libclang1 liblldb-dev libllvm-ocaml-dev libomp-dev libomp5 lld lldb llvm-dev llvm-runtime llvm python3-clang
- Use the automatic installation script if you get issues: https://apt.llvm.org/
- chmod +x llvm.sh and sudo ./llvm.sh 14

We recommend to build the plugin with Clang14, as it includes the Clang vector builtins.

Dependencies

Qt 5.15.2+ or Qt 6.5+
Rive C++ Runtime (available at https://github.com/rive-app/rive-cpp)
- Hint: You don't have to compile the it from the repo. Cmake will download rive-cpp and its dependencies and build them using cmake. The result is a static lib the plugin links against.

Building

git clone git@github.com:basysKom/RiveQtQuickPlugin.git
git submodule update --init --recursive
Install missing dependencies (libxkbcommon-dev might be missing on Ubuntu 22.04)
Building using cmake and make should work just fine

cd /path/to/repo/

# Remove comment if you're building with Clang14
# export CC=clang
# export CXX=clang++

mkdir build
cd build
cmake -DCMAKE_PREFIX_PATH=~/.Qt/6.5.1/gcc_64 -S .. -B .
make

Usage

The QML API Documentation can be found here: https://basyskom.github.io/RiveQtQuickPlugin/index.html

Here's a short example of how to use the RiveQtQuickItem in your QML code:

import RiveQtQuickPlugin 1.0

...

RiveQtQuickItem {
    id: riveItem

    width: 800
    height: 800

    fileSource: "YOUR_RIVE_FILE"

    stateMachineInterface: RiveStateMachineInput {
        property real level: slider.value
    }
}

Logging

There are 4 logging categories, so it is easy to filter relevant output:

rqqpItem: Logs related to the RiveQtQuickItem, like file loading, properties, etc.
rqqpFactory: Logs related to the Rive Factory Wrapper classes
rqqpRendering: Logs related to rendering and the rendering classes
rqqpInspection: Logs related to the content of the rive file like artboards, animations, statemachine info.
rqqpInteraction: Logs related to user interaction with the item and rive content

Examples

Check out the "example" folder in this repository for a complete example project demonstrating how to use the RiveQtQuickPlugin. Also take a look in our blog at https://blog.basyskom.com

Linux

In order to run the example project, set the import path correctly

Qt 5.15.2:

export QML2_IMPORT_PATH=YOUR/BUILD/DIR/binary/

Qt 6.5.0:

export QML_IMPORT_PATH=YOUR/BUILD/DIR/binary/

Hint: In QtCreator you can set the variable(s) in the project settings under "Environment"

Windows

Everything is deployed in your build directory into a directory called "binary"

Contributing

Contributions are welcome! If you encounter any issues or would like to request a feature, feel free to open an issue or submit a pull request.

License

This project is released under the LGPLv3.0-or-later License.

basysKom/RiveQtQuickPlugin