Merge branch 'rc/1.28.0' into release

The VulkanProgram constructor was bailing out early and emitting a
warning because it saw that one of the stages wasn't fulfilled.
However it's okay for a pipeline to be missing a compute program.

Fixes regression that started with fabba73b1.

README.md

@@ -31,7 +31,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.google.android.filament:filament-android:1.27.2'
+    implementation 'com.google.android.filament:filament-android:1.28.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:
 
 ```
-pod 'Filament', '~> 1.27.2'
+pod 'Filament', '~> 1.28.0'
 ```
 
 ### Snapshots

RELEASE_NOTES.md

@@ -13,6 +13,7 @@ A new header is inserted each time a *tag* is created.
 - Metal: newer devices are no longer limited to 16 samplers per Material.
 - gltfio: fix interpretation of occlusion strength
 - engine: minsdk is now 21 instead of 19. This allows the use of OpenGL ES 3.1
+- Vulkan: fix black screen regression
 
 ## v1.27.2
 

android/gradle.properties

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

android/samples/sample-gltf-viewer/src/main/java/com/google/android/filament/gltf/MainActivity.kt

@@ -417,7 +417,7 @@ class MainActivity : Activity() {
 
     // Just for testing purposes, this releases the current model and reloads the default model.
     inner class DoubleTapListener : GestureDetector.SimpleOnGestureListener() {
-        override fun onDoubleTap(e: MotionEvent?): Boolean {
+        override fun onDoubleTap(e: MotionEvent): Boolean {
             modelViewer.destroyModel()
             createDefaultRenderables()
             return super.onDoubleTap(e)

filament/backend/src/metal/MetalHandles.h

@@ -279,24 +279,20 @@ public:
 
     // Encode a MTLTexture into this SamplerGroup at the given index.
     inline void setFinalizedTexture(size_t index, id<MTLTexture> t) {
-        assert_invariant(encoder);
         assert_invariant(!finalized);
-        [encoder setTexture:t atIndex:(index * 2 + 0)];
         textures[index] = t;
     }
 
     // Encode a MTLSamplerState into this SamplerGroup at the given index.
     inline void setFinalizedSampler(size_t index, id<MTLSamplerState> s) {
-        assert_invariant(encoder);
         assert_invariant(!finalized);
-        [encoder setSamplerState:s atIndex:(index * 2 + 1)];
         samplers[index] = s;
     }
 
     // A SamplerGroup is "finalized" when all of its textures have been set and is ready for use in
     // a draw call.
     // Once a SamplerGroup is finalized, it must be reset or mutated to be written into again.
-    void finalize() { finalized = true; }
+    void finalize();
     bool isFinalized() const noexcept { return finalized; }
 
     // Both of these methods "unfinalize" a SamplerGroup, allowing it to be updated via calls to

filament/backend/src/metal/MetalHandles.mm

@@ -802,6 +802,24 @@ void MetalTexture::updateLodRange(uint32_t min, uint32_t max) {
     lodTextureView = nil;
 }
 
+void MetalSamplerGroup::finalize() {
+    assert_invariant(encoder);
+    // TODO: we should be able to encode textures and samplers inside setFinalizedTexture and
+    // setFinalizedSampler as they become available, but Metal doesn't seem to like this; the arg
+    // buffer gets encoded incorrectly. This warrants more investigation.
+
+    auto [buffer, offset] = argBuffer->getCurrentAllocation();
+    [encoder setArgumentBuffer:buffer offset:offset];
+
+    // Encode all textures and samplers.
+    for (size_t s = 0; s < size; s++) {
+        [encoder setTexture:textures[s] atIndex:(s * 2 + 0)];
+        [encoder setSamplerState:samplers[s] atIndex:(s * 2 + 1)];
+    }
+
+    finalized = true;
+}
+
 void MetalSamplerGroup::reset(id<MTLCommandBuffer> cmdBuffer, id<MTLArgumentEncoder> e) {
     encoder = e;
 
@@ -826,9 +844,6 @@ void MetalSamplerGroup::reset(id<MTLCommandBuffer> cmdBuffer, id<MTLArgumentEnco
         argBuffer->createNewAllocation(cmdBuffer);
     }
 
-    auto [buffer, offset] = argBuffer->getCurrentAllocation();
-    [encoder setArgumentBuffer:buffer offset:offset];
-
     // Clear all textures and samplers.
     assert_invariant(textureHandles.size() == textures.size());
     assert_invariant(textures.size() == samplers.size());
@@ -844,15 +859,7 @@ void MetalSamplerGroup::reset(id<MTLCommandBuffer> cmdBuffer, id<MTLArgumentEnco
 void MetalSamplerGroup::mutate(id<MTLCommandBuffer> cmdBuffer) {
     assert_invariant(finalized);    // only makes sense to mutate if this sampler group is finalized
     assert_invariant(argBuffer);
-    auto [buffer, offset] = argBuffer->createNewAllocation(cmdBuffer);
-    [encoder setArgumentBuffer:buffer offset:offset];
-
-    // Re-encode all textures and samplers.
-    for (size_t s = 0; s < size; s++) {
-        [encoder setTexture:textures[s] atIndex:(s * 2 + 0)];
-        [encoder setSamplerState:samplers[s] atIndex:(s * 2 + 1)];
-    }
-
+    argBuffer->createNewAllocation(cmdBuffer);
     finalized = false;
 }
 

filament/backend/src/opengl/gl_headers.h

@@ -93,8 +93,11 @@
  */
 
 #if defined(GL_ES_VERSION_2_0)
+
 #ifdef GL_EXT_disjoint_timer_query
-#       define GL_TIME_ELAPSED              GL_TIME_ELAPSED_EXT
+#    ifndef GL_TIME_ELAPSED
+#        define GL_TIME_ELAPSED             GL_TIME_ELAPSED_EXT
+#    endif
 #endif
 
 #ifdef GL_EXT_clip_control
@@ -165,7 +168,12 @@
     #define GL_COMPUTE_SHADER                       0x91B9
 
     #define GL_TEXTURE_2D_MULTISAMPLE               0x9100
+
+// FIXME: The GL_TIME_ELAPSED define is used unconditionally in Filament, but
+// requires extension support.
+#ifndef GL_TIME_ELAPSED
     #define GL_TIME_ELAPSED                         0x88BF
+#endif
 
     #define GL_TEXTURE_BINDING_CUBE_MAP_ARRAY       0x900A
     #define GL_SAMPLER_CUBE_MAP_ARRAY               0x900C

filament/backend/src/vulkan/VulkanHandles.cpp

@@ -49,14 +49,10 @@ VulkanProgram::VulkanProgram(VulkanContext& context, const Program& builder) noe
         HwProgram(builder.getName()), context(context) {
     auto const& blobs = builder.getShadersSource();
     VkShaderModule* modules[2] = { &bundle.vertex, &bundle.fragment };
-    bool missing = false;
-    for (size_t i = 0; i < Program::SHADER_TYPE_COUNT; i++) {
+    // TODO: handle compute shaders.
+    for (size_t i = 0; i < 2; i++) {
         const auto& blob = blobs[i];
         VkShaderModule* module = modules[i];
-        if (blob.empty()) {
-            missing = true;
-            continue;
-        }
         VkShaderModuleCreateInfo moduleInfo = {};
         moduleInfo.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
         moduleInfo.codeSize = blob.size();
@@ -106,13 +102,6 @@ VulkanProgram::VulkanProgram(VulkanContext& context, const Program& builder) noe
         bundle.specializationInfos = pInfo;
     }
 
-    // Output a warning because it's okay to encounter empty blobs, but it's not okay to use
-    // this program handle in a draw call.
-    if (missing) {
-        utils::slog.w << "Missing SPIR-V shader: " << this->name.c_str() << utils::io::endl;
-        return;
-    }
-
     // Make a copy of the binding map
     samplerGroupInfo = builder.getSamplerGroupInfo();
     if constexpr (FILAMENT_VULKAN_VERBOSE) {

filament/backend/src/vulkan/VulkanPipelineCache.cpp

@@ -58,7 +58,9 @@ VulkanPipelineCache::getUsageFlags(uint16_t binding, ShaderStageFlags flags, Usa
     if (any(flags & ShaderStageFlags::FRAGMENT)) {
         src.set(MAX_SAMPLER_COUNT + binding);
     }
-    assert_invariant(!any(flags & ~(ShaderStageFlags::VERTEX | ShaderStageFlags::FRAGMENT)));
+    // TODO: add support for compute by extending SHADER_MODULE_COUNT and ensuring UsageFlags
+    // has 186 bits (MAX_SAMPLER_COUNT * 3)
+    // assert_invariant(!any(flags & ~(ShaderStageFlags::VERTEX | ShaderStageFlags::FRAGMENT)));
     return src;
 }
 

filament/src/ShadowMap.cpp

@@ -882,8 +882,10 @@ size_t ShadowMap::intersectFrustumWithBox(
             vertexCount = intersectFrustum(outVertices.data(), vertexCount,
                     wsFrustumCorners, wsSceneReceiversCorners.vertices);
         } else {
-            // by construction vertexCount must be 8 here
-            assert_invariant(vertexCount == 8);
+            // by construction vertexCount should be 8 here, but it can be more because
+            // step (b) above can classify a point as inside the frustum that isn't quite.
+            assert_invariant(vertexCount >= 8);
+            vertexCount = 8;
         }
     }
 

ios/CocoaPods/Filament.podspec

@@ -1,12 +1,12 @@
 Pod::Spec.new do |spec|
   spec.name = "Filament"
-  spec.version = "1.27.2"
+  spec.version = "1.28.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.27.2/filament-v1.27.2-ios.tgz" }
+  spec.source = { :http => "https://github.com/google/filament/releases/download/v1.28.0/filament-v1.28.0-ios.tgz" }
 
   # Fix linking error with Xcode 12; we do not yet support the simulator on Apple silicon.
   spec.pod_target_xcconfig = {

web/filament-js/package.json

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