Skip to content

Commit

Permalink
docs(runtimes): address pull request comments
Browse files Browse the repository at this point in the history
  • Loading branch information
dskuza committed Feb 13, 2025
1 parent eda0b6c commit c71fa1e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 11 deletions.
2 changes: 1 addition & 1 deletion runtimes/apple/migrating-from-1.x.x-to-2.x.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: 'Migrating from 1.x.x to 2.x.x'
description: 'Migrating guide from < 2.x'
---

The Rive runtime for Apple platforms has a different API in 2.x.x from 1.x.x that allows for a unified internal model that supports both Storyboard/UIKit and SwiftUI usage.
The Rive Apple runtime has a different API in 2.x.x from 1.x.x that allows for a unified internal model that supports both Storyboard/UIKit and SwiftUI usage.

There are now 3 main pieces of the Rive API to be familiar with for iOS development:

Expand Down
2 changes: 1 addition & 1 deletion runtimes/apple/migrating-from-5.x.x-to-6.x.x.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ description: 'Migrating guide from < 6.x'

## Package Size

Rive's Apple runtime is now \~57% smaller, at \~3.3mb, compared to \~7.6mb prior to v6.0.0.
Rive's iOS runtime is now \~57% smaller, at \~3.3mb, compared to \~7.6mb prior to v6.0.0.
16 changes: 7 additions & 9 deletions runtimes/choose-a-renderer/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The table below outlines the available, and default, renderers for Rive's runtim

### Note on Rendering in Flutter

Starting in Flutter `v3.10`, [Impeller](https://docs.flutter.dev/perf/impeller) has replaced [Skia](https://skia.org/) to become the default renderer for apps on Apple platforms and may continue to be the default on future platforms over time. As such, there is a possibility of rendering and [performance](https://github.com/flutter/flutter/issues/134432) discrepancies when using the Rive Flutter runtime with platforms that use the Impeller renderer that may not have surfaced before. If you encounter any visual or performance errors at runtime compared to expected behavior in the Rive editor, we recommend trying the following steps to triage:
Starting in Flutter `v3.10`, [Impeller](https://docs.flutter.dev/perf/impeller) has replaced [Skia](https://skia.org/) to become the default renderer for apps on iOS platforms and may continue to be the default on future platforms over time. As such, there is a possibility of rendering and [performance](https://github.com/flutter/flutter/issues/134432) discrepancies when using the Rive Flutter runtime with platforms that use the Impeller renderer that may not have surfaced before. If you encounter any visual or performance errors at runtime compared to expected behavior in the Rive editor, we recommend trying the following steps to triage:

1. Try running the Flutter app with the `--no-enable-impeller` flag to use the Skia renderer. If the visual discrepancy does not show when using Skia, it may be a rendering bug on Impeller. However, before raising a bug with the Flutter team, try the second point below👇

Expand All @@ -36,14 +36,14 @@ flutter run --no-enable-impeller

## Rive Renderer

The [Rive Renderer](https://rive.app/renderer) is now available on Android and Apple platforms. See [Specifying a Renderer](#specifying-a-renderer) to set it as your preferred renderer.
The [Rive Renderer](https://rive.app/renderer) is now available on Android and Apple runtimes. See [Specifying a Renderer](#specifying-a-renderer) to set it as your preferred renderer.

While it's ready for testing and your feedback is highly valued during this phase, we advise exercising caution before considering it for production builds. You may encounter compatibility issues with certain devices. Please reach out to us on Discord or through our Support Channel.

Your collaboration helps us refine and enhance the Rive Renderer to make it more robust and reliable for broader applications. Thank you for being a part of this exciting journey!

<Note>
By default, Android will use the current Skia renderer, and Apple platforms will use the Rive Renderer (as of v6.0.0).
By default, Android will use the current Skia renderer, and Apple runtimes will use the Rive Renderer (as of v6.0.0).
</Note>

<Tabs>
Expand All @@ -52,13 +52,11 @@ Your collaboration helps us refine and enhance the Rive Renderer to make it more

## Starting Version

The Rive Renderer was introduced in Apple runtimes starting at **v5.3.2**, however, we recommend installing the latest version of the dependency to get the latest updates. See the [CHANGELOG](https://github.com/rive-app/rive-ios/blob/main/CHANGELOG.md) for details on the latest versions. Starting in v6.0.0, Rive Renderer is used as the default on Apple platforms.

Also note that at this time, only Apple Silicon-based Mac machines will support the Rive Renderer in macOS applications.
The Rive Renderer was made the default renderer in Apple runtimes as the starting at **v6.0.0**, however, we recommend installing the latest version of the dependency to get the latest updates. See the [CHANGELOG](https://github.com/rive-app/rive-ios/blob/main/CHANGELOG.md) for details on the latest versions.

### Performance

The Rive Renderer will shine best on Apple platforms in memory usage as an animation plays out, in comparison to previous default renderers.
The Rive Renderer will shine best on Apple runtimes in memory usage as an animation plays out, in comparison to previous default renderers.

With UIKit, you'll be able to see the best performance differences by drawing multiple times on a single `RiveView`, rather than creating multiple instances of `RiveView`s, or multiple `RiveViewModel`s.

Expand Down Expand Up @@ -103,10 +101,10 @@ Your collaboration helps us refine and enhance the Rive Renderer to make it more

Options:

- **Apple**: `Skia` (default), `Rive`, and `CoreGraphics`
- **Apple**: `Rive` (default), and `CoreGraphics`
- **Android**: `Skia` (default), `Rive`, and `Canvas`

In the future, `Rive` will be the default for both Apple platforms and Android.
In the future, `Rive` will be the default for both Apple runtimes and Android.

See the **iOS / mac OS** and **Android** sections for additional information on renderers and fallbacks.
</Tab>
Expand Down

0 comments on commit c71fa1e

Please sign in to comment.