| commit | fa6e59865cd1de99a3dfe06b5681f8aae266317e | [log] [tgz] |
|---|---|---|
| author | luigi-rosso <hello@rive.app> | Fri Jun 07 00:44:49 2024 +0000 |
| committer | luigi-rosso <hello@rive.app> | Fri Jun 07 00:44:49 2024 +0000 |
| tree | 5fa6787fa8a9d7f422f92510c25eb35f11bde1d7 | |
| parent | dd5cc310886c2a615608aab843d929677ecb81fb [diff] |
Get rid of MetricsPath. This lets us trim a raw path directly which means all the trim path logic from the editor can now be pushed down to the C++ runtime, even for the case where the rendering is still happening via Skia/Impeller, all our path operations can be done in C++ (without using RenderPath/MetricsPath/RenderMetricsPath/OnlyMetricsPath/etc). Basically, I needed to do this now to not have as many edge cases in the editor for the difference between using our runtime to render with PLS vs Flutter. It also quite greatly simplifies the code! More lines removed than added! Some tests will fail as I think we're using the MetricsPath in some other parts of the code, but that can be refactored following the patterns used here... It also means that most of our runtime now speaks RawPath which means we can optimize/reserve memory ahead of time in a lot of cases (not doing that yet). Diffs= 8486c3445 Get rid of MetricsPath. (#7371) Co-authored-by: Luigi Rosso <luigi-rosso@users.noreply.github.com>
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:
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.
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.
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
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.
rive-cpp uses clang-format, you can install it with brew on MacOS: brew install clang-format.
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.
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"
}
]