diff --git a/BUILDING.md b/BUILDING.md index 1a29b02410..0326df7026 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -291,11 +291,11 @@ Alternatively you can build the AAR from the command line by executing the follo `android/` directory: ``` -$ ./gradlew -Pfilament_dist_dir=../../out/android-release/filament assembleRelease +$ ./gradlew -Pcom.google.android.filament.dist-dir=../../out/android-release/filament assembleRelease ``` -The `-Pfilament_dist_dir` can be used to specify a different installation directory (it must match -the CMake install prefix used in the previous steps). +The `-Pcom.google.android.filament.dist-dir` can be used to specify a different installation +directory (it must match the CMake install prefix used in the previous steps). #### Using Filament's AAR diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index d05d6bc22a..5675b3c38c 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -5,6 +5,13 @@ A new header is inserted each time a *tag* is created. ## v1.12.12 (currently main branch) +- Android: Gradle configuration caching is now enabled +- Android: Filament's Gradle properties have all been renamed to `com.google.android.filament.xxx` + where `xxx` is the property name. See `android/build.gradle` for a complete list [⚠️] +- Android: The Gradle property `filament_tools_dir` (now called + `com.google.android.filament.tools-dir`) does not have a default value anymore. Please specify + one in your `gradle.properties` if you reuse the Gradle plugin in your projects [⚠️] + ## v1.12.11 ## v1.12.10 diff --git a/android/Windows.md b/android/Windows.md index 8bf142c0ef..0e80198226 100644 --- a/android/Windows.md +++ b/android/Windows.md @@ -122,20 +122,20 @@ The Gradle project used to generate the AAR is located at `\android`. ``` cd android -gradlew -Pfilament_dist_dir=..\out\android-release\filament assembleRelease +gradlew -Pcom.google.android.filament.dist-dir=..\out\android-release\filament assembleRelease copy filament-android\build\outputs\aar\filament-android-release.aar ..\..\out\ ``` -If you're only interested in building for a single ABI, you'll need to pass a `filament_abis` parameter: +If you're only interested in building for a single ABI, you'll need to pass a `com.google.android.filament.abis` parameter: ``` -gradlew -Pfilament_dist_dir=..\out\android-release\filament assembleRelease -Pfilament_abis=x86 +gradlew -Pcom.google.android.filament.dist-dir=..\out\android-release\filament assembleRelease -Pcom.google.android.filament.abis=x86 ``` -If you're only interested in building SDK, you may skip samples build by passing a `filament_skip_samples` flag: +If you're only interested in building SDK, you may skip samples build by passing a `com.google.android.filament.skip-samples` flag: ``` -gradlew -Pfilament_dist_dir=..\out\android-release\filament assembleRelease -Pfilament_skip_samples +gradlew -Pcom.google.android.filament.dist-dir=..\out\android-release\filament assembleRelease -Pfilament_skip_samples ``` diff --git a/android/build.gradle b/android/build.gradle index 71008d4a9a..0ea3922804 100644 --- a/android/build.gradle +++ b/android/build.gradle @@ -1,26 +1,28 @@ // This script accepts the following parameters: // -// filament_dist_dir +// com.google.android.filament.dist-dir // Path to the Filament distribution/install directory for Android // (produced by make/ninja install). This directory must contain lib/arm64-v8a/ etc. // -// filament_tools_dir +// com.google.android.filament.tools-dir // Path to the Filament distribution/install directory for desktop. // This directory must contain bin/matc. // -// filament_exclude_vulkan +// com.google.android.filament.exclude-vulkan // When set, support for Vulkan will be excluded. // -// filament_skip_samples +// com.google.android.filament.skip-samples // Exclude samples from the project. Useful to speed up compilation. // -// filament_abis +// com.google.android.filament.abis // List of supported ABIs to build as a comma separated list. Available options are: // arm64-v8a, armeabi-v7a, x86_64, x86, all // Defaults to all. // // Example: -// ./gradlew -Pfilament_dist_dir=../dist-android-release assembleRelease -Pfilament_abis=x86 +// ./gradlew -Pcom.google.android.filament.dist-dir=../dist-android-release \ +// -Pcom.google.android.filament.abis=x86 \ +// assembleRelease // Publishing to Maven Central: // - Build and upload artifacts with ./gradlew publish @@ -41,19 +43,19 @@ buildscript { def filamentPath = file("../out/android-release/filament").absolutePath - if (project.hasProperty("filament_dist_dir")) { - filamentPath = file(project.property("filament_dist_dir")).absolutePath + if (project.hasProperty("com.google.android.filament.dist-dir")) { + filamentPath = file(project.property("com.google.android.filament.dist-dir")).absolutePath } // Our CMake scripts require a forward-slash path for the FILAMENT_DIST_DIR // variable, so here we convert the native path to a forward-slash path. filamentPath = filamentPath.replace(File.separator, '/') // Warning: changing this property does not work well with incremental builds. - def excludeVulkan = project.hasProperty("filament_exclude_vulkan") + def excludeVulkan = project.hasProperty("com.google.android.filament.exclude-vulkan") def abis = ["arm64-v8a", "armeabi-v7a", "x86_64", "x86"] - if (project.hasProperty("filament_abis")) { - def newAbis = project.property("filament_abis").split(',') + if (project.hasProperty("com.google.android.filament.abis")) { + def newAbis = project.property("com.google.android.filament.abis").split(',') if (!newAbis.contains("all")) { abis = newAbis } @@ -187,7 +189,8 @@ subprojects { gradle.taskGraph.whenReady { gradle.taskGraph.allTasks.each { it.onlyIf { - !it.project.ext.has('isSample') || !project.hasProperty('filament_skip_samples') + !it.project.ext.has('isSample') || + !project.hasProperty('com.google.android.filament.skip-samples') } } } diff --git a/android/buildSrc/src/main/groovy/FilamentPlugin.groovy b/android/buildSrc/src/main/groovy/FilamentPlugin.groovy index cad4b90d19..e32fcc249e 100644 --- a/android/buildSrc/src/main/groovy/FilamentPlugin.groovy +++ b/android/buildSrc/src/main/groovy/FilamentPlugin.groovy @@ -1,20 +1,22 @@ // This plugin accepts the following parameters: // -// filament_tools_dir +// com.google.android.filament.tools-dir // Path to the Filament distribution/install directory for desktop. // This directory must contain bin/matc. // -// filament_exclude_vulkan +// com.google.android.filament.exclude-vulkan // When set, support for Vulkan will be excluded. // // Example: -// ./gradlew -Pfilament_tools_dir=../../dist-release assembleDebug +// ./gradlew -Pcom.google.android.filament.tools-dir=../../dist-release assembleDebug import org.gradle.api.DefaultTask import org.gradle.api.GradleException import org.gradle.api.Plugin import org.gradle.api.Project +import org.gradle.api.provider.ProviderFactory import org.gradle.api.file.DirectoryProperty +import org.gradle.api.file.FileSystemOperations import org.gradle.api.file.FileType import org.gradle.api.file.RegularFileProperty import org.gradle.api.logging.LogLevel @@ -27,14 +29,18 @@ import org.gradle.api.tasks.Optional import org.gradle.api.tasks.OutputDirectory import org.gradle.api.tasks.TaskAction import org.gradle.api.tasks.incremental.InputFileDetails +import org.gradle.api.model.ObjectFactory import org.gradle.internal.os.OperatingSystem +import org.gradle.process.ExecOperations import org.gradle.work.ChangeType import org.gradle.work.Incremental import org.gradle.work.InputChanges import java.nio.file.Paths -class TaskWithBinary extends DefaultTask { +import javax.inject.Inject + +abstract class TaskWithBinary extends DefaultTask { private final String binaryName private Property binaryPath = null @@ -42,15 +48,23 @@ class TaskWithBinary extends DefaultTask { binaryName = name } + @Inject abstract ObjectFactory getObjects() + @Inject abstract ProviderFactory getProviders() + @Input Property getBinary() { if (binaryPath == null) { def tool = ["/bin/${binaryName}.exe", "/bin/${binaryName}"] def fullPath = tool.collect { path -> - Paths.get(project.ext.filamentToolsPath.absolutePath, path).toFile() + def filamentToolsPath = providers + .gradleProperty("com.google.android.filament.tools-dir") + .forUseAtConfigurationTime().get() + def directory = objects.fileProperty() + .fileValue(new File(filamentToolsPath)).getAsFile().get() + Paths.get(directory.absolutePath, path).toFile() } - binaryPath = project.objects.property(String.class) + binaryPath = objects.property(String.class) binaryPath.set( (OperatingSystem.current().isWindows() ? fullPath[0] : fullPath[1]).toString()) } @@ -84,6 +98,11 @@ abstract class MaterialCompiler extends TaskWithBinary { @OutputDirectory abstract DirectoryProperty getOutputDir() + @Inject abstract FileSystemOperations getFs() + @Inject abstract ExecOperations getExec() + @Inject abstract ObjectFactory getObjects() + @Inject abstract ProviderFactory getProviders() + MaterialCompiler() { super("matc") } @@ -91,7 +110,9 @@ abstract class MaterialCompiler extends TaskWithBinary { @TaskAction void execute(InputChanges inputs) { if (!inputs.incremental) { - project.delete(project.fileTree(outputDir.asFile.get()).matching { include '*.filamat' }) + fs.delete({ + delete(objects.fileTree().from(outputDir).matching { include '*.filamat' }) + }) } inputs.getFileChanges(inputDir).each { InputFileDetails change -> @@ -115,12 +136,15 @@ abstract class MaterialCompiler extends TaskWithBinary { } def matcArgs = [] - if (!project.hasProperty("filament_exclude_vulkan")) { + def exclude_vulkan = providers + .gradleProperty("com.google.android.filament.exclude-vulkan") + .forUseAtConfigurationTime().present + if (!exclude_vulkan) { matcArgs += ['-a', 'vulkan'] } matcArgs += ['-a', 'opengl', '-p', 'mobile', '-o', getOutputFile(file), file] - project.exec { + exec.exec { standardOutput out errorOutput err executable "${binary.get()}" @@ -149,6 +173,10 @@ abstract class IblGenerator extends TaskWithBinary { @OutputDirectory abstract DirectoryProperty getOutputDir() + @Inject abstract FileSystemOperations getFs() + @Inject abstract ExecOperations getExec() + @Inject abstract ObjectFactory getObjects() + IblGenerator() { super("cmgen") } @@ -156,7 +184,9 @@ abstract class IblGenerator extends TaskWithBinary { @TaskAction void execute(InputChanges inputs) { if (!inputs.incremental) { - project.delete(project.fileTree(outputDir.asFile.get()).matching { include '*' }) + fs.delete({ + delete(objects.fileTree().from(outputDir).matching { include '*' }) + }) } inputs.getFileChanges(inputFile).each { InputFileDetails change -> @@ -188,7 +218,7 @@ abstract class IblGenerator extends TaskWithBinary { } commandArgs = commandArgs + " " + file - project.exec { + exec.exec { standardOutput out errorOutput err executable "${binary.get()}" @@ -213,6 +243,9 @@ abstract class MeshCompiler extends TaskWithBinary { @OutputDirectory abstract DirectoryProperty getOutputDir() + @Inject abstract FileSystemOperations getFs() + @Inject abstract ExecOperations getExec() + MeshCompiler() { super("filamesh") } @@ -220,7 +253,9 @@ abstract class MeshCompiler extends TaskWithBinary { @TaskAction void execute(InputChanges inputs) { if (!inputs.incremental) { - project.delete(project.fileTree(outputDir.asFile.get()).matching { include '*.filamesh' }) + fs.delete({ + delete(objects.fileTree().from(outputDir).matching { include '*.filamesh' }) + }) } inputs.getFileChanges(inputFile).each { InputFileDetails change -> @@ -243,7 +278,7 @@ abstract class MeshCompiler extends TaskWithBinary { " Ensure Filament has been built/installed before building this app.") } - project.exec { + exec.exec { standardOutput out errorOutput err executable "${binary.get()}" @@ -280,11 +315,6 @@ class FilamentToolsPlugin implements Plugin { extension.meshInputFile = project.objects.fileProperty() extension.meshOutputDir = project.objects.directoryProperty() - project.ext.filamentToolsPath = project.file("../../../out/release/filament") - if (project.hasProperty("filament_tools_dir")) { - project.ext.filamentToolsPath = project.file(project.property("filament_tools_dir")) - } - project.tasks.register("filamentCompileMaterials", MaterialCompiler) { enabled = extension.materialInputDir.isPresent() && diff --git a/android/gradle.properties b/android/gradle.properties index 28712c5450..349cd8c460 100644 --- a/android/gradle.properties +++ b/android/gradle.properties @@ -20,3 +20,5 @@ org.gradle.jvmargs=-Xmx1536m android.useAndroidX=true org.gradle.unsafe.configuration-cache=true + +com.google.android.filament.tools-dir=../../../out/release/filament diff --git a/android/samples/sample-page-curl/src/main/java/com/google/android/filament/pagecurl/MainActivity.java b/android/samples/sample-page-curl/src/main/java/com/google/android/filament/pagecurl/MainActivity.java index 5373470b91..be13ed91c4 100644 --- a/android/samples/sample-page-curl/src/main/java/com/google/android/filament/pagecurl/MainActivity.java +++ b/android/samples/sample-page-curl/src/main/java/com/google/android/filament/pagecurl/MainActivity.java @@ -70,11 +70,11 @@ public class MainActivity extends Activity private Page mPage; private PageMaterials mPageMaterials; private Scene mScene; - private Texture[] mTextures = new Texture[2]; + private final Texture[] mTextures = new Texture[2]; private @Entity int mLight; private IndirectLight mIndirectLight; - private float[] mTouchDownPoint = new float[2]; + private final float[] mTouchDownPoint = new float[2]; private float mTouchDownValue = 0; private float mPageAnimationRadians = 0; private float mPageAnimationValue = 0; diff --git a/build.sh b/build.sh index 7aeb83cd07..45b3cf1ae9 100755 --- a/build.sh +++ b/build.sh @@ -453,23 +453,23 @@ function build_android { if [[ "${ISSUE_DEBUG_BUILD}" == "true" ]]; then ./gradlew \ - -Pfilament_dist_dir=../out/android-debug/filament \ - -Pfilament_abis=${ABI_GRADLE_OPTION} \ + -Pcom.google.android.filament.dist-dir=../out/android-debug/filament \ + -Pcom.google.android.filament.abis=${ABI_GRADLE_OPTION} \ ${VULKAN_ANDROID_GRADLE_OPTION} \ :filament-android:assembleDebug \ :gltfio-android:assembleDebug \ :filament-utils-android:assembleDebug ./gradlew \ - -Pfilament_dist_dir=../out/android-debug/filament \ - -Pfilament_abis=${ABI_GRADLE_OPTION} \ + -Pcom.google.android.filament.dist-dir=../out/android-debug/filament \ + -Pcom.google.android.filament.abis=${ABI_GRADLE_OPTION} \ :filamat-android:assembleDebug if [[ "${BUILD_ANDROID_SAMPLES}" == "true" ]]; then for sample in ${ANDROID_SAMPLES}; do ./gradlew \ - -Pfilament_dist_dir=../out/android-debug/filament \ - -Pfilament_abis=${ABI_GRADLE_OPTION} \ + -Pcom.google.android.filament.dist-dir=../out/android-debug/filament \ + -Pcom.google.android.filament.abis=${ABI_GRADLE_OPTION} \ :samples:${sample}:assembleDebug done fi @@ -502,23 +502,23 @@ function build_android { if [[ "${ISSUE_RELEASE_BUILD}" == "true" ]]; then ./gradlew \ - -Pfilament_dist_dir=../out/android-release/filament \ - -Pfilament_abis=${ABI_GRADLE_OPTION} \ + -Pcom.google.android.filament.dist-dir=../out/android-release/filament \ + -Pcom.google.android.filament.abis=${ABI_GRADLE_OPTION} \ ${VULKAN_ANDROID_GRADLE_OPTION} \ :filament-android:assembleRelease \ :gltfio-android:assembleRelease \ :filament-utils-android:assembleRelease ./gradlew \ - -Pfilament_dist_dir=../out/android-release/filament \ - -Pfilament_abis=${ABI_GRADLE_OPTION} \ + -Pcom.google.android.filament.dist-dir=../out/android-release/filament \ + -Pcom.google.android.filament.abis=${ABI_GRADLE_OPTION} \ :filamat-android:assembleRelease if [[ "${BUILD_ANDROID_SAMPLES}" == "true" ]]; then for sample in ${ANDROID_SAMPLES}; do ./gradlew \ - -Pfilament_dist_dir=../out/android-release/filament \ - -Pfilament_abis=${ABI_GRADLE_OPTION} \ + -Pcom.google.android.filament.dist-dir=../out/android-release/filament \ + -Pcom.google.android.filament.abis=${ABI_GRADLE_OPTION} \ :samples:${sample}:assembleRelease done fi @@ -831,7 +831,7 @@ while getopts ":hacCfijmp:q:uvslwtdk:" opt; do ;; v) VULKAN_ANDROID_OPTION="-DFILAMENT_SUPPORTS_VULKAN=OFF" - VULKAN_ANDROID_GRADLE_OPTION="-Pfilament_exclude_vulkan" + VULKAN_ANDROID_GRADLE_OPTION="-Pcom.google.android.filament.exclude-vulkan" echo "Disabling support for Vulkan in the core Filament library." echo "Consider using -c after changing this option to clear the Gradle cache." ;;