Skip to content

Latest commit

 

History

History
106 lines (75 loc) · 3.82 KB

README.md

File metadata and controls

106 lines (75 loc) · 3.82 KB
Raw

Flutter Desktop Embedding Library

This library provides the basic functionality for embedding Flutter into a desktop application.

This README assumes you have already read the top level README, which contains important information and setup common to all platforms.

How to Use This Code

Currently the development workflow assumes you are starting with an existing desktop application project, and provides the pieces to add Flutter support. This is very different from the Flutter model, where the native application projects are created automatically by tools. This may change in the future, but for now there is no equivalent to flutter create.

There are currently no binary releases of the libraries. While a more Flutter-like model of using an SDK containing pre-compiled binaries is likely to be supported in the future, for now you must build the library from source.

Once you build the library for your platform, link it into your build using whatever build system you are using, and add the relevant headers (see platform-specific notes below) to your project's search path.

On all platforms your application will need to bundle your Flutter assets (as created by tools/build_flutter_assets), the built embedding library for your platform, the Flutter engine library (see platform-specific notes), and the ICU data from the Flutter engine.

Linux

Dependencies

First you will need to install the relevant dependencies:

  • GLFW3
  • GTK 3
  • jsoncpp
  • epoxy
  • X11 development libs
  • pkg-config

Installation example for debian-based systems:

$ sudo apt-get install libglfw3-dev libepoxy-dev libjsoncpp-dev libgtk-3-dev \
      libx11-dev pkg-config

Using the Library

Run make under linux/, then link libflutter_embedder.so into your binary. See embedder.h for details on calling into the library.

You will also need to link libflutter_engine.so into your binary.

Note: There is also a GN build available as an alternative to Make.

macOS

Dependencies

You must have a current version of Xcode installed.

Using the Framework

Build the Xcode project under macos/, then link the resulting framework into your application. See FLEView.h and FLEViewController.h for details on how to use them.

The framework includes the macOS Flutter engine (FlutterEmbedder.framework), so you do not need to include that framework in your project directly.

Note: The framework names are somewhat confusing:

  • FlutterEmbedder.framework is the Flutter engine packaged as a framework for consumption via the embedding API. This comes from the Flutter project.
  • FlutterEmbedderMac.framework is the output of this project. It wraps FlutterEmbedder and implements the embedding API.

Windows

Dependencies

You must have a copy of Visual Studio installed.

Using the Library

Build the GLFW Library project under windows/ in Visual Studio into a static or dynamic library, then link flutter_embedder.lib into your binary and make sure embedder.h is in your include paths. Also ensure that the flutter_engine.dll, and if using a dynamic library flutter_embedder.dll, are in valid DLL include paths.

The output files are located in bin\x64\$(Configuration)\GLFW Library\.

Caveats

  • There is currently no versioning system for coordinating the version of this project with the required version of Flutter. In the future there will be, but for now the expectation is that anyone experimenting with this project will be tracking Flutter's master branch. If you encounter build issues, try using a newer version of Flutter. If your issues are specific to the latest Flutter master, please file a bug!