From 468603208217745118edf752d94e35b1568afaaf Mon Sep 17 00:00:00 2001 From: Chinmay Garde Date: Fri, 15 Nov 2024 11:39:23 -0800 Subject: [PATCH] [Impeller] libImpeller: Tinker on the README to cross reference the SDK and the example. --- impeller/README.md | 11 +++++++++++ impeller/toolkit/interop/README.md | 4 ++++ 2 files changed, 15 insertions(+) diff --git a/impeller/README.md b/impeller/README.md index 981a9b161c6b3..4cf82c5913f5e 100644 --- a/impeller/README.md +++ b/impeller/README.md @@ -229,6 +229,17 @@ To your `Info.plist` file, add under the top-level `` tag: ``` +## Embedding Standalone Impeller + +Impeller is designed to work best when used by Flutter. Most of the teams +efforts go into being great at that use-case. But, standalone Impeller can be +used to perform accelerated rendering in most environments without any Flutter +dependencies. + +Impeller provides a standalone SDK. The SDK exposes a single-header C API with +no platform dependencies. [Prebuilts for major platforms, documentation, +examples, are available](toolkit/interop/README.md). + ## Documentation, References, and Additional Reading * [Frequently Asked Questions](docs/faq.md) diff --git a/impeller/toolkit/interop/README.md b/impeller/toolkit/interop/README.md index 1b0758b5abbbd..d367c0caaa5dc 100644 --- a/impeller/toolkit/interop/README.md +++ b/impeller/toolkit/interop/README.md @@ -63,6 +63,10 @@ The `$PLATFORM_ARCH` can be determined from the table below. For example, the SDK for `Linux x64` at engine SHA `31aaaaad868743b38ac3b7165f0d58eca94e521b` would be https://storage.googleapis.com/flutter_infra_release/flutter/31aaaaad868743b38ac3b7165f0d58eca94e521b/linux-x64/impeller_sdk.zip +# Example + +A fully functional example of using Impeller to draw using GLFW is available in [`example.c`](example.c). This example is also present in the `impeller_sdk.zip` prebuilts along with necessary artifacts. + # API Fundamentals ## Versioning