Fix Android samples so they handle surface resizes properly

google · Apr 21, 2023 · c24cc72 · c24cc72
1 parent 7b90a8f
commit c24cc72
Show file tree

Hide file tree

Showing 15 changed files with 99 additions and 3 deletions.
diff --git a/...id/filament-android/src/main/java/com/google/android/filament/android/FilamentHelper.java b/...id/filament-android/src/main/java/com/google/android/filament/android/FilamentHelper.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.filament.android;
+
+import com.google.android.filament.Engine;
+import com.google.android.filament.Fence;
+
+public class FilamentHelper {
+
+    /**
+     * Wait for all pending frames to be processed before returning. This is to
+     * avoid a race between the surface being resized before pending frames are
+     * rendered into it. This is typically called from {@link UiHelper.RendererCallback#onResized},
+     * {@link android.view.SurfaceHolder.Callback#surfaceChanged} or
+     * {@link android.view.TextureView.SurfaceTextureListener#onSurfaceTextureSizeChanged}.
+     *
+     * @param engine Filament engine to synchronize
+     *
+     * @see UiHelper.RendererCallback#onResized
+     * @see android.view.SurfaceHolder.Callback#surfaceChanged
+     * @see android.view.TextureView.SurfaceTextureListener#onSurfaceTextureSizeChanged
+     */
+    static public void synchronizePendingFrames(Engine engine) {
+        Fence fence = engine.createFence();
+        fence.wait(Fence.Mode.FLUSH, Fence.WAIT_FOR_EVER);
+        engine.destroyFence(fence);
+    }
+}
diff --git a/android/filament-android/src/main/java/com/google/android/filament/android/UiHelper.java b/android/filament-android/src/main/java/com/google/android/filament/android/UiHelper.java
@@ -84,6 +84,14 @@
  *             // The native surface has changed size. This is always called at least once
  *             // after the surface is created (after onNativeWindowChanged() is invoked).
  *             public void onResized(int width, int height) {
+ *
+ *                 // Wait for all pending frames to be processed before returning. This is to
+ *                 // avoid a race between the surface being resized before pending frames are
+ *                 // rendered into it.
+ *                 Fence fence = mEngine.createFence();
+ *                 fence.wait(Fence.Mode.FLUSH, Fence.WAIT_FOR_EVER);
+ *                 mEngine.destroyFence(fence);
+ *
  *                 // Compute camera projection and set the viewport on the view
  *             }
  *         });
@@ -175,7 +183,7 @@ private interface RenderSurface {
     }
 
     private static class SurfaceViewHandler implements RenderSurface {
-        private SurfaceView mSurfaceView;
+        private final SurfaceView mSurfaceView;
 
         SurfaceViewHandler(SurfaceView surface) {
             mSurfaceView = surface;
@@ -192,7 +200,7 @@ public void detach() {
     }
 
     private static class SurfaceHolderHandler implements RenderSurface {
-        private SurfaceHolder mSurfaceHolder;
+        private final SurfaceHolder mSurfaceHolder;
 
         SurfaceHolderHandler(SurfaceHolder surface) {
             mSurfaceHolder = surface;
@@ -209,7 +217,7 @@ public void detach() {
     }
 
     private class TextureViewHandler implements RenderSurface {
-        private TextureView mTextureView;
+        private final TextureView mTextureView;
         private Surface mSurface;
 
         TextureViewHandler(TextureView surface) { mTextureView = surface; }

diff --git a/...oid/filament-utils-android/src/main/java/com/google/android/filament/utils/ModelViewer.kt b/...oid/filament-utils-android/src/main/java/com/google/android/filament/utils/ModelViewer.kt
@@ -405,9 +405,19 @@ class ModelViewer(
             view.viewport = Viewport(0, 0, width, height)
             cameraManipulator.setViewport(width, height)
             updateCameraProjection()
+            synchronizePendingFrames(engine)
         }
     }
 
+    private fun synchronizePendingFrames(engine: Engine) {
+        // Wait for all pending frames to be processed before returning. This is to
+        // avoid a race between the surface being resized before pending frames are
+        // rendered into it.
+        val fence = engine.createFence()
+        fence.wait(Fence.Mode.FLUSH, Fence.WAIT_FOR_EVER)
+        engine.destroyFence(fence)
+    }
+
     companion object {
         private val kDefaultObjectPosition = Float3(0.0f, 0.0f, -4.0f)
     }

diff --git a/...es/sample-hello-camera/src/main/java/com/google/android/filament/hellocam/MainActivity.kt b/...es/sample-hello-camera/src/main/java/com/google/android/filament/hellocam/MainActivity.kt
@@ -30,6 +30,7 @@ import com.google.android.filament.*
 import com.google.android.filament.RenderableManager.*
 import com.google.android.filament.VertexBuffer.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 
 import java.nio.ByteBuffer
@@ -401,6 +402,8 @@ class MainActivity : Activity(), ActivityCompat.OnRequestPermissionsResultCallba
             camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...le-hello-triangle/src/main/java/com/google/android/filament/hellotriangle/MainActivity.kt b/...le-hello-triangle/src/main/java/com/google/android/filament/hellotriangle/MainActivity.kt
@@ -29,6 +29,7 @@ import com.google.android.filament.RenderableManager.PrimitiveType
 import com.google.android.filament.VertexBuffer.AttributeType
 import com.google.android.filament.VertexBuffer.VertexAttribute
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 import java.nio.ByteBuffer
 import java.nio.ByteOrder
@@ -327,6 +328,8 @@ class MainActivity : Activity() {
                     -aspect * zoom, aspect * zoom, -zoom, zoom, 0.0, 10.0)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...sample-image-based-lighting/src/main/java/com/google/android/filament/ibl/MainActivity.kt b/...sample-image-based-lighting/src/main/java/com/google/android/filament/ibl/MainActivity.kt
@@ -26,6 +26,7 @@ import android.view.animation.LinearInterpolator
 
 import com.google.android.filament.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 
 import java.nio.ByteBuffer
@@ -303,6 +304,8 @@ class MainActivity : Activity() {
             camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...samples/sample-lit-cube/src/main/java/com/google/android/filament/litcube/MainActivity.kt b/...samples/sample-lit-cube/src/main/java/com/google/android/filament/litcube/MainActivity.kt
@@ -29,6 +29,7 @@ import com.google.android.filament.*
 import com.google.android.filament.RenderableManager.*
 import com.google.android.filament.VertexBuffer.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 
 import java.nio.ByteBuffer
@@ -413,6 +414,8 @@ class MainActivity : Activity() {
             camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...ample-live-wallpaper/src/main/java/com/google/android/filament/livewallpaper/Wallpaper.kt b/...ample-live-wallpaper/src/main/java/com/google/android/filament/livewallpaper/Wallpaper.kt
@@ -31,6 +31,7 @@ import android.view.animation.LinearInterpolator
 import androidx.annotation.RequiresApi
 import com.google.android.filament.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 
 class FilamentLiveWallpaper : WallpaperService() {
@@ -226,6 +227,8 @@ class FilamentLiveWallpaper : WallpaperService() {
                 camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
                 view.viewport = Viewport(0, 0, width, height)
+
+                FilamentHelper.synchronizePendingFrames(engine)
             }
         }
     }

diff --git a/...terial-builder/src/main/java/com/google/android/filament/material_builder/MainActivity.kt b/...terial-builder/src/main/java/com/google/android/filament/material_builder/MainActivity.kt
@@ -26,6 +26,7 @@ import android.view.animation.LinearInterpolator
 
 import com.google.android.filament.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 import com.google.android.filament.filamat.MaterialBuilder
 
@@ -343,6 +344,8 @@ class MainActivity : Activity() {
             camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 }
diff --git a/...les/sample-multi-view/src/main/java/com/google/android/filament/multiview/MainActivity.kt b/...les/sample-multi-view/src/main/java/com/google/android/filament/multiview/MainActivity.kt
@@ -30,6 +30,7 @@ import com.google.android.filament.RenderableManager.*
 import com.google.android.filament.Renderer.ClearOptions
 import com.google.android.filament.VertexBuffer.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 
 import java.nio.ByteBuffer
@@ -458,6 +459,8 @@ class MainActivity : Activity() {
             view1.viewport = Viewport(width / 2, 0,          width / 2, height / 2)
             view2.viewport = Viewport(0,         height / 2, width / 2, height / 2)
             view4.viewport = Viewport(width / 4, height / 4, width / 2, height / 2)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...les/sample-page-curl/src/main/java/com/google/android/filament/pagecurl/MainActivity.java b/...les/sample-page-curl/src/main/java/com/google/android/filament/pagecurl/MainActivity.java
@@ -37,6 +37,7 @@
 import com.google.android.filament.Engine;
 import com.google.android.filament.Entity;
 import com.google.android.filament.EntityManager;
+import com.google.android.filament.Fence;
 import com.google.android.filament.Filament;
 import com.google.android.filament.IndirectLight;
 import com.google.android.filament.LightManager;
@@ -49,6 +50,7 @@
 import com.google.android.filament.Viewport;
 
 import com.google.android.filament.android.DisplayHelper;
+import com.google.android.filament.android.FilamentHelper;
 import com.google.android.filament.android.TextureHelper;
 import com.google.android.filament.android.UiHelper;
 
@@ -107,6 +109,7 @@ public void onResized(int width, int height) {
             mCamera.setProjection(60.0, aspect, 1.0, 2000.0, Camera.Fov.HORIZONTAL);
         }
         mView.setViewport(new Viewport(0, 0, width, height));
+        FilamentHelper.synchronizePendingFrames(mEngine);
     }
 
     @Override

diff --git a/...s/sample-stream-test/src/main/java/com/google/android/filament/streamtest/MainActivity.kt b/...s/sample-stream-test/src/main/java/com/google/android/filament/streamtest/MainActivity.kt
@@ -38,6 +38,7 @@ import android.os.Build
 import android.view.MotionEvent
 import androidx.annotation.RequiresApi
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 
 
 class MainActivity : Activity(), ActivityCompat.OnRequestPermissionsResultCallback {
@@ -401,6 +402,8 @@ class MainActivity : Activity(), ActivityCompat.OnRequestPermissionsResultCallba
             camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...sample-texture-view/src/main/java/com/google/android/filament/textureview/MainActivity.kt b/...sample-texture-view/src/main/java/com/google/android/filament/textureview/MainActivity.kt
@@ -29,6 +29,7 @@ import com.google.android.filament.RenderableManager.PrimitiveType
 import com.google.android.filament.VertexBuffer.AttributeType
 import com.google.android.filament.VertexBuffer.VertexAttribute
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 import java.nio.ByteBuffer
 import java.nio.ByteOrder
@@ -327,6 +328,8 @@ class MainActivity : Activity() {
                     -aspect * zoom, aspect * zoom, -zoom, zoom, 0.0, 10.0)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...sample-textured-object/src/main/java/com/google/android/filament/textured/MainActivity.kt b/...sample-textured-object/src/main/java/com/google/android/filament/textured/MainActivity.kt
@@ -26,6 +26,7 @@ import android.view.animation.LinearInterpolator
 
 import com.google.android.filament.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.utils.*
 import com.google.android.filament.android.UiHelper
 
@@ -323,6 +324,8 @@ class MainActivity : Activity() {
             camera.setProjection(45.0, aspect, 0.1, 20.0, Camera.Fov.VERTICAL)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }
 

diff --git a/...arent-view/src/main/java/com/google/android/filament/transparentrendering/MainActivity.kt b/...arent-view/src/main/java/com/google/android/filament/transparentrendering/MainActivity.kt
@@ -33,6 +33,7 @@ import com.google.android.filament.*
 import com.google.android.filament.RenderableManager.*
 import com.google.android.filament.VertexBuffer.*
 import com.google.android.filament.android.DisplayHelper
+import com.google.android.filament.android.FilamentHelper
 import com.google.android.filament.android.UiHelper
 
 import java.nio.ByteBuffer
@@ -350,6 +351,8 @@ class MainActivity : Activity() {
                     -aspect * zoom, aspect * zoom, -zoom, zoom, 0.0, 10.0)
 
             view.viewport = Viewport(0, 0, width, height)
+
+            FilamentHelper.synchronizePendingFrames(engine)
         }
     }