From b68c5117b46fb9b2b2c259447b6f4cce3330fb4b Mon Sep 17 00:00:00 2001 From: Nick Fisher Date: Wed, 4 Oct 2023 14:50:54 +0800 Subject: [PATCH] update README --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5cbaf881..2ad1f654 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ dependencies: path: ``` -# Usage +# Basic Usage See the `example` project for a complete sample of the below steps. @@ -180,6 +180,24 @@ class MyApp extends StatelessWidget { } ``` +## Advanced Usage + +If you want to work with custom materials, you will need some (basic knowledge of the underlying Filament library)[https://google.github.io/filament/Materials.html#compilingmaterials]. + +Things to keep in mind: +- You must compile materials with the correct version of Filament (see the table above). Keep in mind that versions may not be identical across platforms so you may need multiple uberz files for multiple platforms. + +e.g. the lit_opaque.uberz file has been created from a Filament build: + +``` +cd out/cmake-android-release-aarch64/libs/gltfio +uberz -TSHADINGMODEL=lit -TBLENDING=opaque -o lit_opaque_43.uberz lit_opaque +``` + +(note that the number in the filename corresponds to the Material version, not the Filament version. Not every Filament version requires a new Material version). + + + # Building Filament from source ```