flutter/docs/engine/impeller/Impeller-Scene.md
Kate Lovett 722c8d62fd
[wiki migration] Engine team pages (#148696)
This sorts the wiki pages owned by the Engine team in the docs/ directory as planned in [flutter.dev/go/migrate-flutter-wiki-spreadsheet](https://docs.google.com/spreadsheets/d/1x65189ZBdNiLRygpUYoU08pwvXD4M-Z157c6pm8deGI/edit?usp=sharing) 

It also adds the engine and team-engine labels to the bot for future PRs.

Changes to the content were only updating cross links. The remaining wiki links will be updated after the rest of the pages are relocated, the original wiki links still work in the meantime.

Part of https://github.com/flutter/flutter/issues/145009
2024-05-20 23:40:42 +00:00

1.8 KiB

We are excited to have you tinker on the Impeller Scene Demo presented at Flutter Forward. While we spend time learning the use-cases and finalizing the API, the functionality for Impeller Scene is behind a compile-time flag. During this time, there are no guarantees around API stability.

Compiling the Engine

  • Configure your Mac host to compile the Flutter Engine by following the guidance in wiki.
  • Ensure that you are on the main branch of the Flutter Engine.
  • Ensure that you are on the main branch of the Flutter Framework.
  • Configure the host build: ./flutter/tools/gn --enable-impeller-3d --no-lto
  • Configure the iOS build: ./flutter/tools/gn --enable-impeller-3d --no-lto --ios
    • Add the --simulator --simulator-cpu=arm64 flag to the iOS build if you are going to test on the simulator.
  • Build host artifacts (this will take a while): ninja -C out/host_debug
  • Build iOS artifacts (this will take a while): ninja -C out/ios_debug
    • If targeting the simulator: ninja -C out/ios_debug_sim_arm64
  • Clone the demo repository: git clone https://github.com/bdero/flutter-scene-example.git and move into the directory.
  • Plug in your device or open Simulator.app, then run flutter devices to note the device identifier.
  • Run the demo application: flutter run -d [device_id] --local-engine ios_debug --local-engine-host host_debug (or ios_debug_sim_arm64 if you are running on the Simulator).
    • On Silicon Macs, prefer --local-engine-host host_debug_arm64 (adjusting your ninja command above accordingly)

We hope to continue evolving the API and have it available on the stable channel soon!