material: fix depth variant leak

The default material does not cover all of the depth variants,
and so for the client material's depth variants (with no custom
depth shader), we need to check if the program is allocated for
the material or if it is actually part of the default material.

NEW_RELEASE_NOTES.md

@@ -7,3 +7,4 @@ for next branch cut* header.
 appropriate header in [RELEASE_NOTES.md](./RELEASE_NOTES.md).
 
 ## Release notes for next branch cut
+- vk: fix stage pool gc logic

README.md

@@ -31,7 +31,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.google.android.filament:filament-android:1.56.2'
+    implementation 'com.google.android.filament:filament-android:1.56.0'
 }
 ```
 
@@ -51,7 +51,7 @@ Here are all the libraries available in the group `com.google.android.filament`:
 iOS projects can use CocoaPods to install the latest release:
 
 ```shell
-pod 'Filament', '~> 1.56.2'
+pod 'Filament', '~> 1.56.0'
 ```
 
 ## Documentation

RELEASE_NOTES.md

@@ -7,10 +7,6 @@ A new header is inserted each time a *tag* is created.
 Instead, if you are authoring a PR for the main branch, add your release note to
 [NEW_RELEASE_NOTES.md](./NEW_RELEASE_NOTES.md).
 
-## v1.56.2
-
-- vk: fix stage pool gc logic
-
 ## v1.56.1
 
 ## v1.56.0

android/gradle.properties

@@ -1,5 +1,5 @@
 GROUP=com.google.android.filament
-VERSION_NAME=1.56.2
+VERSION_NAME=1.56.0
 
 POM_DESCRIPTION=Real-time physically based rendering engine for Android.
 

filament/src/details/Material.cpp

@@ -347,6 +347,12 @@ FMaterial::~FMaterial() noexcept = default;
 
 void FMaterial::invalidate(Variant::type_t variantMask, Variant::type_t variantValue) noexcept {
     DriverApi& driverApi = mEngine.getDriverApi();
+    FMaterial const* const pDefaultMaterial = mEngine.getDefaultMaterial();
+    auto hasDefaultDepthVariant = [pDefaultMaterial](Variant k) {
+        auto const& end = pDefaultMaterial->mDepthVariants.end();
+        return end != std::find(pDefaultMaterial->mDepthVariants.begin(), end, k);
+    };
+
     if (mMaterialDomain == MaterialDomain::SURFACE) {
         auto& cachedPrograms = mCachedPrograms;
         for (size_t k = 0, n = VARIANT_COUNT; k < n; ++k) {
@@ -355,8 +361,9 @@ void FMaterial::invalidate(Variant::type_t variantMask, Variant::type_t variantV
                 if (UTILS_LIKELY(!mIsDefaultMaterial)) {
                     // The depth variants may be shared with the default material, in which case
                     // we should not free it now.
-                    bool const isSharedVariant =
-                            Variant::isValidDepthVariant(variant) && !mHasCustomDepthShader;
+                    bool const isSharedVariant = Variant::isValidDepthVariant(variant) &&
+                                                 !mHasCustomDepthShader &&
+                                                 hasDefaultDepthVariant(variant);
                     if (isSharedVariant) {
                         // we don't own this variant, skip.
                         continue;
@@ -367,8 +374,7 @@ void FMaterial::invalidate(Variant::type_t variantMask, Variant::type_t variantV
             }
         }
 
-         if (UTILS_UNLIKELY(!mIsDefaultMaterial && !mHasCustomDepthShader)) {
-            FMaterial const* const pDefaultMaterial = mEngine.getDefaultMaterial();
+        if (UTILS_UNLIKELY(!mIsDefaultMaterial && !mHasCustomDepthShader)) {
             for (Variant const variant: pDefaultMaterial->mDepthVariants) {
                 pDefaultMaterial->prepareProgram(variant);
                 if (!cachedPrograms[variant.key]) {
@@ -626,6 +632,7 @@ Program FMaterial::getProgramWithVariants(
 }
 
 void FMaterial::createAndCacheProgram(Program&& p, Variant variant) const noexcept {
+    assert_invariant(!mCachedPrograms[variant.key]);
     auto program = mEngine.getDriverApi().createProgram(std::move(p));
     mEngine.getDriverApi().setDebugTag(program.getId(), mName);
     assert_invariant(program);
@@ -737,12 +744,19 @@ void FMaterial::onQueryCallback(void* userdata, VariantList* pVariants) {
 void FMaterial::destroyPrograms(FEngine& engine) {
     DriverApi& driverApi = engine.getDriverApi();
     auto& cachedPrograms = mCachedPrograms;
+
+    auto hasDefaultDepthVariant = [pDefaultMaterial = engine.getDefaultMaterial()](Variant k) {
+        auto const& end = pDefaultMaterial->mDepthVariants.end();
+        return end != std::find(pDefaultMaterial->mDepthVariants.begin(), end, k);
+    };
+
     for (size_t k = 0, n = VARIANT_COUNT; k < n; ++k) {
         const Variant variant(k);
         if (!mIsDefaultMaterial) {
             // The depth variants may be shared with the default material, in which case
             // we should not free it now.
-            bool const isSharedVariant = Variant::isValidDepthVariant(variant) && !mHasCustomDepthShader;
+            bool const isSharedVariant = Variant::isValidDepthVariant(variant) &&
+                                         !mHasCustomDepthShader && hasDefaultDepthVariant(variant);
             if (isSharedVariant) {
                 // we don't own this variant, skip.
                 continue;

ios/CocoaPods/Filament.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |spec|
   spec.name = "Filament"
-  spec.version = "1.56.2"
+  spec.version = "1.56.0"
   spec.license = { :type => "Apache 2.0", :file => "LICENSE" }
   spec.homepage = "https://google.github.io/filament"
   spec.authors = "Google LLC."
   spec.summary = "Filament is a real-time physically based rendering engine for Android, iOS, Windows, Linux, macOS, and WASM/WebGL."
   spec.platform = :ios, "11.0"
-  spec.source = { :http => "https://github.com/google/filament/releases/download/v1.56.2/filament-v1.56.2-ios.tgz" }
+  spec.source = { :http => "https://github.com/google/filament/releases/download/v1.56.0/filament-v1.56.0-ios.tgz" }
 
   # Fix linking error with Xcode 12; we do not yet support the simulator on Apple silicon.
   spec.pod_target_xcconfig = {

libs/filabridge/include/filament/MaterialEnums.h

@@ -28,7 +28,7 @@
 namespace filament {
 
 // update this when a new version of filament wouldn't work with older materials
-static constexpr size_t MATERIAL_VERSION = 56;
+static constexpr size_t MATERIAL_VERSION = 55;
 
 /**
  * Supported shading models

web/filament-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "filament",
-  "version": "1.56.2",
+  "version": "1.56.0",
   "description": "Real-time physically based rendering engine",
   "main": "filament.js",
   "module": "filament.js",