commit	e438959e2f3b7d6d1524e3271244eb8dc8ed6845	[log] [tgz]
author	philter <hello@rive.app>	Thu Jun 27 19:35:30 2024 +0000
committer	philter <hello@rive.app>	Thu Jun 27 19:35:30 2024 +0000
tree	4a8b267617a9c98be917bbc3afe369d89176c4d3
parent	60ca97d3a4088ce76fc6f7e2094415b52ef7c461 [diff]

tree: 4a8b267617a9c98be917bbc3afe369d89176c4d3

README.md

Discord badge

rive-cpp

Rive hero image

Rive C++ is a runtime library for Rive, a real-time interactive design and animation tool.

The C++ runtime for Rive provides these runtime features:

Loading Artboards and their contents from .riv files.
Querying LinearAnimations and StateMachines from Artboards.
Making changes to Artboard hierarchy (fundamentally same guts used by LinearAnimations and StateMachines) and effienclty solving those changes via Artboard::advance.
Abstract Renderer for submitting high level vector path commands with retained path objects to optimize and minimize path re-computation (ultimately up to the concrete rendering implementation).
Example concrete renderer written in C++ with Skia. Skia renderer code is in skia/renderer/src/skia_factory.cpp.

Build system

We use premake5. The Rive dev team primarily works on MacOS. There is some work done by the community to also support Windows and Linux. PRs welcomed for specific platforms you wish to support! We encourage you to use premake as it's highly extensible and configurable for a variety of platforms.

Build

In the rive-cpp directory, run build.sh to debug build and build.sh release for a release build.

If you've put the premake5 executable in the rive-cpp/build folder, you can run it with PATH=.:$PATH ./build.sh

Rive makes use of clang vector builtins, which are, as of 2022, still a work in progress. Please use clang and ensure you have the latest version.

Building skia projects

cd skia/dependencies
./make_skia.sh      // this will invoke get_skia.sh

To build viewer (plus you'll needed CMake installed)

./make_viewer_dependencies.sh

Testing

Uses the Catch2 testing framework.

cd dev
./test.sh

In the dev directory, run test.sh to compile and execute the tests.

(if you've installed premake5 in rive-cpp/build, you can run it with PATH=../../build:$PATH ./test.sh)

The tests live in rive/test. To add new tests, create a new xxx_test.cpp file here. The test harness will automatically pick up the new file.

There's a VSCode command provided to run tests from the Tasks: Run Task command palette.

Code formatting

rive-cpp uses clang-format, you can install it with brew on MacOS: brew install clang-format.

Memory checks

Note that if you‘re on MacOS you’ll want to install valgrind, which is somewhat complicated these days. This is the easiest solution (please PR a better one when it becomes available).

brew tap LouisBrunner/valgrind
brew install --HEAD LouisBrunner/valgrind/valgrind

You can now run the all the tests through valgrind by running test.sh memory.

Disassembly explorer

If you want to examine the generated assembly code per cpp file, install Disassembly Explorer in VSCode.

A disassemble task is provided to compile and preview the generated assembly. You can reach it via the Tasks: Run Task command palette or you can bind it to a shortcut by editing your VSCode keybindings.json:

[
    {
        "key": "cmd+d",
        "command": "workbench.action.tasks.runTask",
        "args": "disassemble"
    }
]