Merge branch 'main' into kpiascik/shadowtestassert

A zero color target fragment stage implies a depth pass by Filament.
We can create a pipeline without a fragment stage to make it valid.

BUGS=[421933134]

.github/workflows/postsubmit.yml

@@ -23,7 +23,7 @@ jobs:
           GH_TOKEN: ${{ secrets.FILAMENTBOT_TOKEN }}
         run: |
           GOLDEN_BRANCH=$(echo "${{ steps.get_commit_msg.outputs.msg }}" | python3 test/renderdiff/src/commit_msg.py)
-          COMMIT_HASH=$(echo "${{ steps.get_commit_msg.outputs.msg }}" | head -n 1 | sed "s/commit //g")
+          COMMIT_HASH=$(echo "${{ steps.get_commit_msg.outputs.msg }}" | head -n 1 | tr -d 'commit ')
           if [[ "${GOLDEN_BRANCH}" != "main" ]]; then
               git config --global user.email "filament.bot@gmail.com"
               git config --global user.name "Filament Bot"
@@ -33,25 +33,3 @@ jobs:
               python3 test/renderdiff/src/update_golden.py --branch=${GOLDEN_BRANCH} \
                   --merge-to-main --filament-tag=${COMMIT_HASH} --golden-repo-token=${GH_TOKEN}
           fi
-
-  update-docs:
-    name: update-docs
-    runs-on: 'ubuntu-24.04-4core'
-    steps:
-      - uses: actions/checkout@v4.1.6
-        with:
-          fetch-depth: 0
-      - uses: ./.github/actions/linux-prereq
-      - id: get_commit_msg
-        uses: ./.github/actions/get-commit-msg
-      - name: Prerequisites
-        run: pip install selenium
-      - name: Run update script
-        env:
-          GH_TOKEN: ${{ secrets.FILAMENTBOT_TOKEN }}
-        run: |
-          COMMIT_HASH=$(echo "${{ steps.get_commit_msg.outputs.msg }}" | head -n 1 | sed "s/commit //g")
-          git config --global user.email "filament.bot@gmail.com"
-          git config --global user.name "Filament Bot"
-          git config --global credential.helper cache
-          bash docs_src/build/postsubmit.sh ${COMMIT_HASH} ${GH_TOKEN}

.github/workflows/presubmit.yml

@@ -130,30 +130,13 @@ jobs:
         run: |
           bash build/common/get-mesa.sh
           pip install tifffile numpy
-      - name: Render
+      - name: Run Test
         run: |
-          TEST_DIR=test/renderdiff
-          source ${TEST_DIR}/src/preamble.sh
-          start_
-          GOLDEN_BRANCH=$(echo "${{ steps.get_commit_msg.outputs.msg }}" | python3 ${TEST_DIR}/src/commit_msg.py)
-          bash ${TEST_DIR}/generate.sh && \
-              python3 ${TEST_DIR}/src/golden_manager.py \
-                  --branch=${GOLDEN_BRANCH} \
-                  --output=${GOLDEN_OUTPUT_DIR}
-          # Note that we need to upload the output even if comparison fails
+          echo "${{ steps.get_commit_msg.outputs.msg }}" | bash test/renderdiff/test.sh
       - uses: actions/upload-artifact@v4
         with:
           name: presubmit-renderdiff-result
           path: ./out/renderdiff
-      - name: Compare output
-        run: |
-          TEST_DIR=test/renderdiff
-          source ${TEST_DIR}/src/preamble.sh
-          python3 ${TEST_DIR}/src/compare.py \
-              --src=${GOLDEN_OUTPUT_DIR} \
-              --dest=${RENDER_OUTPUT_DIR} \
-              --out=${DIFF_OUTPUT_DIR}
-          end_
 
   validate-wgsl-webgpu:
     name: validate-wgsl-webgpu
@@ -188,17 +171,3 @@ jobs:
           ./build.sh -p desktop debug gltf_viewer
       - name: Run test
         run: bash test/code-correctness/test.sh
-
-  test-mdbook:
-    name: test-mdbook
-    runs-on: 'ubuntu-24.04-4core'
-    steps:
-      - uses: actions/checkout@v4.1.6
-        with:
-          fetch-depth: 0
-      - uses: ./.github/actions/linux-prereq
-      - name: Run build script
-        run: |
-          bash docs_src/build/install_mdbook.sh && source ~/.bashrc
-          mdbook --version
-

CMakeLists.txt

@@ -41,8 +41,6 @@ option(FILAMENT_ENABLE_ASAN_UBSAN "Enable Address and Undefined Behavior Sanitiz
 
 option(FILAMENT_ENABLE_TSAN "Enable Thread Sanitizer" OFF)
 
-option(FILAMENT_ENABLE_COVERAGE "Enable LLVM code coverage" OFF)
-
 option(FILAMENT_ENABLE_FEATURE_LEVEL_0 "Enable Feature Level 0" ON)
 
 option(FILAMENT_ENABLE_MULTIVIEW "Enable multiview for Filament" OFF)
@@ -462,10 +460,6 @@ if (NOT MSVC AND NOT WEBGL)
 endif()
 set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} ${EXTRA_SANITIZE_OPTIONS}")
 
-if (FILAMENT_ENABLE_COVERAGE)
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -fprofile-instr-generate -fcoverage-mapping")
-endif()
-
 # Disable the stack check for macOS to workaround a known issue in clang 11.0.0.
 # See: https://forums.developer.apple.com/thread/121887
 if (APPLE)
@@ -792,7 +786,6 @@ add_subdirectory(${LIBRARIES}/filabridge)
 add_subdirectory(${LIBRARIES}/filaflat)
 add_subdirectory(${LIBRARIES}/filagui)
 add_subdirectory(${LIBRARIES}/filameshio)
-add_subdirectory(${LIBRARIES}/generatePrefilterMipmap)
 add_subdirectory(${LIBRARIES}/gltfio)
 add_subdirectory(${LIBRARIES}/ibl)
 add_subdirectory(${LIBRARIES}/iblprefilter)

README.md

@@ -31,7 +31,7 @@ repositories {
 }
 
 dependencies {
-    implementation 'com.google.android.filament:filament-android:1.62.1'
+    implementation 'com.google.android.filament:filament-android:1.62.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.62.1'
+pod 'Filament', '~> 1.62.0'
 ```
 
 ## Documentation

RELEASE_NOTES.md

@@ -7,11 +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.62.2
-
-- Metal: fix, respect alpha to coverage rasterization
-- engine: removed `Texture::generatePrefilterMipmap`, a new `libfilament-generatePrefilterMipmap` library can be used in its stead [⚠️ **API BREAKAGE**]
-
 ## v1.62.1
 
 - Add new shader define `VARIANT_DEPTH`, defined when a material is compiled for depth variants

android/filament-android/CMakeLists.txt

@@ -13,10 +13,6 @@ add_library(filament STATIC IMPORTED)
 set_target_properties(filament PROPERTIES IMPORTED_LOCATION
         ${FILAMENT_DIR}/lib/${ANDROID_ABI}/libfilament.a)
 
-add_library(filament-generatePrefilterMipmap STATIC IMPORTED)
-set_target_properties(filament-generatePrefilterMipmap PROPERTIES IMPORTED_LOCATION
-        ${FILAMENT_DIR}/lib/${ANDROID_ABI}/libfilament-generatePrefilterMipmap.a)
-
 add_library(backend STATIC IMPORTED)
 set_target_properties(backend PROPERTIES IMPORTED_LOCATION
         ${FILAMENT_DIR}/lib/${ANDROID_ABI}/libbackend.a)
@@ -124,7 +120,6 @@ add_library(filament-jni SHARED
 
 # Ordering is significant in the following list. The PRIVATE qualifier prevents transitive deps.
 target_link_libraries(filament-jni
-    PRIVATE filament-generatePrefilterMipmap
     PRIVATE filament
     PRIVATE backend
     PRIVATE filaflat

android/filament-android/src/main/cpp/Texture.cpp

@@ -23,20 +23,16 @@
 #include <android/bitmap.h>
 #endif
 
+#include <backend/BufferDescriptor.h>
 #include <filament/Engine.h>
 #include <filament/Stream.h>
 #include <filament/Texture.h>
 
-#include <filament-generatePrefilterMipmap/generatePrefilterMipmap.h>
-
-#include <backend/BufferDescriptor.h>
-
 #include "common/CallbackUtils.h"
 #include "common/NioUtils.h"
 
 #include "private/backend/VirtualMachineEnv.h"
 
-
 using namespace filament;
 using namespace backend;
 
@@ -425,7 +421,7 @@ Java_com_google_android_filament_Texture_nGeneratePrefilterMipmap(JNIEnv *env, j
     Engine *engine = (Engine *) nativeEngine;
 
     jint *faceOffsetsInBytes = env->GetIntArrayElements(faceOffsetsInBytes_, nullptr);
-    filament::FaceOffsets faceOffsets;
+    Texture::FaceOffsets faceOffsets;
     std::copy_n(faceOffsetsInBytes, 6, faceOffsets.offsets);
     env->ReleaseIntArrayElements(faceOffsetsInBytes_, faceOffsetsInBytes, JNI_ABORT);
 
@@ -448,11 +444,10 @@ Java_com_google_android_filament_Texture_nGeneratePrefilterMipmap(JNIEnv *env, j
             (uint32_t) left, (uint32_t) top, (uint32_t) stride,
             callback->getHandler(), &JniBufferCallback::postToJavaAndDestroy, callback);
 
-    filament::PrefilterOptions options;
+    Texture::PrefilterOptions options;
     options.sampleCount = sampleCount;
     options.mirror = mirror;
-
-    filament::generatePrefilterMipmap(texture, *engine, std::move(desc), faceOffsets, &options);
+    texture->generatePrefilterMipmap(*engine, std::move(desc), faceOffsets, &options);
 
     return 0;
 }

android/filament-android/src/main/java/com/google/android/filament/View.java

@@ -1390,8 +1390,8 @@ public class View {
      *
      * \note
      * Dynamic resolution is only supported on platforms where the time to render
-     * a frame can be measured accurately. On platform where this is not supported,
-     * Dynamic Resolution can't be enabled unless minScale == maxScale.
+     * a frame can be measured accurately. Dynamic resolution is currently only
+     * supported on Android.
      *
      * @see Renderer::FrameRateOptions
      *

android/gradle.properties

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

build.sh

@@ -63,9 +63,6 @@ function print_help {
     echo "    -b"
     echo "        Enable Address and Undefined Behavior Sanitizers (asan/ubsan) for debugging."
     echo "        This is only for the desktop build."
-    echo "    -V"
-    echo "        Enable LLVM code coverage for debug builds."
-    echo "        This is only for the desktop build."
     echo "    -x value"
     echo "        Define a preprocessor flag FILAMENT_BACKEND_DEBUG_FLAG with [value]. This is useful for"
     echo "        enabling debug paths in the backend from the build script. For example, make a"
@@ -211,7 +208,6 @@ MATOPT_OPTION=""
 MATOPT_GRADLE_OPTION=""
 
 ASAN_UBSAN_OPTION=""
-COVERAGE_OPTION=""
 
 BACKEND_DEBUG_FLAG_OPTION=""
 
@@ -279,7 +275,6 @@ function build_desktop_target {
             ${MATDBG_OPTION} \
             ${MATOPT_OPTION} \
             ${ASAN_UBSAN_OPTION} \
-            ${COVERAGE_OPTION} \
             ${BACKEND_DEBUG_FLAG_OPTION} \
             ${STEREOSCOPIC_OPTION} \
             ${OSMESA_OPTION} \
@@ -840,7 +835,7 @@ function check_debug_release_build {
 
 pushd "$(dirname "$0")" > /dev/null
 
-while getopts ":hacCfgimp:q:uvWslwedtk:bVx:S:X:" opt; do
+while getopts ":hacCfgimp:q:uvWslwedtk:bx:S:X:" opt; do
     case ${opt} in
         h)
             print_help
@@ -988,9 +983,6 @@ while getopts ":hacCfgimp:q:uvWslwedtk:bVx:S:X:" opt; do
         b)  ASAN_UBSAN_OPTION="-DFILAMENT_ENABLE_ASAN_UBSAN=ON"
             echo "Enabled ASAN/UBSAN"
             ;;
-        V)  COVERAGE_OPTION="-DFILAMENT_ENABLE_COVERAGE=ON"
-            echo "Enabled coverage"
-            ;;
         x)  BACKEND_DEBUG_FLAG_OPTION="-DFILAMENT_BACKEND_DEBUG_FLAG=${OPTARG}"
             ;;
         S)  case $(echo "${OPTARG}" | tr '[:upper:]' '[:lower:]') in

build/common/get-mesa.sh

@@ -77,20 +77,16 @@ if [[ "$OS_NAME" == "Linux" ]]; then
             sudo ln -s /usr/bin/clang++-${CLANG_VERSION} /usr/bin/clang++
     fi # [[ "$GITHUB_WORKFLOW" ]]
 elif [[ "$OS_NAME" == "Darwin" ]]; then
-    if command -v brew > /dev/null 2>&1; then
-        HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=true brew install autoconf automake libx11 libxext libxrandr \
-                                                        llvm@${LLVM_VERSION} ninja meson pkg-config libxshmfence
-        # For reasons unknown, this is necessary for pkg-config to find homebrew's packages
-        LOCAL_PKG_CONFIG_PATH="/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH"
-    elif command -v port > /dev/null 2>&1; then
-        sudo port install autoconf automake libx11 libXext libXrandr llvm-${LLVM_VERSION} \
-             ninja meson pkgconfig libxshmfence
-        # For reasons unknown, this is necessary for pkg-config to find macport's packages
-        LOCAL_PKG_CONFIG_PATH="/opt/local/lib/pkgconfig:$PKG_CONFIG_PATH"
-    else
-        echo "Error: need to install homebrew or macports to continue"
-        exit 1
+    if [[ ! "$GITHUB_WORKFLOW" ]]; then
+        if [ ! command -v brew > /dev/null 2>&1 ]; then
+            echo "Error: need to install homebrew to continue"
+            exit 1
+        fi
     fi
+    HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=true brew install autoconf automake libx11 libxext libxrandr llvm@${LLVM_VERSION} ninja meson pkg-config libxshmfence
+
+    # For reasons unknown, this is necessary for pkg-config to find homebrew's packages
+    LOCAL_PKG_CONFIG_PATH="/opt/homebrew/lib/pkgconfig:$PKG_CONFIG_PATH"
 fi # [[ "$OS_NAME" == x ]]
 
 LOCAL_LDFLAGS=${LDFLAGS}

docs_src/.gitignore

@@ -1,5 +1,2 @@
-build/__pycache__
-src_mdbook/book
-src_mdbook/src/dup/*.md
-src_mdbook/src/main/filament.md
-src_mdbook/src/main/materials.md
+book
+src/dup/*.md

docs_src/book.toml

@@ -10,8 +10,8 @@ create-missing = false
 
 [output.html]
 mathjax-support = true
-default-theme = "ayu"
-preferred-dark-theme = "ayu"
+default-theme = "light"
+preferred-dark-theme = "light"
 
 [output.html.print]
 enable = false

docs_src/build/checks.py

@@ -30,23 +30,16 @@ from utils import execute, ArgParseImpl
 CUR_DIR = os.path.dirname(os.path.abspath(__file__))
 ROOT_DIR = os.path.join(CUR_DIR, '../../')
 
-DOCS_SRC_DIR = os.path.abspath(os.path.join(CUR_DIR, '../'))
-MARKDEEP_SRC_DIR = os.path.join(DOCS_SRC_DIR, 'src_markdeep')
-MDBOOK_SRC_DIR = os.path.join(DOCS_SRC_DIR, 'src_mdbook')
-RAW_SRC_DIR = os.path.join(DOCS_SRC_DIR, 'src_raw')
-
-SRC_SRC_DIRS = [MARKDEEP_SRC_DIR, MDBOOK_SRC_DIR, RAW_SRC_DIR]
-
 def get_edited_files(commit_hash):
   INSERT = '#####?????'
   res, ret = execute(f'git show --name-only --pretty=%b{INSERT} {commit_hash}')
-  assert res == 0, f'Failed to get edited filed {res}: ' + ret
+  assert res == 0, 'Failed to get edited filed'
   files = []
   _, after = ret.split(INSERT)
   for r in filter(lambda a: len(a) > 0, after.split('\n')):
     if r.startswith('commit'):
       break
-    files.append(os.path.abspath(os.path.join(ROOT_DIR, r)))
+    files.append(r)
   return files
 
 # Returns True if there were no direct edits to '/docs'
@@ -61,19 +54,12 @@ def check_has_source_edits(commit_hash, printing=True):
   config = {}
   with open(f'{CUR_DIR}/duplicates.json') as config_txt:
     config = json.loads(config_txt.read())
-  source_files = set(os.path.abspath(os.path.join(ROOT_DIR, k)) for k in config.keys())
+  source_files = set(config.keys())
   edited_files = set(get_edited_files(commit_hash))
-
-  # find any changes to docs_src sources
-  is_docs_src_edit = lambda f: any(f.startswith(prefix) for prefix in SRC_SRC_DIRS)
-
-  final_edited = [f'\t{f}' for f in \
-                  list(source_files & edited_files) + \
-                  list(filter(is_docs_src_edit, edited_files))]
-
-  if printing and len(final_edited) > 0:
-    print(f'Found edited source files:\n' + '\n'.join(final_edited))
-  return len(final_edited) > 0
+  overlap = [f'\t{f}' for f in list(source_files & edited_files)]
+  if printing and len(overlap) > 0:
+    print(f'Found edited source files:\n' + '\n'.join(overlap))
+  return len(overlap) > 0
 
 # Returns true in a given TAG is found in the commit msg
 def commit_msg_has_tag(commit_hash, tag, printing=True):

docs_src/build/install_mdbook.sh

@@ -21,7 +21,7 @@ LINUX_ARM=4
 
 function add_cargo_path() {
     local BASH_P="${HOME}/.bashrc"
-    local PATH_LINE='export PATH=${PATH}:${HOME}/.cargo/bin'
+    local PATH_LINE='export PATH=${PATH}:~/.cargo/bin'
     local TYPE=$1
     if [ ${TYPE} == ${DARWIN_ARM} ] || [ ${TYPE} == ${DARWIN_X86} ]; then
         BASH_P="${HOME}/.bash_profile"
@@ -77,10 +77,10 @@ print(get_type())
         if [ ${TYPE} == ${LINUX_X86} ]; then
             DL_URL='https://github.com/rust-lang/mdBook/releases/download/v0.4.43/mdbook-v0.4.43-x86_64-unknown-linux-gnu.tar.gz'
         fi
-        curl -L -o /tmp/mdbook.tar.gz ${DL_URL}
+        curl -L -o ~/Downloads/mdbook.tar.gz ${DL_URL}
         mkdir -p /tmp/mdbook
-        tar -xvzf /tmp/mdbook.tar.gz -C /tmp/mdbook >/dev/null 2>&1
-        mv /tmp/mdbook/mdbook ${HOME}/.cargo/bin/
+        tar -xvzf ~/Downloads/mdbook.tar.gz -C /tmp/mdbook >/dev/null 2>&1
+        mv /tmp/mdbook/mdbook ~/.cargo/bin/
     fi
     add_cargo_path ${TYPE}
 }

docs_src/build/postsubmit.sh

@@ -1,51 +0,0 @@
-#!/usr/bin/bash
-
-# Copyright (C) 2025 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.
-
-FILAMENT_BOT_TOKEN=$2
-
-function update_to_main() {
-    python3 docs_src/build/run.py
-    mkdir -p tmp
-    pushd .
-    cd tmp
-    git clone https://x-access-token:${FILAMENT_BOT_TOKEN}@github.com/google/filament.git
-    cd filament
-    rm -rf docs/*
-    cp -r ../../docs_src/src_mdbook/book/* docs
-    git add -A docs/*
-    git commit -a \
-        -m "[automated] Updating /docs due to commit ${COMMIT_HASH:0:7}" \
-        -m "" \
-        -m "Full commit hash is ${COMMIT_HASH}" \
-        -m "" \
-        -m "DOCS_ALLOW_DIRECT_EDITS"
-
-    git push origin main
-    popd
-}
-
-COMMIT_HASH=$1
-HAS_EDITS=$((python3 docs_src/build/checks.py --do-or="source_edits,commit_docs_force" $COMMIT_HASH > /dev/null && echo "true") || echo "false")
-DO_BYPASS=$((python3 docs_src/build/checks.py --do-and="commit_docs_bypass" $COMMIT_HASH && echo "true") || echo "false")
-
-if [[ "${HAS_EDITS}" == "true" && "${DO_BYPASS}" == "false" ]]; then
-    # Run again to output the edited files:
-    python3 docs_src/build/checks.py --do-or="source_edits,commit_docs_force" $COMMIT_HASH
-    update_to_main
-else
-    echo "has edits (to /docs_src): ${HAS_EDITS}"
-    echo "bypass: ${DO_BYPASS}"
-fi

docs_src/build/run.py

@@ -16,18 +16,12 @@ import json
 import os
 import re
 from utils import execute, ArgParseImpl
-import shutil
 
 CUR_DIR = os.path.dirname(os.path.abspath(__file__))
 DOCS_SRC_DIR = os.path.join(CUR_DIR, '../')
 ROOT_DIR = os.path.join(CUR_DIR, '../../')
-
-MDBOOK_DIR = os.path.join(CUR_DIR, '../src_mdbook')
-BOOK_OUPUT_DIR = os.path.join(MDBOOK_DIR, 'book')
-SRC_DIR = os.path.join(MDBOOK_DIR, 'src')
-
-MARKDEEP_DIR = os.path.join(CUR_DIR, '../src_markdeep')
-RAW_COPIES_DIR = os.path.join(CUR_DIR, '../src_raw')
+SRC_DIR = os.path.join(CUR_DIR, '../src')
+MARKDEEP_DIR = os.path.join(CUR_DIR, '../markdeep')
 DUP_DIR = os.path.join(SRC_DIR, 'dup')
 MAIN_DIR = os.path.join(SRC_DIR, 'main')
 
@@ -130,7 +124,5 @@ if __name__ == "__main__":
   pull_duplicates()
   pull_markdeep_docs()
 
-  res, err = execute('mdbook build', cwd=MDBOOK_DIR)
+  res, err = execute('mdbook build', cwd=DOCS_SRC_DIR)
   assert res == 0, f"failed to execute `mdbook`. return-code={res} err=\"{err}\""
-
-  shutil.copytree(RAW_COPIES_DIR, BOOK_OUPUT_DIR, dirs_exist_ok=True)

docs_src/markdeep/Materials.md.html

@@ -1027,11 +1027,8 @@ samplerCubemap         | Cubemap texture
 [Table [materialParamsTypes]: Material parameter types]
 
 Samplers
-:     Sampler types can have the following fields:
-       - `format` : which can be either `int` or `float` (defaults to `float`).
-       - `multisample` : a boolean to indicate whether the sampler is meant for multisampling (defaults to `false`)
-       - `unfilterable` : a boolean to indicate whether the sampling is not filtered (defaults to `false`)
-
+:     Sampler types can also specify a `format` which can be either `int` or `float` (defaults to
+      `float`).
 
 Arrays
 :     A parameter can define an array of values by appending `[size]` after the type name, where