Update MATERIAL_VERSION to 70

The previous eviction time is too large (40), then causes memory
to bloat over time. We set the default to 3 (as in triple
buffering), but make it a configurable option via VulkanPlatform.

Fixes #9786

README.md

@@ -31,7 +31,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.google.android.filament:filament-android:1.70.0'
+    implementation 'com.google.android.filament:filament-android:1.70.1'
 }
 ```
 
@@ -50,7 +50,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.70.0'
+pod 'Filament', '~> 1.70.1'
 ```
 
 ## Documentation

android/gradle.properties

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

filament/backend/include/backend/platforms/VulkanPlatform.h

@@ -177,6 +177,12 @@ public:
          * presentation. Default is true.
          */
         bool transitionSwapChainImageLayoutForPresent = true;
+
+        /**
+         * The number of frames before an unused framebuffer is evicted from the cache.
+         * Default is 3.
+         */
+        uint32_t timeBeforeEvictionFbo = 3;
     };
 
     /**

filament/backend/src/vulkan/VulkanDriver.cpp

@@ -260,7 +260,8 @@ VulkanDriver::VulkanDriver(VulkanPlatform* platform, VulkanContext& context,
       mPipelineCache(*this, mPlatform->getDevice(), mContext),
       mStagePool(mAllocator, &mResourceManager, &mCommands, &mContext.getPhysicalDeviceLimits()),
       mBufferCache(mContext, mResourceManager, mAllocator),
-      mFramebufferCache(mPlatform->getDevice()),
+      mFramebufferCache(mPlatform->getDevice(),
+              mPlatform->getCustomization().timeBeforeEvictionFbo),
       mYcbcrConversionCache(mPlatform->getDevice()),
       mSamplerCache(mPlatform->getDevice()),
       mBlitter(mPlatform->getPhysicalDevice(), &mCommands),

filament/backend/src/vulkan/VulkanFboCache.cpp

@@ -20,6 +20,7 @@
 #include "VulkanHandles.h"
 #include "vulkan/utils/Image.h"
 
+#include <utils/compiler.h>
 #include <utils/Panic.h>
 
 // If any VkRenderPass or VkFramebuffer is unused for more than TIME_BEFORE_EVICTION frames, it
@@ -62,8 +63,9 @@ bool VulkanFboCache::FboKeyEqualFn::operator()(const FboKey& k1, const FboKey& k
     return true;
 }
 
-VulkanFboCache::VulkanFboCache(VkDevice device)
-    : mDevice(device) {}
+VulkanFboCache::VulkanFboCache(VkDevice device, uint32_t timeBeforeEvictionFbo)
+        : mDevice(device),
+          mTimeBeforeEvictionFbo(timeBeforeEvictionFbo) {}
 
 VulkanFboCache::~VulkanFboCache() {
     FILAMENT_CHECK_POSTCONDITION(mFramebufferCache.empty() && mRenderPassCache.empty())
@@ -376,31 +378,36 @@ void VulkanFboCache::gc() noexcept {
     FVK_SYSTRACE_START("fbocache::gc");
 
     // If this is one of the first few frames, return early to avoid wrapping unsigned integers.
-    if (++mCurrentTime <= TIME_BEFORE_EVICTION) {
-        return;
-    }
-    const uint32_t evictTime = mCurrentTime - TIME_BEFORE_EVICTION;
+    ++mCurrentTime;
 
-    for (FboMap::iterator iter = mFramebufferCache.begin(); iter != mFramebufferCache.end(); ) {
-        const FboVal fbo = iter->second;
-        if (fbo.timestamp < evictTime && fbo.handle) {
-            mRenderPassRefCount[iter->first.renderPass]--;
+    if (UTILS_UNLIKELY(mCurrentTime > mTimeBeforeEvictionFbo)) {
+        const uint32_t evictTimeFbo = mCurrentTime - mTimeBeforeEvictionFbo;
+        for (FboMap::iterator iter = mFramebufferCache.begin(); iter != mFramebufferCache.end();) {
+            const FboVal fbo = iter->second;
+            if (fbo.timestamp < evictTimeFbo && fbo.handle) {
+                mRenderPassRefCount[iter->first.renderPass]--;
 
-            // erase(iterator) returns the iterator to the next element.
-            iter = mFramebufferCache.erase(iter);
-        } else {
-            ++iter;
+                // erase(iterator) returns the iterator to the next element.
+                iter = mFramebufferCache.erase(iter);
+            } else {
+                ++iter;
+            }
         }
     }
 
-    for (RenderPassMap::iterator iter = mRenderPassCache.begin(); iter != mRenderPassCache.end(); ) {
-        const VkRenderPass handle = iter->second.handle->getVkRenderPass();
-        if (iter->second.timestamp < evictTime && handle && mRenderPassRefCount[handle] == 0) {
-            // erase(iterator) returns the iterator to the next element.
-            iter = mRenderPassCache.erase(iter);
-            mRenderPassRefCount.erase(handle);
-        } else {
-            ++iter;
+    if (UTILS_UNLIKELY(mCurrentTime > TIME_BEFORE_EVICTION)) {
+        const uint32_t evictTimeRp = mCurrentTime - TIME_BEFORE_EVICTION;
+        for (RenderPassMap::iterator iter = mRenderPassCache.begin();
+                iter != mRenderPassCache.end();) {
+            const VkRenderPass handle = iter->second.handle->getVkRenderPass();
+            if (iter->second.timestamp < evictTimeRp && handle &&
+                    mRenderPassRefCount[handle] == 0) {
+                // erase(iterator) returns the iterator to the next element.
+                iter = mRenderPassCache.erase(iter);
+                mRenderPassRefCount.erase(handle);
+            } else {
+                ++iter;
+            }
         }
     }
 

filament/backend/src/vulkan/VulkanFboCache.h

@@ -100,7 +100,7 @@ public:
         bool operator()(const FboKey& k1, const FboKey& k2) const;
     };
 
-    explicit VulkanFboCache(VkDevice device);
+    explicit VulkanFboCache(VkDevice device, uint32_t timeBeforeEvictionFbo);
     ~VulkanFboCache();
 
     // Retrieves or creates a VkFramebuffer handle.
@@ -130,6 +130,7 @@ private:
     RenderPassMap mRenderPassCache;
     tsl::robin_map<VkRenderPass, uint32_t> mRenderPassRefCount;
     uint32_t mCurrentTime = 0;
+    uint32_t mTimeBeforeEvictionFbo;
 };
 
 } // namespace filament::backend

ios/CocoaPods/Filament.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |spec|
   spec.name = "Filament"
-  spec.version = "1.70.0"
+  spec.version = "1.70.1"
   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.70.0/filament-v1.70.0-ios.tgz" }
+  spec.source = { :http => "https://github.com/google/filament/releases/download/v1.70.1/filament-v1.70.1-ios.tgz" }
 
   spec.libraries = 'c++'
 

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 = 69;
+static constexpr size_t MATERIAL_VERSION = 70;
 
 // Those are the api levels that are used in the source material file (.mat)
 //

web/filament-js/package.json

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