DEV/flutter_flutter
1
0
Fork 0
mirror of https://github.com/flutter/flutter.git synced 2026-01-09 07:51:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
flutter_flutter/docs/engine/impeller/Flutter-GPU.md
John "codefu" McDole e068a3e6c4
chore: move engine docs out of engine/ and into docs/ (#175195) 
Moving docs to be co-located with other docs + updating links. This has
the benefit of not including docs in engine content hash semantics.
2025-09-16 18:19:50 +00:00

2.7 KiB
Raw Permalink Blame History

Flutter GPU is a low level graphics API that ships as a package in the Flutter SDK. Flutter GPU enables you to build arbitrary renderers from scratch using just Dart and GLSL. No native platform code required.

Warning

  • Flutter GPU is in an early preview state and does not guarantee API stability.
  • Flutter GPU currently requires Impeller to be enabled.
  • Automated shader building relies on the experimental Dart "Native Assets" feature.
  • Because Flutter GPU is experimental and relies on experimental features, switching to the master channel is strongly recommended.

How to use

Currently, our best getting started resource is this article.

There is also an experimental 3D rendering package powered by Flutter GPU called Flutter Scene.

Flutter GPU is a low level API for building rendering packages from scratch. Graphics programming has a steep learning curve, and it's likely that most users will opt to use a higher level rendering package rather than build their own.

Distribution

Flutter GPU can be used on the Flutter master channel.

Flutter GPU is distributed using the same mechanism as dart:ui/sky_engine. While fetching artifacts, the Flutter tool downloads a zip containing the flutter_gpu package and places it in a package cache location searched when importing SDK packages. And so Flutter GPU can be used by adding an SDK dependency to a package pubspec:

dependencies:
  flutter:
    sdk: flutter
  flutter_gpu:
    sdk: flutter

Useful links

Dart FFI

Under the hood, the API communicates with Flutter Engine via Dart FFI, calling symbols publicly exported by libflutter and/or embedders. These symbols are prefixed with InternalFlutterGpu, and are considered unstable. Direct usage of the exported symbols is not supported and will break without notice; the only supported way to use Flutter GPU is by importing package:flutter_gpu.

Reporting bugs

If you run into issues while using Flutter GPU, please file a bug using the standard bug report template. Additionally, mention "Flutter GPU" in the title, label the bug with the flutter-gpu label.