Files
filament/android/samples/README.md
T
Romain Guy eaf790aaa7 Improve rendering to TextureView (#635)
* Improve rendering to TextureView

UiHelper wasn't calling the resize callback at init time when attaching
to a TextureView, but it was for a SurfaceView. This makes both code
paths consistent and fixes the standard samples if they are modified to
render to a TextureView.

This change also adds a new sample app that shows how to render into
a TextureView.

* Suppress warning

* Suppress another warning
2018-12-13 15:57:15 -08:00

83 lines
2.7 KiB
Markdown

# Filament sample Android apps
This directory contains several sample Android applications that demonstrate how to use the
Filament APIs:
### `hello-triangle`
Demonstrates how to setup a rendering surface for Filament:
![Hello Triangle](../../docs/images/samples/sample_hello_triangle.jpg)
### `lit-cube`
Demonstrates how to create a light and a mesh with the attributes required for lighting:
![Lit Cube](../../docs/images/samples/sample_lit_cube.jpg)
### `image-based-lighting`
Demonstrates how to create image-based lights and load complex meshes:
![Image-based Lighting](../../docs/images/samples/sample_image_based_lighting.jpg)
### `textured-object`
Demonstrates how to load and use textures for complex materials:
![Textured Object](../../docs/images/samples/sample_textured_object.jpg)
### `transparent-rendering`
Demonstrates how to render into a transparent `SurfaceView`:
![Transparent Rendering](../../docs/images/samples/sample_transparent_rendering.jpg)
### `texture-view`
Demonstrates how to render into a `TextureView` instead of a `SurfaceView`:
![Texture View](../../docs/images/samples/sample_texture_view.jpg)
## Prerequisites
Before you start, make sure to read [Filament's README](../../README.md). You need to be able to
compile Filament's native library and Filament's AAR for this project. The easiest way to proceed
is to install all the required dependencies and to run the following commands at the root of the
source tree:
```
$ ./build.sh -p desktop -i release
$ ./build.sh -p android release
```
This will build all the native components and the AAR required by this sample application.
If you do not use the build script, you must set the `filament_tools_dir` property when invoking
Gradle, either from the command line or from `local.properties`. This property must point to the
distribution/install directory for desktop (produced by make/ninja install). This directory must
contain `bin/matc` and `bin/cmgen`.
Example:
```
$ ./gradlew -Pfilament_tools_dir=../../dist-release assembleDebug
```
## Important: SDK location
Either ensure your `ANDROID_HOME` environment variable is set or make sure each project contains a
`local.properties` file with the `sdk.dir` property pointing to your installation of the Android
SDK. This includes the project `filament-android` in the parent directory.
## Android Studio
Due to issues with composite builds in Android Studio 3.1, it is highly recommended to use
Android Studio 3.2 or higher to open this project.
## Compiling
To compile and run each sample make sure you have selected the appropriate build variant
(arm7, arm8, x86 or x86_64). If you are not sure you can simply select the "universal"
variant which includes all the other ones.