319 lines
15 KiB
HTML
319 lines
15 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Build for Android on Windows - Filament</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="../highlight.css">
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
<!-- MathJax -->
|
|
<script async src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "light" : "light";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
var sidebar = null;
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div style="display:flex;align-items:center;justify-content:center">
|
|
<img class="flogo" src="../images/filament_logo_small.png"></img>
|
|
</div>
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<!-- Filament: disable themes because the markdeep part does not look good for dark themes -->
|
|
<!--
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
-->
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Filament</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="https://github.com/google/filament" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="building-filament-for-android-on-windows"><a class="header" href="#building-filament-for-android-on-windows">Building Filament for Android on Windows</a></h1>
|
|
<h2 id="prerequisites"><a class="header" href="#prerequisites">Prerequisites</a></h2>
|
|
<p>In addition to the requirements for <a href="../BUILDING.html#windows">building Filament on Windows</a>, you'll
|
|
need the Android SDK and NDK. See <a href="https://developer.android.com/ndk/guides/">Getting Started with the
|
|
NDK</a> for detailed installation instructions.</p>
|
|
<p>You'll also need <a href="https://github.com/ninja-build/ninja/wiki/Pre-built-Ninja-packages">Ninja 1.8</a> (or
|
|
more recent) and <a href="https://git-scm.com/download/win">Git for Windows</a> to clone the repository and run
|
|
Bash scripts.</p>
|
|
<p>Ensure the <code>%ANDROID_HOME%</code> environment variable is set to your Android SDK installation location.</p>
|
|
<p>On Windows, we require VS2019 for building the host tools. All of the following commands should be
|
|
executed in a <em>Visual Studio x64 Native Tools Command Prompt for VS 2019</em>.</p>
|
|
<h3 id="a-note-about-python-3"><a class="header" href="#a-note-about-python-3">A Note About Python 3</a></h3>
|
|
<p>Python 3 is required. If CMake errors because it cannot find Python 3:</p>
|
|
<pre><code>Could NOT find PythonInterp: Found unsuitable version "1.4", but required is at least "3"
|
|
</code></pre>
|
|
<p>then add the following flag to the CMake invocations:</p>
|
|
<pre><code>-DPYTHON_EXECUTABLE:FILEPATH=\path\to\python3
|
|
</code></pre>
|
|
<h2 id="desktop-tools"><a class="header" href="#desktop-tools">Desktop Tools</a></h2>
|
|
<p>First, a few Filament tools need to be compiled for desktop.</p>
|
|
<ol>
|
|
<li>From Filament's root directory, create a desktop build directory and run CMake.</li>
|
|
</ol>
|
|
<pre><code>mkdir out\cmake-release
|
|
cd out\cmake-release
|
|
cmake ^
|
|
-G Ninja ^
|
|
-DCMAKE_INSTALL_PREFIX=..\release\filament ^
|
|
-DFILAMENT_ENABLE_JAVA=NO ^
|
|
-DCMAKE_BUILD_TYPE=Release ^
|
|
..\..
|
|
</code></pre>
|
|
<ol start="2">
|
|
<li>Build the required desktop host tools.</li>
|
|
</ol>
|
|
<pre><code>ninja matc resgen cmgen
|
|
</code></pre>
|
|
<p>The build should succeed and a <code>ImportExecutables-Release.cmake</code> file should automatically be
|
|
created at Filament's root directory.</p>
|
|
<p>If you are going to build Filament samples you should install desktop host tools:</p>
|
|
<pre><code>ninja install
|
|
</code></pre>
|
|
<h2 id="build"><a class="header" href="#build">Build</a></h2>
|
|
<ol>
|
|
<li>Create the build directories.</li>
|
|
</ol>
|
|
<pre><code>mkdir out\cmake-android-release-aarch64
|
|
mkdir out\cmake-android-release-arm7
|
|
mkdir out\cmake-android-release-x86_64
|
|
mkdir out\cmake-android-release-x86
|
|
</code></pre>
|
|
<ol start="2">
|
|
<li>Run CMake for each architecture.</li>
|
|
</ol>
|
|
<pre><code>cd out\cmake-android-release-aarch64
|
|
cmake ^
|
|
-G Ninja ^
|
|
-DCMAKE_BUILD_TYPE=Release ^
|
|
-DCMAKE_INSTALL_PREFIX=..\android-release\filament ^
|
|
-DCMAKE_TOOLCHAIN_FILE=..\..\build\toolchain-aarch64-linux-android.cmake ^
|
|
..\..
|
|
|
|
cd out\cmake-android-release-arm7
|
|
cmake ^
|
|
-G Ninja ^
|
|
-DCMAKE_BUILD_TYPE=Release ^
|
|
-DCMAKE_INSTALL_PREFIX=..\android-release\filament ^
|
|
-DCMAKE_TOOLCHAIN_FILE=..\..\build\toolchain-arm7-linux-android.cmake ^
|
|
..\..
|
|
|
|
cd out\cmake-android-release-x86_64
|
|
cmake ^
|
|
-G Ninja ^
|
|
-DCMAKE_BUILD_TYPE=Release ^
|
|
-DCMAKE_INSTALL_PREFIX=..\android-release\filament ^
|
|
-DCMAKE_TOOLCHAIN_FILE=..\..\build\toolchain-x86_64-linux-android.cmake ^
|
|
..\..
|
|
|
|
cd out\cmake-android-release-x86
|
|
cmake ^
|
|
-G Ninja ^
|
|
-DCMAKE_BUILD_TYPE=Release ^
|
|
-DCMAKE_INSTALL_PREFIX=..\android-release\filament ^
|
|
-DCMAKE_TOOLCHAIN_FILE=..\..\build\toolchain-x86-linux-android.cmake ^
|
|
..\..
|
|
</code></pre>
|
|
<ol start="3">
|
|
<li>Build.</li>
|
|
</ol>
|
|
<p>Inside of each build directory, run:</p>
|
|
<pre><code>ninja install
|
|
</code></pre>
|
|
<h2 id="generate-aar"><a class="header" href="#generate-aar">Generate AAR</a></h2>
|
|
<p>The Gradle project used to generate the AAR is located at <code><filament>\android</code>.</p>
|
|
<pre><code>cd android
|
|
gradlew -Pcom.google.android.filament.dist-dir=..\out\android-release\filament assembleRelease
|
|
copy filament-android\build\outputs\aar\filament-android-release.aar ..\..\out\
|
|
</code></pre>
|
|
<p>If you're only interested in building for a single ABI, you'll need to pass a <code>com.google.android.filament.abis</code> parameter:</p>
|
|
<pre><code>gradlew -Pcom.google.android.filament.dist-dir=..\out\android-release\filament assembleRelease -Pcom.google.android.filament.abis=x86
|
|
</code></pre>
|
|
<p>If you're only interested in building SDK, you may skip samples build by passing a <code>com.google.android.filament.skip-samples</code> flag:</p>
|
|
<pre><code>gradlew -Pcom.google.android.filament.dist-dir=..\out\android-release\filament assembleRelease -Pcom.google.android.filament.skip-samples
|
|
</code></pre>
|
|
<p><code>filament-android-release.aar</code> should now be present at <code><filament>\out\filament-android-release.aar</code>.</p>
|
|
<p>See <a href="../README.html">Using Filament's AAR</a> for usage instructions.</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../dup/building.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../build/maven_release.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../dup/building.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../build/maven_release.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|