new LinearAllocatorWithFallback

LinearAllocatorWithFallback is a linear allocator that can fall back
to the heap allocator. We use it for the high level command buffer to
avoid crashing when running out of memory.

FIXES=[277115740]

.dir-locals.el

@@ -1,8 +1,7 @@
 ;;; Directory Local Variables            -*- no-byte-compile: t -*-
 ;;; For more information see (info "(emacs) Directory Variables")
 
-((c++-mode . ((eglot-ignored-server-capabilities . (:documentFormattingProvider))
-              (c-file-style . "filament")
+((c++-mode . ((c-file-style . "filament")
               (apheleia-inhibit . t)))
  (c-mode . ((c-file-style . "filament")
             (apheleia-inhibit . t))))

.github/workflows/android-continuous.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   build-android:
     name: build-android
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0

.github/workflows/cocopods-deploy.yml

@@ -13,7 +13,7 @@ on:
 jobs:
   cocoapods-deploy:
     name: cocoapods-deploy
-    runs-on: macos-latest
+    runs-on: macos-14
     steps:
       - name: Check out iOS/CocoaPods directory
         uses: Bhacaz/checkout-files@49fc3050859046bf4f4873678d46099985640e89

.github/workflows/ios-continuous.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   build-ios:
     name: build-ios
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0

.github/workflows/mac-continuous.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   build-mac:
     name: build-mac
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0

.github/workflows/npm-deploy.yml

@@ -11,7 +11,7 @@ on:
 jobs:
   npm-deploy:
     name: npm-deploy
-    runs-on: macos-latest
+    runs-on: macos-14
     steps:
       - uses: actions/checkout@v3.3.0
         with:

.github/workflows/presubmit.yml

@@ -15,7 +15,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-22.04]
+        os: [macos-14, ubuntu-22.04]
 
     steps:
       - uses: actions/checkout@v3.3.0
@@ -40,7 +40,7 @@ jobs:
 
   build-android:
     name: build-android
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0
@@ -54,7 +54,7 @@ jobs:
 
   build-ios:
     name: build-iOS
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0
@@ -67,7 +67,7 @@ jobs:
 
   build-web:
     name: build-web
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0

.github/workflows/release.yml

@@ -31,7 +31,7 @@ jobs:
 
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-22.04]
+        os: [macos-14, ubuntu-22.04]
 
     steps:
       - name: Decide Git ref
@@ -65,7 +65,7 @@ jobs:
 
   build-web:
     name: build-web
-    runs-on: macos-latest
+    runs-on: macos-14
     if: github.event_name == 'release' || github.event.inputs.platform == 'web'
 
     steps:
@@ -98,7 +98,7 @@ jobs:
 
   build-android:
     name: build-android
-    runs-on: macos-latest
+    runs-on: macos-14
     if: github.event_name == 'release' || github.event.inputs.platform == 'android'
 
     steps:
@@ -152,7 +152,7 @@ jobs:
 
   build-ios:
     name: build-ios
-    runs-on: macos-latest
+    runs-on: macos-14
     if: github.event_name == 'release' || github.event.inputs.platform == 'ios'
 
     steps:

.github/workflows/web-continuous.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   build-web:
     name: build-web
-    runs-on: macos-latest
+    runs-on: macos-14
 
     steps:
       - uses: actions/checkout@v3.3.0

CMakeLists.txt

@@ -706,7 +706,7 @@ function(get_resgen_vars ARCHIVE_DIR ARCHIVE_NAME)
         set(RESGEN_OUTPUTS "${OUTPUTS}" PARENT_SCOPE)
         set(RESGEN_FLAGS -qx ${ARCHIVE_DIR} -p ${ARCHIVE_NAME} PARENT_SCOPE)
         set(RESGEN_SOURCE "${ARCHIVE_DIR}/${ARCHIVE_NAME}${ASM_SUFFIX}.S" PARENT_SCOPE)
-        set(RESGEN_SOURCE_FLAGS "-I${ARCHIVE_DIR} ${ASM_ARCH_FLAG}" PARENT_SCOPE)
+        set(RESGEN_SOURCE_FLAGS "-I'${ARCHIVE_DIR}' ${ASM_ARCH_FLAG}" PARENT_SCOPE)
     endif()
 endfunction()
 
@@ -757,7 +757,6 @@ if (FILAMENT_BUILD_FILAMAT OR IS_HOST_PLATFORM)
     add_subdirectory(${EXTERNAL}/spirv-tools)
     add_subdirectory(${EXTERNAL}/glslang/tnt)
     add_subdirectory(${EXTERNAL}/spirv-cross/tnt)
-    add_subdirectory(${LIBRARIES}/astrict)
     add_subdirectory(${LIBRARIES}/filamat)
 
     # the material debugger requires filamat

README.md

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

RELEASE_NOTES.md

@@ -7,6 +7,12 @@ 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.50.3
+
+
+## v1.50.2
+
+
 ## v1.50.1
 
 - Metal: fix some shader artifacts by disabling fast math optimizations.

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

@@ -484,7 +484,8 @@ extern "C" JNIEXPORT void JNICALL Java_com_google_android_filament_Engine_nSetBu
 extern "C" JNIEXPORT void JNICALL Java_com_google_android_filament_Engine_nSetBuilderConfig(JNIEnv*,
         jclass, jlong nativeBuilder, jlong commandBufferSizeMB, jlong perRenderPassArenaSizeMB,
         jlong driverHandleArenaSizeMB, jlong minCommandBufferSizeMB, jlong perFrameCommandsSizeMB,
-        jlong jobSystemThreadCount, jlong stereoscopicEyeCount) {
+        jlong jobSystemThreadCount, jlong stereoscopicEyeCount,
+        jlong resourceAllocatorCacheSizeMB, jlong resourceAllocatorCacheMaxAge) {
     Engine::Builder* builder = (Engine::Builder*) nativeBuilder;
     Engine::Config config = {
             .commandBufferSizeMB = (uint32_t) commandBufferSizeMB,
@@ -494,6 +495,8 @@ extern "C" JNIEXPORT void JNICALL Java_com_google_android_filament_Engine_nSetBu
             .perFrameCommandsSizeMB = (uint32_t) perFrameCommandsSizeMB,
             .jobSystemThreadCount = (uint32_t) jobSystemThreadCount,
             .stereoscopicEyeCount = (uint8_t) stereoscopicEyeCount,
+            .resourceAllocatorCacheSizeMB = (uint32_t) resourceAllocatorCacheSizeMB,
+            .resourceAllocatorCacheMaxAge = (uint8_t) resourceAllocatorCacheMaxAge,
     };
     builder->config(&config);
 }

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

@@ -211,7 +211,8 @@ public class Engine {
             nSetBuilderConfig(mNativeBuilder, config.commandBufferSizeMB,
                     config.perRenderPassArenaSizeMB, config.driverHandleArenaSizeMB,
                     config.minCommandBufferSizeMB, config.perFrameCommandsSizeMB,
-                    config.jobSystemThreadCount, config.stereoscopicEyeCount);
+                    config.jobSystemThreadCount, config.stereoscopicEyeCount,
+                    config.resourceAllocatorCacheSizeMB, config.resourceAllocatorCacheMaxAge);
             return this;
         }
 
@@ -356,6 +357,18 @@ public class Engine {
          * @see Engine#getMaxStereoscopicEyes
          */
         public long stereoscopicEyeCount = 2;
+
+        /*
+         * Size in MiB of the frame graph texture cache. This should be adjusted based on the
+         * size of used render targets (typically the screen).
+         */
+        public long resourceAllocatorCacheSizeMB = 64;
+
+        /*
+         * This value determines for how many frames are texture entries kept in the cache.
+         * The default value of 30 corresponds to about half a second at 60 fps.
+         */
+        public long resourceAllocatorCacheMaxAge = 30;
     }
 
     private Engine(long nativeEngine, Config config) {
@@ -1227,7 +1240,8 @@ public class Engine {
     private static native void nSetBuilderConfig(long nativeBuilder, long commandBufferSizeMB,
             long perRenderPassArenaSizeMB, long driverHandleArenaSizeMB,
             long minCommandBufferSizeMB, long perFrameCommandsSizeMB, long jobSystemThreadCount,
-            long stereoscopicEyeCount);
+            long stereoscopicEyeCount,
+            long resourceAllocatorCacheSizeMB, long resourceAllocatorCacheMaxAge);
     private static native void nSetBuilderFeatureLevel(long nativeBuilder, int ordinal);
     private static native void nSetBuilderSharedContext(long nativeBuilder, long sharedContext);
     private static native long nBuilderBuild(long nativeBuilder);

android/gradle.properties

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

build/linux/combine-static-libs.sh

@@ -125,7 +125,13 @@ if [[ "${has_universal}" == "true" ]]; then
 
         arch_output="${OUTPUT_PATH%.a}_${arch}.a"
         arch_outputs+=("$arch_output")
-        combine_static_libs "$arch_output" $(find "$(pwd)/${archs_temp_dir}/${arch}" -iname '*.a')
+
+        archives=()
+        while IFS=  read -r -d $'\0'; do
+            archives+=("$REPLY")
+        done < <(find "$(pwd)/${archs_temp_dir}/${arch}" -iname '*.a' -print0)
+
+        combine_static_libs "$arch_output" "$archives"
     done
 
     # Finally, combine the single-architecture archives into a universal binary.

filament/backend/include/backend/Platform.h

@@ -84,7 +84,7 @@ public:
      *
      * @return nullptr on failure, or a pointer to the newly created driver.
      */
-    virtual backend::Driver* createDriver(void* sharedContext,
+    virtual backend::Driver* UTILS_NULLABLE createDriver(void* UTILS_NULLABLE sharedContext,
             const DriverConfig& driverConfig) noexcept = 0;
 
     /**
@@ -102,7 +102,8 @@ public:
      * cache.
      */
     using InsertBlobFunc = utils::Invocable<
-            void(const void* key, size_t keySize, const void* value, size_t valueSize)>;
+            void(const void* UTILS_NONNULL key, size_t keySize,
+                    const void* UTILS_NONNULL value, size_t valueSize)>;
 
     /*
      * RetrieveBlobFunc is an Invocable to an application-provided function that a
@@ -110,7 +111,8 @@ public:
      * cache.
      */
     using RetrieveBlobFunc = utils::Invocable<
-            size_t(const void* key, size_t keySize, void* value, size_t valueSize)>;
+            size_t(const void* UTILS_NONNULL key, size_t keySize,
+                    void* UTILS_NONNULL value, size_t valueSize)>;
 
     /**
      * Sets the callback functions that the backend can use to interact with caching functionality
@@ -163,7 +165,8 @@ public:
      * @param value         pointer to the beginning of the value data that is to be inserted
      * @param valueSize     specifies the size in byte of the data pointed to by <value>
      */
-    void insertBlob(const void* key, size_t keySize, const void* value, size_t valueSize);
+    void insertBlob(const void* UTILS_NONNULL key, size_t keySize,
+            const void* UTILS_NONNULL value, size_t valueSize);
 
     /**
      * To retrieve the binary value associated with a given key from the cache, a
@@ -182,7 +185,8 @@ public:
      * @return             If the cache contains a value associated with the given key then the
      *                     size of that binary value in bytes is returned. Otherwise 0 is returned.
      */
-    size_t retrieveBlob(const void* key, size_t keySize, void* value, size_t valueSize);
+    size_t retrieveBlob(const void* UTILS_NONNULL key, size_t keySize,
+            void* UTILS_NONNULL value, size_t valueSize);
 
 private:
     InsertBlobFunc mInsertBlob;

filament/backend/include/backend/platforms/OpenGLPlatform.h

@@ -21,6 +21,8 @@
 #include <backend/DriverEnums.h>
 #include <backend/Platform.h>
 
+#include <utils/compiler.h>
+
 #include <stdint.h>
 
 namespace filament::backend {
@@ -41,8 +43,8 @@ protected:
      * Derived classes can use this to instantiate the default OpenGLDriver backend.
      * This is typically called from your implementation of createDriver()
      */
-    static Driver* createDefaultDriver(OpenGLPlatform* platform,
-            void* sharedContext, const DriverConfig& driverConfig);
+    static Driver* UTILS_NULLABLE createDefaultDriver(OpenGLPlatform* UTILS_NONNULL platform,
+            void* UTILS_NULLABLE sharedContext, const DriverConfig& driverConfig);
 
     ~OpenGLPlatform() noexcept override;
 
@@ -69,7 +71,8 @@ public:
      * @return              The driver's SwapChain object.
      *
      */
-    virtual SwapChain* createSwapChain(void* nativeWindow, uint64_t flags) noexcept = 0;
+    virtual SwapChain* UTILS_NONNULL createSwapChain(
+            void* UTILS_NULLABLE nativeWindow, uint64_t flags) noexcept = 0;
 
     /**
      * Return whether createSwapChain supports the SWAP_CHAIN_CONFIG_SRGB_COLORSPACE flag.
@@ -90,13 +93,14 @@ public:
      * TODO: we need a more generic way of passing construction parameters
      *       A void* might be enough.
      */
-    virtual SwapChain* createSwapChain(uint32_t width, uint32_t height, uint64_t flags) noexcept = 0;
+    virtual SwapChain* UTILS_NULLABLE createSwapChain(
+            uint32_t width, uint32_t height, uint64_t flags) noexcept = 0;
 
     /**
      * Called by the driver to destroys the SwapChain
      * @param swapChain SwapChain to be destroyed.
      */
-    virtual void destroySwapChain(SwapChain* swapChain) noexcept = 0;
+    virtual void destroySwapChain(SwapChain* UTILS_NONNULL swapChain) noexcept = 0;
 
     /**
      * Returns the set of buffers that must be preserved up to the call to commit().
@@ -109,7 +113,7 @@ public:
      * @return buffer that must be preserved
      * @see commit()
      */
-    virtual TargetBufferFlags getPreservedFlags(SwapChain* swapChain) noexcept;
+    virtual TargetBufferFlags getPreservedFlags(SwapChain* UTILS_NONNULL swapChain) noexcept;
 
     /**
      * Called by the driver to establish the default FBO. The default implementation returns 0.
@@ -123,14 +127,16 @@ public:
      * @param drawSwapChain SwapChain to draw to. It must be bound to the default FBO.
      * @param readSwapChain SwapChain to read from (for operation like `glBlitFramebuffer`)
      */
-    virtual void makeCurrent(SwapChain* drawSwapChain, SwapChain* readSwapChain) noexcept = 0;
+    virtual void makeCurrent(
+            SwapChain* UTILS_NONNULL drawSwapChain,
+            SwapChain* UTILS_NONNULL readSwapChain) noexcept = 0;
 
     /**
      * Called by the driver once the current frame finishes drawing. Typically, this should present
      * the drawSwapChain. This is for example where `eglMakeCurrent()` would be called.
      * @param swapChain the SwapChain to present.
      */
-    virtual void commit(SwapChain* swapChain) noexcept = 0;
+    virtual void commit(SwapChain* UTILS_NONNULL swapChain) noexcept = 0;
 
     /**
      * Set the time the next committed buffer should be presented to the user at.
@@ -155,14 +161,14 @@ public:
      *
      * @return A Fence object. The default implementation returns nullptr.
      */
-    virtual Fence* createFence() noexcept;
+    virtual Fence* UTILS_NULLABLE createFence() noexcept;
 
     /**
      * Destroys a Fence object. The default implementation does nothing.
      *
      * @param fence Fence to destroy.
      */
-    virtual void destroyFence(Fence* fence) noexcept;
+    virtual void destroyFence(Fence* UTILS_NONNULL fence) noexcept;
 
     /**
      * Waits on a Fence.
@@ -172,7 +178,7 @@ public:
      * @return Whether the fence signaled or timed out. See backend::FenceStatus.
      *         The default implementation always return backend::FenceStatus::ERROR.
      */
-    virtual backend::FenceStatus waitFence(Fence* fence, uint64_t timeout) noexcept;
+    virtual backend::FenceStatus waitFence(Fence* UTILS_NONNULL fence, uint64_t timeout) noexcept;
 
 
     // --------------------------------------------------------------------------------------------
@@ -186,13 +192,13 @@ public:
      * @param nativeStream The native stream, this parameter depends on the concrete implementation.
      * @return A new Stream object.
      */
-    virtual Stream* createStream(void* nativeStream) noexcept;
+    virtual Stream* UTILS_NULLABLE createStream(void* UTILS_NULLABLE nativeStream) noexcept;
 
     /**
      * Destroys a Stream.
      * @param stream Stream to destroy.
      */
-    virtual void destroyStream(Stream* stream) noexcept;
+    virtual void destroyStream(Stream* UTILS_NONNULL stream) noexcept;
 
     /**
      * The specified stream takes ownership of the texture (tname) object
@@ -202,20 +208,21 @@ public:
      * @param stream Stream to take ownership of the texture
      * @param tname  GL texture id to "bind" to the Stream.
      */
-    virtual void attach(Stream* stream, intptr_t tname) noexcept;
+    virtual void attach(Stream* UTILS_NONNULL stream, intptr_t tname) noexcept;
 
     /**
      * Destroys the texture associated to the stream
      * @param stream Stream to detach from its texture
      */
-    virtual void detach(Stream* stream) noexcept;
+    virtual void detach(Stream* UTILS_NONNULL stream) noexcept;
 
     /**
      * Updates the content of the texture attached to the stream.
      * @param stream Stream to update
      * @param timestamp Output parameter: Timestamp of the image bound to the texture.
      */
-    virtual void updateTexImage(Stream* stream, int64_t* timestamp) noexcept;
+    virtual void updateTexImage(Stream* UTILS_NONNULL stream,
+            int64_t* UTILS_NONNULL timestamp) noexcept;
 
 
     // --------------------------------------------------------------------------------------------
@@ -228,13 +235,13 @@ public:
      *         implementation could just return { 0, GL_TEXTURE_2D } at this point. The actual
      *         values can be delayed until setExternalImage.
      */
-    virtual ExternalTexture *createExternalImageTexture() noexcept;
+    virtual ExternalTexture* UTILS_NULLABLE createExternalImageTexture() noexcept;
 
     /**
      * Destroys an external texture handle and associated data.
      * @param texture a pointer to the handle to destroy.
      */
-    virtual void destroyExternalImage(ExternalTexture* texture) noexcept;
+    virtual void destroyExternalImage(ExternalTexture* UTILS_NONNULL texture) noexcept;
 
     // called on the application thread to allow Filament to take ownership of the image
 
@@ -247,7 +254,7 @@ public:
      * @param externalImage A token representing the platform's external image.
      * @see destroyExternalImage
      */
-    virtual void retainExternalImage(void* externalImage) noexcept;
+    virtual void retainExternalImage(void* UTILS_NONNULL externalImage) noexcept;
 
     /**
      * Called to bind the platform-specific externalImage to an ExternalTexture.
@@ -261,7 +268,8 @@ public:
      * @param texture an in/out pointer to ExternalTexture, id and target can be updated if necessary.
      * @return true on success, false on error.
      */
-    virtual bool setExternalImage(void* externalImage, ExternalTexture* texture) noexcept;
+    virtual bool setExternalImage(void* UTILS_NONNULL externalImage,
+            ExternalTexture* UTILS_NONNULL texture) noexcept;
 
     /**
      * The method allows platforms to convert a user-supplied external image object into a new type

filament/backend/include/private/backend/CircularBuffer.h

@@ -17,7 +17,10 @@
 #ifndef TNT_FILAMENT_BACKEND_PRIVATE_CIRCULARBUFFER_H
 #define TNT_FILAMENT_BACKEND_PRIVATE_CIRCULARBUFFER_H
 
+#include <utils/debug.h>
+
 #include <stddef.h>
+#include <stdint.h>
 
 namespace filament::backend {
 
@@ -37,28 +40,36 @@ public:
 
     ~CircularBuffer() noexcept;
 
-    // allocates 'size' bytes in the circular buffer and returns a pointer to the memory
-    // return the current head and moves it forward by size bytes
-    inline void* allocate(size_t size) noexcept {
+    static size_t getBlockSize() noexcept { return sPageSize; }
+
+    // Total size of circular buffer. This is a constant.
+    size_t size() const noexcept { return mSize; }
+
+    // Allocates `s` bytes in the circular buffer and returns a pointer to the memory. All
+    // allocations must not exceed size() bytes.
+    inline void* allocate(size_t s) noexcept {
+        // We can never allocate more that size().
+        assert_invariant(getUsed() + s <= size());
         char* const cur = static_cast<char*>(mHead);
-        mHead = cur + size;
+        mHead = cur + s;
         return cur;
     }
 
-    // Total size of circular buffer
-    size_t size() const noexcept { return mSize; }
-
-    // returns true if the buffer is empty (e.g. after calling flush)
+    // Returns true if the buffer is empty, i.e.: no allocations were made since
+    // calling getBuffer();
     bool empty() const noexcept { return mTail == mHead; }
 
-    void* getHead() const noexcept { return mHead; }
+    // Returns the size used since the last call to getBuffer()
+    size_t getUsed() const noexcept { return intptr_t(mHead) - intptr_t(mTail); }
 
-    void* getTail() const noexcept { return mTail; }
-
-    // call at least once every getRequiredSize() bytes allocated from the buffer
-    void circularize() noexcept;
-
-    static size_t getBlockSize() noexcept { return sPageSize; }
+    // Retrieves the current allocated range and frees it. It is the responsibility of the caller
+    // to make sure the returned range is no longer in use by the time allocate() allocates
+    // (size() - getUsed()) bytes.
+    struct Range {
+        void* tail;
+        void* head;
+    };
+    Range getBuffer() noexcept;
 
 private:
     void* alloc(size_t size) noexcept;
@@ -66,10 +77,10 @@ private:
 
     // pointer to the beginning of the circular buffer (constant)
     void* mData = nullptr;
-    int mUsesAshmem = -1;
+    int mAshmemFd = -1;
 
     // size of the circular buffer (constant)
-    size_t mSize = 0;
+    size_t const mSize;
 
     // pointer to the beginning of recorded data
     void* mTail = nullptr;

filament/backend/include/private/backend/CommandBufferQueue.h

@@ -33,7 +33,7 @@ namespace filament::backend {
  * A producer-consumer command queue that uses a CircularBuffer as main storage
  */
 class CommandBufferQueue {
-    struct Slice {
+    struct Range {
         void* begin;
         void* end;
     };
@@ -46,7 +46,7 @@ class CommandBufferQueue {
 
     mutable utils::Mutex mLock;
     mutable utils::Condition mCondition;
-    mutable std::vector<Slice> mCommandBuffersToExecute;
+    mutable std::vector<Range> mCommandBuffersToExecute;
     size_t mFreeSpace = 0;
     size_t mHighWatermark = 0;
     uint32_t mExitRequested = 0;
@@ -58,17 +58,20 @@ public:
     CommandBufferQueue(size_t requiredSize, size_t bufferSize);
     ~CommandBufferQueue();
 
-    CircularBuffer& getCircularBuffer() { return mCircularBuffer; }
+    CircularBuffer& getCircularBuffer() noexcept { return mCircularBuffer; }
+    CircularBuffer const& getCircularBuffer() const noexcept { return mCircularBuffer; }
+
+    size_t getCapacity() const noexcept { return mRequiredSize; }
 
     size_t getHighWatermark() const noexcept { return mHighWatermark; }
 
     // wait for commands to be available and returns an array containing these commands
-    std::vector<Slice> waitForCommands() const;
+    std::vector<Range> waitForCommands() const;
 
     // return the memory used by this command buffer to the circular buffer
     // WARNING: releaseBuffer() must be called in sequence of the Slices returned by
     // waitForCommands()
-    void releaseBuffer(Slice const& buffer);
+    void releaseBuffer(Range const& buffer);
 
     // all commands buffers (Slices) written to this point are returned by waitForCommand(). This
     // call blocks until the CircularBuffer has at least mRequiredSize bytes available.

filament/backend/include/private/backend/CommandStream.h

@@ -213,6 +213,8 @@ public:
     CommandStream(CommandStream const& rhs) noexcept = delete;
     CommandStream& operator=(CommandStream const& rhs) noexcept = delete;
 
+    CircularBuffer const& getCircularBuffer() const noexcept { return mCurrentBuffer; }
+
 public:
 #define DECL_DRIVER_API(methodName, paramsDecl, params)                                         \
     inline void methodName(paramsDecl) {                                                        \

filament/backend/include/private/backend/HandleAllocator.h

@@ -231,7 +231,7 @@ private:
         explicit Allocator(const utils::AreaPolicy::HeapArea& area);
 
         // this is in fact always called with a constexpr size argument
-        [[nodiscard]] inline void* alloc(size_t size, size_t, size_t extra) noexcept {
+        [[nodiscard]] inline void* alloc(size_t size, size_t, size_t extra = 0) noexcept {
             void* p = nullptr;
                  if (size <= mPool0.getSize()) p = mPool0.alloc(size, 16, extra);
             else if (size <= mPool1.getSize()) p = mPool1.alloc(size, 16, extra);

filament/backend/src/CircularBuffer.cpp

@@ -16,6 +16,14 @@
 
 #include "private/backend/CircularBuffer.h"
 
+#include <utils/Log.h>
+#include <utils/Panic.h>
+#include <utils/architecture.h>
+#include <utils/ashmem.h>
+#include <utils/compiler.h>
+#include <utils/debug.h>
+#include <utils/ostream.h>
+
 #if !defined(WIN32) && !defined(__EMSCRIPTEN__) && !defined(IOS)
 #    include <sys/mman.h>
 #    include <unistd.h>
@@ -24,23 +32,20 @@
 #    define HAS_MMAP 0
 #endif
 
+#include <stdint.h>
+#include <stddef.h>
+#include <stdlib.h>
 #include <stdio.h>
 
-#include <utils/architecture.h>
-#include <utils/ashmem.h>
-#include <utils/debug.h>
-#include <utils/Log.h>
-#include <utils/Panic.h>
-
 using namespace utils;
 
 namespace filament::backend {
 
 size_t CircularBuffer::sPageSize = arch::getPageSize();
 
-CircularBuffer::CircularBuffer(size_t size) {
+CircularBuffer::CircularBuffer(size_t size)
+    : mSize(size) {
     mData = alloc(size);
-    mSize = size;
     mTail = mData;
     mHead = mData;
 }
@@ -85,7 +90,7 @@ void* CircularBuffer::alloc(size_t size) noexcept {
                             MAP_PRIVATE, fd, (off_t)size);
                     if (vaddr_guard != MAP_FAILED && (vaddr_guard == (char*)vaddr_shadow + size)) {
                         // woo-hoo success!
-                        mUsesAshmem = fd;
+                        mAshmemFd = fd;
                         data = vaddr;
                     }
                 }
@@ -93,7 +98,7 @@ void* CircularBuffer::alloc(size_t size) noexcept {
         }
     }
 
-    if (UTILS_UNLIKELY(mUsesAshmem < 0)) {
+    if (UTILS_UNLIKELY(mAshmemFd < 0)) {
         // ashmem failed
         if (vaddr_guard != MAP_FAILED) {
             munmap(vaddr_guard, size);
@@ -137,9 +142,9 @@ void CircularBuffer::dealloc() noexcept {
     if (mData) {
         size_t const BLOCK_SIZE = getBlockSize();
         munmap(mData, mSize * 2 + BLOCK_SIZE);
-        if (mUsesAshmem >= 0) {
-            close(mUsesAshmem);
-            mUsesAshmem = -1;
+        if (mAshmemFd >= 0) {
+            close(mAshmemFd);
+            mAshmemFd = -1;
         }
     }
 #else
@@ -149,23 +154,37 @@ void CircularBuffer::dealloc() noexcept {
 }
 
 
-void CircularBuffer::circularize() noexcept {
-    if (mUsesAshmem > 0) {
-        intptr_t const overflow = intptr_t(mHead) - (intptr_t(mData) + ssize_t(mSize));
-        if (overflow >= 0) {
-            assert_invariant(size_t(overflow) <= mSize);
-            mHead = (void *) (intptr_t(mData) + overflow);
-            #ifndef NDEBUG
-            memset(mData, 0xA5, size_t(overflow));
-            #endif
-        }
-    } else {
-        // Only circularize if mHead if in the second buffer.
-        if (intptr_t(mHead) - intptr_t(mData) > ssize_t(mSize)) {
+CircularBuffer::Range CircularBuffer::getBuffer() noexcept {
+    Range const range{ .tail = mTail, .head = mHead };
+
+    char* const pData = static_cast<char*>(mData);
+    char const* const pEnd = pData + mSize;
+    char const* const pHead = static_cast<char const*>(mHead);
+    if (UTILS_UNLIKELY(pHead >= pEnd)) {
+        size_t const overflow = pHead - pEnd;
+        if (UTILS_LIKELY(mAshmemFd > 0)) {
+            assert_invariant(overflow <= mSize);
+            mHead = static_cast<void*>(pData + overflow);
+            // Data         Tail  End   Head              [virtual]
+            //  v             v    v     v
+            //  +-------------:----+-----:--------------+
+            //  |             :    |     :              |
+            //  +-----:------------+--------------------+
+            //       Head          |<------ copy ------>| [physical]
+        } else {
+            // Data         Tail  End   Head
+            //  v             v    v     v
+            //  +-------------:----+-----:--------------+
+            //  |             :    |     :              |
+            //  +-----|------------+-----|--------------+
+            //        |<---------------->|
+            //           sliding window
             mHead = mData;
         }
     }
     mTail = mHead;
+
+    return range;
 }
 
 } // namespace filament::backend

filament/backend/src/CommandBufferQueue.cpp

@@ -15,14 +15,25 @@
  */
 
 #include "private/backend/CommandBufferQueue.h"
+#include "private/backend/CircularBuffer.h"
+#include "private/backend/CommandStream.h"
 
+#include <utils/compiler.h>
 #include <utils/Log.h>
-#include <utils/Systrace.h>
+#include <utils/Mutex.h>
+#include <utils/ostream.h>
 #include <utils/Panic.h>
+#include <utils/Systrace.h>
 #include <utils/debug.h>
 
-#include "private/backend/BackendUtils.h"
-#include "private/backend/CommandStream.h"
+#include <algorithm>
+#include <mutex>
+#include <iterator>
+#include <utility>
+#include <vector>
+
+#include <stddef.h>
+#include <stdint.h>
 
 using namespace utils;
 
@@ -65,50 +76,53 @@ void CommandBufferQueue::flush() noexcept {
     // always guaranteed to have enough space for the NoopCommand
     new(circularBuffer.allocate(sizeof(NoopCommand))) NoopCommand(nullptr);
 
-    // end of this slice
-    void* const head = circularBuffer.getHead();
+    const size_t requiredSize = mRequiredSize;
 
-    // beginning of this slice
-    void* const tail = circularBuffer.getTail();
+    // get the current buffer
+    auto const [begin, end] = circularBuffer.getBuffer();
 
-    // size of this slice
-    uint32_t const used = uint32_t(intptr_t(head) - intptr_t(tail));
+    assert_invariant(circularBuffer.empty());
 
-    circularBuffer.circularize();
+    // size of the current buffer
+    size_t const used = std::distance(
+            static_cast<char const*>(begin), static_cast<char const*>(end));
 
     std::unique_lock<utils::Mutex> lock(mLock);
-    mCommandBuffersToExecute.push_back({ tail, head });
+    mCommandBuffersToExecute.push_back({ begin, end });
+    mCondition.notify_one();
 
     // circular buffer is too small, we corrupted the stream
     ASSERT_POSTCONDITION(used <= mFreeSpace,
             "Backend CommandStream overflow. Commands are corrupted and unrecoverable.\n"
             "Please increase minCommandBufferSizeMB inside the Config passed to Engine::create.\n"
-            "Space used at this time: %u bytes",
-            (unsigned)used);
+            "Space used at this time: %u bytes, overflow: %u bytes",
+            (unsigned)used, unsigned(used - mFreeSpace));
 
     // wait until there is enough space in the buffer
     mFreeSpace -= used;
-    const size_t requiredSize = mRequiredSize;
+    if (UTILS_UNLIKELY(mFreeSpace < requiredSize)) {
+
 
 #ifndef NDEBUG
-    size_t totalUsed = circularBuffer.size() - mFreeSpace;
-    mHighWatermark = std::max(mHighWatermark, totalUsed);
-    if (UTILS_UNLIKELY(totalUsed > requiredSize)) {
-        slog.d << "CommandStream used too much space: " << totalUsed
-            << ", out of " << requiredSize << " (will block)" << io::endl;
-    }
+        size_t const totalUsed = circularBuffer.size() - mFreeSpace;
+        slog.d << "CommandStream used too much space (will block): "
+                << "needed space " << requiredSize << " out of " << mFreeSpace
+                << ", totalUsed=" << totalUsed << ", current=" << used
+                << ", queue size=" << mCommandBuffersToExecute.size() << " buffers"
+                << io::endl;
+
+        mHighWatermark = std::max(mHighWatermark, totalUsed);
 #endif
 
-    mCondition.notify_one();
-    if (UTILS_LIKELY(mFreeSpace < requiredSize)) {
         SYSTRACE_NAME("waiting: CircularBuffer::flush()");
         mCondition.wait(lock, [this, requiredSize]() -> bool {
+            // TODO: on macOS, we need to call pumpEvents from time to time
             return mFreeSpace >= requiredSize;
         });
     }
 }
 
-std::vector<CommandBufferQueue::Slice> CommandBufferQueue::waitForCommands() const {
+std::vector<CommandBufferQueue::Range> CommandBufferQueue::waitForCommands() const {
     if (!UTILS_HAS_THREADING) {
         return std::move(mCommandBuffersToExecute);
     }
@@ -123,7 +137,7 @@ std::vector<CommandBufferQueue::Slice> CommandBufferQueue::waitForCommands() con
     return std::move(mCommandBuffersToExecute);
 }
 
-void CommandBufferQueue::releaseBuffer(CommandBufferQueue::Slice const& buffer) {
+void CommandBufferQueue::releaseBuffer(CommandBufferQueue::Range const& buffer) {
     std::lock_guard<utils::Mutex> const lock(mLock);
     mFreeSpace += uintptr_t(buffer.end) - uintptr_t(buffer.begin);
     mCondition.notify_one();

filament/backend/src/metal/MetalHandles.mm

@@ -245,30 +245,53 @@ void MetalSwapChain::present() {
     }
 }
 
-struct PresentDrawableData {
-    void* drawable = nullptr;
-    MetalDriver* driver = nullptr;
+#ifndef FILAMENT_RELEASE_PRESENT_DRAWABLE_MAIN_THREAD
+#define FILAMENT_RELEASE_PRESENT_DRAWABLE_MAIN_THREAD 1
+#endif
+
+class PresentDrawableData {
+public:
+    PresentDrawableData() = delete;
+    PresentDrawableData(const PresentDrawableData&) = delete;
+    PresentDrawableData& operator=(const PresentDrawableData&) = delete;
+
+    static PresentDrawableData* create(id<CAMetalDrawable> drawable, MetalDriver* driver) {
+        assert_invariant(driver);
+        return new PresentDrawableData(drawable, driver);
+    }
+
+    static void maybePresentAndDestroyAsync(PresentDrawableData* that, bool shouldPresent) {
+        if (shouldPresent) {
+           [that->mDrawable present];
+        }
+
+#if FILAMENT_RELEASE_PRESENT_DRAWABLE_MAIN_THREAD == 1
+        // mDrawable is acquired on the driver thread. Typically, we would release this object on
+        // the same thread, but after receiving consistent crash reports from within
+        // [CAMetalDrawable dealloc], we suspect this object requires releasing on the main thread.
+        dispatch_async(dispatch_get_main_queue(), ^{ cleanupAndDestroy(that); });
+#else
+        that->mDriver->runAtNextTick([that]() { cleanupAndDestroy(that); });
+#endif
+    }
+
+private:
+    PresentDrawableData(id<CAMetalDrawable> drawable, MetalDriver* driver)
+        : mDrawable(drawable), mDriver(driver) {}
+
+    static void cleanupAndDestroy(PresentDrawableData *that) {
+        that->mDrawable = nil;
+        that->mDriver = nullptr;
+        delete that;
+    }
+
+    id<CAMetalDrawable> mDrawable;
+    MetalDriver* mDriver = nullptr;
 };
 
 void presentDrawable(bool presentFrame, void* user) {
     auto* presentDrawableData = static_cast<PresentDrawableData*>(user);
-
-    // CFBridgingRelease here is used to balance the CFBridgingRetain inside acquireDrawable.
-    id<CAMetalDrawable> drawable =
-            (id<CAMetalDrawable>)CFBridgingRelease(presentDrawableData->drawable);
-    if (presentFrame) {
-        [drawable present];
-    }
-
-    // Schedule the drawable destruction on the driver thread.
-    void* voidDrawable = (void*) CFBridgingRetain(drawable);
-    MetalDriver* driver = presentDrawableData->driver;
-    driver->runAtNextTick([voidDrawable]() {
-        // The drawable is released here.
-        CFBridgingRelease(voidDrawable);
-    });
-
-    delete presentDrawableData;
+    PresentDrawableData::maybePresentAndDestroyAsync(presentDrawableData, presentFrame);
 }
 
 void MetalSwapChain::scheduleFrameScheduledCallback() {
@@ -277,21 +300,16 @@ void MetalSwapChain::scheduleFrameScheduledCallback() {
     }
 
     assert_invariant(drawable);
-    FrameScheduledCallback callback = frameScheduledCallback;
-    // This block strongly captures drawable to keep it alive until the handler executes.
-    // We cannot simply reference this->drawable inside the block because the block would then only
-    // capture the _this_ pointer (MetalSwapChain*) instead of the drawable.
-    id<CAMetalDrawable> d = drawable;
+
+    // Destroy this by calling maybePresentAndDestroyAsync() later.
+    auto* presentData = PresentDrawableData::create(drawable, context.driver);
+
+    FrameScheduledCallback userCallback = frameScheduledCallback;
     void* userData = frameScheduledUserData;
-    MetalDriver* driver = context.driver;
+
     [getPendingCommandBuffer(&context) addScheduledHandler:^(id<MTLCommandBuffer> cb) {
-        // CFBridgingRetain is used here to give the drawable a +1 retain count before
-        // casting it to a void*.
-        auto* presentDrawableData = new PresentDrawableData;
-        presentDrawableData->drawable = (void*) CFBridgingRetain(d);
-        presentDrawableData->driver = driver;
-        PresentCallable callable(presentDrawable, (void*) presentDrawableData);
-        callback(callable, userData);
+        PresentCallable callable(presentDrawable, static_cast<void*>(presentData));
+        userCallback(callable, userData);
     }];
 }
 

filament/include/filament/BufferObject.h

@@ -84,8 +84,7 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this BufferObject with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object
          *
          * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of
          *            memory or other resources.
@@ -93,7 +92,7 @@ public:
          *
          * @see IndexBuffer::setBuffer
          */
-        BufferObject* build(Engine& engine);
+        BufferObject* UTILS_NONNULL build(Engine& engine);
     private:
         friend class FBufferObject;
     };

filament/include/filament/Camera.h

@@ -306,7 +306,7 @@ public:
      * @see setCustomProjection
      * @see Engine::Config::stereoscopicEyeCount
      */
-    void setCustomEyeProjection(math::mat4 const* projection, size_t count,
+    void setCustomEyeProjection(math::mat4 const* UTILS_NONNULL projection, size_t count,
             math::mat4 const& projectionForCulling, double near, double far);
 
     /** Sets an additional matrix that scales the projection matrix.

filament/include/filament/ColorGrading.h

@@ -203,7 +203,7 @@ public:
          *
          * @return This Builder, for chaining calls
          */
-        Builder& toneMapper(const ToneMapper* toneMapper) noexcept;
+        Builder& toneMapper(ToneMapper const* UTILS_NULLABLE toneMapper) noexcept;
 
         /**
          * Selects the tone mapping operator to apply to the HDR color buffer as the last
@@ -473,10 +473,9 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this ColorGrading with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          */
-        ColorGrading* build(Engine& engine);
+        ColorGrading* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FColorGrading;

filament/include/filament/DebugRegistry.h

@@ -39,27 +39,12 @@ namespace filament {
 class UTILS_PUBLIC DebugRegistry : public FilamentAPI {
 public:
 
-    /**
-     * Type of a property
-     */
-    enum Type {
-        BOOL, INT, FLOAT, FLOAT2, FLOAT3, FLOAT4
-    };
-
-    /**
-     * Information about a property
-     */
-    struct Property {
-        const char* name;   //!< property name
-        Type type;          //!< property type
-    };
-
     /**
      * Queries whether a property exists
      * @param name The name of the property to query
      * @return true if the property exists, false otherwise
      */
-    bool hasProperty(const char* name) const noexcept;
+    bool hasProperty(const char* UTILS_NONNULL name) const noexcept;
 
     /**
      * Queries the address of a property's data from its name
@@ -67,28 +52,30 @@ public:
      * @return Address of the data of the \p name property
      * @{
      */
-    void* getPropertyAddress(const char* name);
+    void* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name);
 
-    void const* getPropertyAddress(const char* name) const noexcept;
+    void const* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name) const noexcept;
 
     template<typename T>
-    inline T* getPropertyAddress(const char* name) {
+    inline T* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name) {
         return static_cast<T*>(getPropertyAddress(name));
     }
 
     template<typename T>
-    inline T const* getPropertyAddress(const char* name) const noexcept {
+    inline T const* UTILS_NULLABLE getPropertyAddress(const char* UTILS_NONNULL name) const noexcept {
         return static_cast<T*>(getPropertyAddress(name));
     }
 
     template<typename T>
-    inline bool getPropertyAddress(const char* name, T** p) {
+    inline bool getPropertyAddress(const char* UTILS_NONNULL name,
+            T* UTILS_NULLABLE* UTILS_NONNULL p) {
         *p = getPropertyAddress<T>(name);
         return *p != nullptr;
     }
 
     template<typename T>
-    inline bool getPropertyAddress(const char* name, T* const* p) const noexcept {
+    inline bool getPropertyAddress(const char* UTILS_NONNULL name,
+            T* const UTILS_NULLABLE* UTILS_NONNULL p) const noexcept {
         *p = getPropertyAddress<T>(name);
         return *p != nullptr;
     }
@@ -101,12 +88,12 @@ public:
      * @return true if the operation was successful, false otherwise.
      * @{
      */
-    bool setProperty(const char* name, bool v) noexcept;
-    bool setProperty(const char* name, int v) noexcept;
-    bool setProperty(const char* name, float v) noexcept;
-    bool setProperty(const char* name, math::float2 v) noexcept;
-    bool setProperty(const char* name, math::float3 v) noexcept;
-    bool setProperty(const char* name, math::float4 v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, bool v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, int v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, float v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, math::float2 v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, math::float3 v) noexcept;
+    bool setProperty(const char* UTILS_NONNULL name, math::float4 v) noexcept;
     /** @}*/
 
     /**
@@ -116,20 +103,20 @@ public:
      * @return true if the call was successful and \p v was updated
      * @{
      */
-    bool getProperty(const char* name, bool* v) const noexcept;
-    bool getProperty(const char* name, int* v) const noexcept;
-    bool getProperty(const char* name, float* v) const noexcept;
-    bool getProperty(const char* name, math::float2* v) const noexcept;
-    bool getProperty(const char* name, math::float3* v) const noexcept;
-    bool getProperty(const char* name, math::float4* v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, bool* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, int* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, float* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, math::float2* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, math::float3* UTILS_NONNULL v) const noexcept;
+    bool getProperty(const char* UTILS_NONNULL name, math::float4* UTILS_NONNULL v) const noexcept;
     /** @}*/
 
     struct DataSource {
-        void const* data;
+        void const* UTILS_NULLABLE data;
         size_t count;
     };
 
-    DataSource getDataSource(const char* name) const noexcept;
+    DataSource getDataSource(const char* UTILS_NONNULL name) const noexcept;
 
     struct FrameHistory {
         using duration_ms = float;

filament/include/filament/Engine.h

@@ -305,11 +305,23 @@ public:
          * @see Engine::getMaxStereoscopicEyes
          */
         uint8_t stereoscopicEyeCount = 2;
+
+        /*
+         * Size in MiB of the frame graph texture cache. This should be adjusted based on the
+         * size of used render targets (typically the screen).
+         */
+        uint32_t resourceAllocatorCacheSizeMB = 64;
+
+        /*
+         * This value determines for how many frames are texture entries kept in the cache.
+         * The default value of 30 corresponds to about half a second at 60 fps.
+         */
+        uint32_t resourceAllocatorCacheMaxAge = 30;
     };
 
 
 #if UTILS_HAS_THREADING
-    using CreateCallback = void(void* user, void* token);
+    using CreateCallback = void(void* UTILS_NULLABLE user, void* UTILS_NONNULL token);
 #endif
 
     /**
@@ -348,7 +360,7 @@ public:
          *
          * @return A reference to this Builder for chaining calls.
          */
-        Builder& platform(Platform* platform) noexcept;
+        Builder& platform(Platform* UTILS_NULLABLE platform) noexcept;
 
         /**
          * @param config    A pointer to optional parameters to specify memory size
@@ -356,7 +368,7 @@ public:
          *
          * @return A reference to this Builder for chaining calls.
          */
-        Builder& config(const Config* config) noexcept;
+        Builder& config(const Config* UTILS_NULLABLE config) noexcept;
 
         /**
          * @param sharedContext A platform-dependant context used as a shared context
@@ -364,7 +376,7 @@ public:
          *
          * @return A reference to this Builder for chaining calls.
          */
-        Builder& sharedContext(void* sharedContext) noexcept;
+        Builder& sharedContext(void* UTILS_NULLABLE sharedContext) noexcept;
 
         /**
          * @param featureLevel The feature level at which initialize Filament.
@@ -379,7 +391,7 @@ public:
          * @param callback  Callback called once the engine is initialized and it is safe to
          *                  call Engine::getEngine().
          */
-        void build(utils::Invocable<void(void* token)>&& callback) const;
+        void build(utils::Invocable<void(void* UTILS_NONNULL token)>&& callback) const;
 #endif
 
         /**
@@ -394,16 +406,17 @@ public:
          *              allocate the command buffer. If exceptions are disabled, this condition if
          *              fatal and this function will abort.
          */
-        Engine* build() const;
+        Engine* UTILS_NULLABLE build() const;
     };
 
     /**
      * Backward compatibility helper to create an Engine.
      * @see Builder
      */
-    static inline Engine* create(Backend backend = Backend::DEFAULT,
-            Platform* platform = nullptr, void* sharedContext = nullptr,
-            const Config* config = nullptr) {
+    static inline Engine* UTILS_NULLABLE create(Backend backend = Backend::DEFAULT,
+            Platform* UTILS_NULLABLE platform = nullptr,
+            void* UTILS_NULLABLE sharedContext = nullptr,
+            const Config* UTILS_NULLABLE config = nullptr) {
         return Engine::Builder()
                 .backend(backend)
                 .platform(platform)
@@ -418,16 +431,18 @@ public:
      * Backward compatibility helper to create an Engine asynchronously.
      * @see Builder
      */
-    static inline void createAsync(CreateCallback callback, void* user,
+    static inline void createAsync(CreateCallback callback,
+            void* UTILS_NULLABLE user,
             Backend backend = Backend::DEFAULT,
-            Platform* platform = nullptr, void* sharedContext = nullptr,
-            const Config* config = nullptr) {
+            Platform* UTILS_NULLABLE platform = nullptr,
+            void* UTILS_NULLABLE sharedContext = nullptr,
+            const Config* UTILS_NULLABLE config = nullptr) {
         Engine::Builder()
                 .backend(backend)
                 .platform(platform)
                 .sharedContext(sharedContext)
                 .config(config)
-                .build([callback, user](void* token) {
+                .build([callback, user](void* UTILS_NONNULL token) {
                     callback(user, token);
                 });
     }
@@ -444,7 +459,7 @@ public:
      * allocate the command buffer. If exceptions are disabled, this condition if fatal and
      * this function will abort.
      */
-    static Engine* getEngine(void* token);
+    static Engine* UTILS_NULLABLE getEngine(void* UTILS_NONNULL token);
 #endif
 
 
@@ -474,7 +489,7 @@ public:
      * \remark
      * This method is thread-safe.
      */
-    static void destroy(Engine** engine);
+    static void destroy(Engine* UTILS_NULLABLE* UTILS_NULLABLE engine);
 
     /**
      * Destroy the Engine instance and all associated resources.
@@ -501,7 +516,7 @@ public:
      * \remark
      * This method is thread-safe.
      */
-    static void destroy(Engine* engine);
+    static void destroy(Engine* UTILS_NULLABLE engine);
 
     /**
      * Query the feature level supported by the selected backend.
@@ -649,11 +664,11 @@ public:
      *                     `ANativeWindow*`.
      * @param flags One or more configuration flags as defined in `SwapChain`.
      *
-     * @return A pointer to the newly created SwapChain or nullptr if it couldn't be created.
+     * @return A pointer to the newly created SwapChain.
      *
      * @see Renderer.beginFrame()
      */
-    SwapChain* createSwapChain(void* nativeWindow, uint64_t flags = 0) noexcept;
+    SwapChain* UTILS_NONNULL createSwapChain(void* UTILS_NULLABLE nativeWindow, uint64_t flags = 0) noexcept;
 
 
     /**
@@ -663,42 +678,42 @@ public:
       * @param height   Height of the drawing buffer in pixels.
      * @param flags     One or more configuration flags as defined in `SwapChain`.
      *
-     * @return A pointer to the newly created SwapChain or nullptr if it couldn't be created.
+     * @return A pointer to the newly created SwapChain.
      *
      * @see Renderer.beginFrame()
      */
-    SwapChain* createSwapChain(uint32_t width, uint32_t height, uint64_t flags = 0) noexcept;
+    SwapChain* UTILS_NONNULL createSwapChain(uint32_t width, uint32_t height, uint64_t flags = 0) noexcept;
 
     /**
      * Creates a renderer associated to this engine.
      *
      * A Renderer is intended to map to a *window* on screen.
      *
-     * @return A pointer to the newly created Renderer or nullptr if it couldn't be created.
+     * @return A pointer to the newly created Renderer.
      */
-    Renderer* createRenderer() noexcept;
+    Renderer* UTILS_NONNULL createRenderer() noexcept;
 
     /**
      * Creates a View.
      *
-     * @return A pointer to the newly created View or nullptr if it couldn't be created.
+     * @return A pointer to the newly created View.
      */
-    View* createView() noexcept;
+    View* UTILS_NONNULL createView() noexcept;
 
     /**
      * Creates a Scene.
      *
-     * @return A pointer to the newly created Scene or nullptr if it couldn't be created.
+     * @return A pointer to the newly created Scene.
      */
-    Scene* createScene() noexcept;
+    Scene* UTILS_NONNULL createScene() noexcept;
 
     /**
      * Creates a Camera component.
      *
      * @param entity Entity to add the camera component to.
-     * @return A pointer to the newly created Camera or nullptr if it couldn't be created.
+     * @return A pointer to the newly created Camera.
      */
-    Camera* createCamera(utils::Entity entity) noexcept;
+    Camera* UTILS_NONNULL createCamera(utils::Entity entity) noexcept;
 
     /**
      * Returns the Camera component of the given entity.
@@ -708,7 +723,7 @@ public:
      *         have a Camera component. The pointer is valid until destroyCameraComponent()
      *         is called or the entity itself is destroyed.
      */
-    Camera* getCameraComponent(utils::Entity entity) noexcept;
+    Camera* UTILS_NULLABLE getCameraComponent(utils::Entity entity) noexcept;
 
     /**
      * Destroys the Camera component associated with the given entity.
@@ -720,17 +735,17 @@ public:
     /**
      * Creates a Fence.
      *
-     * @return A pointer to the newly created Fence or nullptr if it couldn't be created.
+     * @return A pointer to the newly created Fence.
      */
-    Fence* createFence() noexcept;
+    Fence* UTILS_NONNULL createFence() noexcept;
 
-    bool destroy(const BufferObject* p);        //!< Destroys a BufferObject object.
-    bool destroy(const VertexBuffer* p);        //!< Destroys an VertexBuffer object.
-    bool destroy(const Fence* p);               //!< Destroys a Fence object.
-    bool destroy(const IndexBuffer* p);         //!< Destroys an IndexBuffer object.
-    bool destroy(const SkinningBuffer* p);      //!< Destroys a SkinningBuffer object.
-    bool destroy(const MorphTargetBuffer* p);   //!< Destroys a MorphTargetBuffer object.
-    bool destroy(const IndirectLight* p);       //!< Destroys an IndirectLight object.
+    bool destroy(const BufferObject* UTILS_NULLABLE p);         //!< Destroys a BufferObject object.
+    bool destroy(const VertexBuffer* UTILS_NULLABLE p);         //!< Destroys an VertexBuffer object.
+    bool destroy(const Fence* UTILS_NULLABLE p);                //!< Destroys a Fence object.
+    bool destroy(const IndexBuffer* UTILS_NULLABLE p);          //!< Destroys an IndexBuffer object.
+    bool destroy(const SkinningBuffer* UTILS_NULLABLE p);       //!< Destroys a SkinningBuffer object.
+    bool destroy(const MorphTargetBuffer* UTILS_NULLABLE p);    //!< Destroys a MorphTargetBuffer object.
+    bool destroy(const IndirectLight* UTILS_NULLABLE p);        //!< Destroys an IndirectLight object.
 
     /**
      * Destroys a Material object
@@ -740,38 +755,38 @@ public:
      * @exception utils::PreConditionPanic is thrown if some MaterialInstances remain.
      * no-op if exceptions are disabled and some MaterialInstances remain.
      */
-    bool destroy(const Material* p);
-    bool destroy(const MaterialInstance* p);    //!< Destroys a MaterialInstance object.
-    bool destroy(const Renderer* p);            //!< Destroys a Renderer object.
-    bool destroy(const Scene* p);               //!< Destroys a Scene object.
-    bool destroy(const Skybox* p);              //!< Destroys a SkyBox object.
-    bool destroy(const ColorGrading* p);        //!< Destroys a ColorGrading object.
-    bool destroy(const SwapChain* p);           //!< Destroys a SwapChain object.
-    bool destroy(const Stream* p);              //!< Destroys a Stream object.
-    bool destroy(const Texture* p);             //!< Destroys a Texture object.
-    bool destroy(const RenderTarget* p);        //!< Destroys a RenderTarget object.
-    bool destroy(const View* p);                //!< Destroys a View object.
-    bool destroy(const InstanceBuffer* p);      //!< Destroys an InstanceBuffer object.
-    void destroy(utils::Entity e);              //!< Destroys all filament-known components from this entity
+    bool destroy(const Material* UTILS_NULLABLE p);
+    bool destroy(const MaterialInstance* UTILS_NULLABLE p); //!< Destroys a MaterialInstance object.
+    bool destroy(const Renderer* UTILS_NULLABLE p);         //!< Destroys a Renderer object.
+    bool destroy(const Scene* UTILS_NULLABLE p);            //!< Destroys a Scene object.
+    bool destroy(const Skybox* UTILS_NULLABLE p);           //!< Destroys a SkyBox object.
+    bool destroy(const ColorGrading* UTILS_NULLABLE p);     //!< Destroys a ColorGrading object.
+    bool destroy(const SwapChain* UTILS_NULLABLE p);        //!< Destroys a SwapChain object.
+    bool destroy(const Stream* UTILS_NULLABLE p);           //!< Destroys a Stream object.
+    bool destroy(const Texture* UTILS_NULLABLE p);          //!< Destroys a Texture object.
+    bool destroy(const RenderTarget* UTILS_NULLABLE p);     //!< Destroys a RenderTarget object.
+    bool destroy(const View* UTILS_NULLABLE p);             //!< Destroys a View object.
+    bool destroy(const InstanceBuffer* UTILS_NULLABLE p);   //!< Destroys an InstanceBuffer object.
+    void destroy(utils::Entity e);    //!< Destroys all filament-known components from this entity
 
-    bool isValid(const BufferObject* p);        //!< Tells whether a BufferObject object is valid
-    bool isValid(const VertexBuffer* p);        //!< Tells whether an VertexBuffer object is valid
-    bool isValid(const Fence* p);               //!< Tells whether a Fence object is valid
-    bool isValid(const IndexBuffer* p);         //!< Tells whether an IndexBuffer object is valid
-    bool isValid(const SkinningBuffer* p);      //!< Tells whether a SkinningBuffer object is valid
-    bool isValid(const MorphTargetBuffer* p);   //!< Tells whether a MorphTargetBuffer object is valid
-    bool isValid(const IndirectLight* p);       //!< Tells whether an IndirectLight object is valid
-    bool isValid(const Material* p);            //!< Tells whether an IndirectLight object is valid
-    bool isValid(const Renderer* p);            //!< Tells whether a Renderer object is valid
-    bool isValid(const Scene* p);               //!< Tells whether a Scene object is valid
-    bool isValid(const Skybox* p);              //!< Tells whether a SkyBox object is valid
-    bool isValid(const ColorGrading* p);        //!< Tells whether a ColorGrading object is valid
-    bool isValid(const SwapChain* p);           //!< Tells whether a SwapChain object is valid
-    bool isValid(const Stream* p);              //!< Tells whether a Stream object is valid
-    bool isValid(const Texture* p);             //!< Tells whether a Texture object is valid
-    bool isValid(const RenderTarget* p);        //!< Tells whether a RenderTarget object is valid
-    bool isValid(const View* p);                //!< Tells whether a View object is valid
-    bool isValid(const InstanceBuffer* p);      //!< Tells whether an InstanceBuffer object is valid
+    bool isValid(const BufferObject* UTILS_NULLABLE p);        //!< Tells whether a BufferObject object is valid
+    bool isValid(const VertexBuffer* UTILS_NULLABLE p);        //!< Tells whether an VertexBuffer object is valid
+    bool isValid(const Fence* UTILS_NULLABLE p);               //!< Tells whether a Fence object is valid
+    bool isValid(const IndexBuffer* UTILS_NULLABLE p);         //!< Tells whether an IndexBuffer object is valid
+    bool isValid(const SkinningBuffer* UTILS_NULLABLE p);      //!< Tells whether a SkinningBuffer object is valid
+    bool isValid(const MorphTargetBuffer* UTILS_NULLABLE p);   //!< Tells whether a MorphTargetBuffer object is valid
+    bool isValid(const IndirectLight* UTILS_NULLABLE p);       //!< Tells whether an IndirectLight object is valid
+    bool isValid(const Material* UTILS_NULLABLE p);            //!< Tells whether an IndirectLight object is valid
+    bool isValid(const Renderer* UTILS_NULLABLE p);            //!< Tells whether a Renderer object is valid
+    bool isValid(const Scene* UTILS_NULLABLE p);               //!< Tells whether a Scene object is valid
+    bool isValid(const Skybox* UTILS_NULLABLE p);              //!< Tells whether a SkyBox object is valid
+    bool isValid(const ColorGrading* UTILS_NULLABLE p);        //!< Tells whether a ColorGrading object is valid
+    bool isValid(const SwapChain* UTILS_NULLABLE p);           //!< Tells whether a SwapChain object is valid
+    bool isValid(const Stream* UTILS_NULLABLE p);              //!< Tells whether a Stream object is valid
+    bool isValid(const Texture* UTILS_NULLABLE p);             //!< Tells whether a Texture object is valid
+    bool isValid(const RenderTarget* UTILS_NULLABLE p);        //!< Tells whether a RenderTarget object is valid
+    bool isValid(const View* UTILS_NULLABLE p);                //!< Tells whether a View object is valid
+    bool isValid(const InstanceBuffer* UTILS_NULLABLE p);      //!< Tells whether an InstanceBuffer object is valid
 
     /**
      * Kicks the hardware thread (e.g. the OpenGL, Vulkan or Metal thread) and blocks until
@@ -811,7 +826,7 @@ public:
      *
      * @return A pointer to the default Material instance (a singleton).
      */
-    const Material* getDefaultMaterial() const noexcept;
+    Material const* UTILS_NONNULL getDefaultMaterial() const noexcept;
 
     /**
      * Returns the resolved backend.
@@ -842,7 +857,7 @@ public:
      * @return A pointer to the Platform object that was provided to Engine::create, or the
      * Filament-created one.
      */
-    Platform* getPlatform() const noexcept;
+    Platform* UTILS_NULLABLE getPlatform() const noexcept;
 
     /**
      * Allocate a small amount of memory directly in the command stream. The allocated memory is
@@ -855,7 +870,7 @@ public:
      * @note there is no need to destroy this buffer, it will be freed automatically when
      *       the current command buffer is executed.
      */
-    void* streamAlloc(size_t size, size_t alignment = alignof(double)) noexcept;
+    void* UTILS_NULLABLE streamAlloc(size_t size, size_t alignment = alignof(double)) noexcept;
 
     /**
       * Invokes one iteration of the render loop, used only on single-threaded platforms.

filament/include/filament/Fence.h

@@ -76,7 +76,7 @@ public:
      * @return  FenceStatus::CONDITION_SATISFIED on success,
      *          FenceStatus::ERROR otherwise.
      */
-    static FenceStatus waitAndDestroy(Fence* fence, Mode mode = Mode::FLUSH);
+    static FenceStatus waitAndDestroy(Fence* UTILS_NONNULL fence, Mode mode = Mode::FLUSH);
 
 protected:
     // prevent heap allocation

filament/include/filament/Frustum.h

@@ -79,14 +79,14 @@ public:
      * @param planes six plane equations encoded as in getNormalizedPlane() in
      *              left, right, bottom, top, far, near order
      */
-    void getNormalizedPlanes(math::float4 planes[6]) const noexcept;
+    void getNormalizedPlanes(math::float4 planes[UTILS_NONNULL 6]) const noexcept;
 
     /**
      * Returns all six frustum planes in left, right, bottom, top, far, near order
      * @return six plane equations encoded as in getNormalizedPlane() in
      *              left, right, bottom, top, far, near order
      */
-    math::float4 const* getNormalizedPlanes() const noexcept { return mPlanes; }
+    math::float4 const* UTILS_NONNULL getNormalizedPlanes() const noexcept { return mPlanes; }
 
     /**
      * Returns whether a box intersects the frustum (i.e. is visible)

filament/include/filament/IndexBuffer.h

@@ -89,8 +89,7 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this IndexBuffer with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          *
          * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of
          *            memory or other resources.
@@ -98,7 +97,7 @@ public:
          *
          * @see IndexBuffer::setBuffer
          */
-        IndexBuffer* build(Engine& engine);
+        IndexBuffer* UTILS_NONNULL build(Engine& engine);
     private:
         friend class FIndexBuffer;
     };

filament/include/filament/IndirectLight.h

@@ -116,7 +116,7 @@ public:
          * @return This Builder, for chaining calls.
          *
          */
-        Builder& reflections(Texture const* cubemap) noexcept;
+        Builder& reflections(Texture const* UTILS_NULLABLE cubemap) noexcept;
 
         /**
          * Sets the irradiance as Spherical Harmonics.
@@ -162,7 +162,7 @@ public:
          * Because the coefficients are pre-scaled, `sh[0]` is the environment's
          * average irradiance.
          */
-        Builder& irradiance(uint8_t bands, math::float3 const* sh) noexcept;
+        Builder& irradiance(uint8_t bands, math::float3 const* UTILS_NONNULL sh) noexcept;
 
         /**
          * Sets the irradiance from the radiance expressed as Spherical Harmonics.
@@ -194,7 +194,7 @@ public:
          *
          * @return This Builder, for chaining calls.
          */
-        Builder& radiance(uint8_t bands, math::float3 const* sh) noexcept;
+        Builder& radiance(uint8_t bands, math::float3 const* UTILS_NONNULL sh) noexcept;
 
         /**
          * Sets the irradiance as a cubemap.
@@ -213,7 +213,7 @@ public:
          *
          * @see irradiance(uint8_t bands, math::float3 const* sh)
          */
-        Builder& irradiance(Texture const* cubemap) noexcept;
+        Builder& irradiance(Texture const* UTILS_NULLABLE cubemap) noexcept;
 
         /**
          * (optional) Environment intensity.
@@ -249,7 +249,7 @@ public:
          *            memory or other resources.
          * @exception utils::PreConditionPanic if a parameter to a builder function was invalid.
          */
-        IndirectLight* build(Engine& engine);
+        IndirectLight* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FIndirectLight;
@@ -286,12 +286,12 @@ public:
     /**
      * Returns the associated reflection map, or null if it does not exist.
      */
-    Texture const* getReflectionsTexture() const noexcept;
+    Texture const* UTILS_NULLABLE getReflectionsTexture() const noexcept;
 
     /**
      * Returns the associated irradiance map, or null if it does not exist.
      */
-    Texture const* getIrradianceTexture() const noexcept;
+    Texture const* UTILS_NULLABLE getIrradianceTexture() const noexcept;
 
     /**
      * Helper to estimate the direction of the dominant light in the environment represented by
@@ -314,7 +314,7 @@ public:
      * @see LightManager::Builder::direction()
      * @see getColorEstimate()
      */
-    static math::float3 getDirectionEstimate(const math::float3 sh[9]) noexcept;
+    static math::float3 getDirectionEstimate(const math::float3 sh[UTILS_NONNULL 9]) noexcept;
 
     /**
      * Helper to estimate the color and relative intensity of the environment represented by
@@ -334,7 +334,8 @@ public:
      * @see LightManager::Builder::intensity()
      * @see getDirectionEstimate, getIntensity, setIntensity
      */
-    static math::float4 getColorEstimate(const math::float3 sh[9], math::float3 direction) noexcept;
+    static math::float4 getColorEstimate(const math::float3 sh[UTILS_NONNULL 9],
+            math::float3 direction) noexcept;
 
 
     /** @deprecated use static versions instead */

filament/include/filament/InstanceBuffer.h

@@ -68,12 +68,12 @@ public:
          * @param localTransforms an array of math::mat4f with length instanceCount, must remain
          *                        valid until after build() is called
          */
-        Builder& localTransforms(math::mat4f const* localTransforms) noexcept;
+        Builder& localTransforms(math::mat4f const* UTILS_NULLABLE localTransforms) noexcept;
 
         /**
          * Creates the InstanceBuffer object and returns a pointer to it.
          */
-        InstanceBuffer* build(Engine& engine);
+        InstanceBuffer* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FInstanceBuffer;
@@ -93,7 +93,8 @@ public:
      * @param count the number of local transforms
      * @param offset index of the first instance to set local transforms
      */
-    void setLocalTransforms(math::mat4f const* localTransforms, size_t count, size_t offset = 0);
+    void setLocalTransforms(math::mat4f const* UTILS_NONNULL localTransforms,
+            size_t count, size_t offset = 0);
 
 protected:
     // prevent heap allocation

filament/include/filament/LightManager.h

@@ -176,7 +176,7 @@ public:
      * Retrieve the Entities of all the components of this manager.
      * @return A list, in no particular order, of all the entities managed by this manager.
      */
-    utils::Entity const* getEntities() const noexcept;
+    utils::Entity const* UTILS_NONNULL getEntities() const noexcept;
 
     /**
      * Gets an Instance representing the Light component associated with the given Entity.
@@ -394,7 +394,7 @@ public:
          *                          positions into
          * @param cascades          the number of shadow cascades, at most 4
          */
-        static void computeUniformSplits(float* splitPositions, uint8_t cascades);
+        static void computeUniformSplits(float* UTILS_NONNULL splitPositions, uint8_t cascades);
 
         /**
          * Utility method to compute ShadowOptions::cascadeSplitPositions according to a logarithmic
@@ -406,7 +406,7 @@ public:
          * @param near              the camera near plane
          * @param far               the camera far plane
          */
-        static void computeLogSplits(float* splitPositions, uint8_t cascades,
+        static void computeLogSplits(float* UTILS_NONNULL splitPositions, uint8_t cascades,
                 float near, float far);
 
         /**
@@ -426,7 +426,7 @@ public:
          * @param lambda            a float in the range [0, 1] that interpolates between log and
          *                          uniform split schemes
          */
-        static void computePracticalSplits(float* splitPositions, uint8_t cascades,
+        static void computePracticalSplits(float* UTILS_NONNULL splitPositions, uint8_t cascades,
                 float near, float far, float lambda);
     };
 

filament/include/filament/Material.h

@@ -74,7 +74,7 @@ public:
      */
     struct ParameterInfo {
         //! Name of the parameter.
-        const char* name;
+        const char* UTILS_NONNULL name;
         //! Whether the parameter is a sampler (texture).
         bool isSampler;
         //! Whether the parameter is a subpass type.
@@ -110,7 +110,7 @@ public:
          * @param payload Pointer to the material data, must stay valid until build() is called.
          * @param size Size of the material data pointed to by "payload" in bytes.
          */
-        Builder& package(const void* payload, size_t size);
+        Builder& package(const void* UTILS_NONNULL payload, size_t size);
 
         template<typename T>
         using is_supported_constant_parameter_t = typename std::enable_if<
@@ -132,11 +132,11 @@ public:
          *              in the material definition.
          */
         template<typename T, typename = is_supported_constant_parameter_t<T>>
-        Builder& constant(const char* name, size_t nameLength, T value);
+        Builder& constant(const char* UTILS_NONNULL name, size_t nameLength, T value);
 
         /** inline helper to provide the constant name as a null-terminated C string */
         template<typename T, typename = is_supported_constant_parameter_t<T>>
-        inline Builder& constant(const char* name, T value) {
+        inline Builder& constant(const char* UTILS_NONNULL name, T value) {
             return constant(name, strlen(name), value);
         }
 
@@ -152,7 +152,7 @@ public:
          *            memory or other resources.
          * @exception utils::PreConditionPanic if a parameter to a builder function was invalid.
          */
-        Material* build(Engine& engine);
+        Material* UTILS_NULLABLE build(Engine& engine);
     private:
         friend class FMaterial;
     };
@@ -198,22 +198,22 @@ public:
      */
     void compile(CompilerPriorityQueue priority,
             UserVariantFilterMask variants,
-            backend::CallbackHandler* handler = nullptr,
-            utils::Invocable<void(Material*)>&& callback = {}) noexcept;
+            backend::CallbackHandler* UTILS_NULLABLE handler = nullptr,
+            utils::Invocable<void(Material* UTILS_NONNULL)>&& callback = {}) noexcept;
 
     inline void compile(CompilerPriorityQueue priority,
             UserVariantFilterBit variants,
-            backend::CallbackHandler* handler = nullptr,
-            utils::Invocable<void(Material*)>&& callback = {}) noexcept {
+            backend::CallbackHandler* UTILS_NULLABLE handler = nullptr,
+            utils::Invocable<void(Material* UTILS_NONNULL)>&& callback = {}) noexcept {
         compile(priority, UserVariantFilterMask(variants), handler,
-                std::forward<utils::Invocable<void(Material*)>>(callback));
+                std::forward<utils::Invocable<void(Material* UTILS_NONNULL)>>(callback));
     }
 
     inline void compile(CompilerPriorityQueue priority,
-            backend::CallbackHandler* handler = nullptr,
-            utils::Invocable<void(Material*)>&& callback = {}) noexcept {
+            backend::CallbackHandler* UTILS_NULLABLE handler = nullptr,
+            utils::Invocable<void(Material* UTILS_NONNULL)>&& callback = {}) noexcept {
         compile(priority, UserVariantFilterBit::ALL, handler,
-                std::forward<utils::Invocable<void(Material*)>>(callback));
+                std::forward<utils::Invocable<void(Material* UTILS_NONNULL)>>(callback));
     }
 
     /**
@@ -225,13 +225,13 @@ public:
      *
      * @return A pointer to the new instance.
      */
-    MaterialInstance* createInstance(const char* name = nullptr) const noexcept;
+    MaterialInstance* UTILS_NONNULL createInstance(const char* UTILS_NULLABLE name = nullptr) const noexcept;
 
     //! Returns the name of this material as a null-terminated string.
-    const char* getName() const noexcept;
+    const char* UTILS_NONNULL getName() const noexcept;
 
     //! Returns the shading model of this material.
-    Shading getShading()  const noexcept;
+    Shading getShading() const noexcept;
 
     //! Returns the interpolation mode of this material. This affects how variables are interpolated.
     Interpolation getInterpolation() const noexcept;
@@ -317,13 +317,13 @@ public:
      *
      * @return The number of parameters written to the parameters pointer.
      */
-    size_t getParameters(ParameterInfo* parameters, size_t count) const noexcept;
+    size_t getParameters(ParameterInfo* UTILS_NONNULL parameters, size_t count) const noexcept;
 
     //! Indicates whether a parameter of the given name exists on this material.
-    bool hasParameter(const char* name) const noexcept;
+    bool hasParameter(const char* UTILS_NONNULL name) const noexcept;
 
     //! Indicates whether an existing parameter is a sampler or not.
-    bool isSampler(const char* name) const noexcept;
+    bool isSampler(const char* UTILS_NONNULL name) const noexcept;
 
     /**
      * Sets the value of the given parameter on this material's default instance.
@@ -334,7 +334,7 @@ public:
      * @see getDefaultInstance()
      */
     template <typename T>
-    void setDefaultParameter(const char* name, T value) noexcept {
+    void setDefaultParameter(const char* UTILS_NONNULL name, T value) noexcept {
         getDefaultInstance()->setParameter(name, value);
     }
 
@@ -347,8 +347,8 @@ public:
      *
      * @see getDefaultInstance()
      */
-    void setDefaultParameter(const char* name, Texture const* texture,
-            TextureSampler const& sampler) noexcept {
+    void setDefaultParameter(const char* UTILS_NONNULL name,
+            Texture const* UTILS_NULLABLE texture, TextureSampler const& sampler) noexcept {
         getDefaultInstance()->setParameter(name, texture, sampler);
     }
 
@@ -361,7 +361,7 @@ public:
      *
      * @see getDefaultInstance()
      */
-    void setDefaultParameter(const char* name, RgbType type, math::float3 color) noexcept {
+    void setDefaultParameter(const char* UTILS_NONNULL name, RgbType type, math::float3 color) noexcept {
         getDefaultInstance()->setParameter(name, type, color);
     }
 
@@ -374,15 +374,15 @@ public:
      *
      * @see getDefaultInstance()
      */
-    void setDefaultParameter(const char* name, RgbaType type, math::float4 color) noexcept {
+    void setDefaultParameter(const char* UTILS_NONNULL name, RgbaType type, math::float4 color) noexcept {
         getDefaultInstance()->setParameter(name, type, color);
     }
 
     //! Returns this material's default instance.
-    MaterialInstance* getDefaultInstance() noexcept;
+    MaterialInstance* UTILS_NONNULL getDefaultInstance() noexcept;
 
     //! Returns this material's default instance.
-    MaterialInstance const* getDefaultInstance() const noexcept;
+    MaterialInstance const* UTILS_NONNULL getDefaultInstance() const noexcept;
 
 protected:
     // prevent heap allocation

filament/include/filament/MaterialInstance.h

@@ -47,7 +47,7 @@ class UTILS_PUBLIC MaterialInstance : public FilamentAPI {
     using StringLiteralHelper = const char[N];
 
     struct StringLiteral {
-        const char* data;
+        const char* UTILS_NONNULL data;
         size_t size;
         template<size_t N>
         StringLiteral(StringLiteralHelper<N> const& s) noexcept // NOLINT(google-explicit-constructor)
@@ -95,17 +95,18 @@ public:
      * @param name  A name for the new MaterialInstance or nullptr to use the template's name
      * @return      A new MaterialInstance
      */
-    static MaterialInstance* duplicate(MaterialInstance const* other, const char* name = nullptr) noexcept;
+    static MaterialInstance* UTILS_NONNULL duplicate(MaterialInstance const* UTILS_NONNULL other,
+            const char* UTILS_NULLABLE name = nullptr) noexcept;
 
     /**
      * @return the Material associated with this instance
      */
-    Material const* getMaterial() const noexcept;
+    Material const* UTILS_NONNULL getMaterial() const noexcept;
 
     /**
      * @return the name associated with this instance
      */
-    const char* getName() const noexcept;
+    const char* UTILS_NONNULL getName() const noexcept;
 
     /**
      * Set a uniform by name
@@ -116,7 +117,7 @@ public:
      * @throws utils::PreConditionPanic if name doesn't exist or no-op if exceptions are disabled.
      */
     template<typename T, typename = is_supported_parameter_t<T>>
-    void setParameter(const char* name, size_t nameLength, T const& value);
+    void setParameter(const char* UTILS_NONNULL name, size_t nameLength, T const& value);
 
     /** inline helper to provide the name as a null-terminated string literal */
     template<typename T, typename = is_supported_parameter_t<T>>
@@ -126,7 +127,7 @@ public:
 
     /** inline helper to provide the name as a null-terminated C string */
     template<typename T, typename = is_supported_parameter_t<T>>
-    inline void setParameter(const char* name, T const& value) {
+    inline void setParameter(const char* UTILS_NONNULL name, T const& value) {
         setParameter<T>(name, strlen(name), value);
     }
 
@@ -141,17 +142,19 @@ public:
      * @throws utils::PreConditionPanic if name doesn't exist or no-op if exceptions are disabled.
      */
     template<typename T, typename = is_supported_parameter_t<T>>
-    void setParameter(const char* name, size_t nameLength, const T* values, size_t count);
+    void setParameter(const char* UTILS_NONNULL name, size_t nameLength,
+            const T* UTILS_NONNULL values, size_t count);
 
     /** inline helper to provide the name as a null-terminated string literal */
     template<typename T, typename = is_supported_parameter_t<T>>
-    inline void setParameter(StringLiteral name, const T* values, size_t count) {
+    inline void setParameter(StringLiteral name, const T* UTILS_NONNULL values, size_t count) {
         setParameter<T>(name.data, name.size, values, count);
     }
 
     /** inline helper to provide the name as a null-terminated C string */
     template<typename T, typename = is_supported_parameter_t<T>>
-    inline void setParameter(const char* name, const T* values, size_t count) {
+    inline void setParameter(const char* UTILS_NONNULL name,
+            const T* UTILS_NONNULL values, size_t count) {
         setParameter<T>(name, strlen(name), values, count);
     }
 
@@ -168,18 +171,18 @@ public:
      * @param sampler       Sampler parameters.
      * @throws utils::PreConditionPanic if name doesn't exist or no-op if exceptions are disabled.
      */
-    void setParameter(const char* name, size_t nameLength,
-            Texture const* texture, TextureSampler const& sampler);
+    void setParameter(const char* UTILS_NONNULL name, size_t nameLength,
+            Texture const* UTILS_NULLABLE texture, TextureSampler const& sampler);
 
     /** inline helper to provide the name as a null-terminated string literal */
     inline void setParameter(StringLiteral name,
-            Texture const* texture, TextureSampler const& sampler) {
+            Texture const* UTILS_NULLABLE texture, TextureSampler const& sampler) {
         setParameter(name.data, name.size, texture, sampler);
     }
 
     /** inline helper to provide the name as a null-terminated C string */
-    inline void setParameter(const char* name,
-            Texture const* texture, TextureSampler const& sampler) {
+    inline void setParameter(const char* UTILS_NONNULL name,
+            Texture const* UTILS_NULLABLE texture, TextureSampler const& sampler) {
         setParameter(name, strlen(name), texture, sampler);
     }
 
@@ -194,7 +197,8 @@ public:
      * @param color         Array of read, green, blue channels values.
      * @throws utils::PreConditionPanic if name doesn't exist or no-op if exceptions are disabled.
      */
-    void setParameter(const char* name, size_t nameLength, RgbType type, math::float3 color);
+    void setParameter(const char* UTILS_NONNULL name, size_t nameLength,
+            RgbType type, math::float3 color);
 
     /** inline helper to provide the name as a null-terminated string literal */
     inline void setParameter(StringLiteral name, RgbType type, math::float3 color) {
@@ -202,7 +206,7 @@ public:
     }
 
     /** inline helper to provide the name as a null-terminated C string */
-    inline void setParameter(const char* name, RgbType type, math::float3 color) {
+    inline void setParameter(const char* UTILS_NONNULL name, RgbType type, math::float3 color) {
         setParameter(name, strlen(name), type, color);
     }
 
@@ -217,7 +221,8 @@ public:
      * @param color         Array of read, green, blue and alpha channels values.
      * @throws utils::PreConditionPanic if name doesn't exist or no-op if exceptions are disabled.
      */
-    void setParameter(const char* name, size_t nameLength, RgbaType type, math::float4 color);
+    void setParameter(const char* UTILS_NONNULL name, size_t nameLength,
+            RgbaType type, math::float4 color);
 
     /** inline helper to provide the name as a null-terminated string literal */
     inline void setParameter(StringLiteral name, RgbaType type, math::float4 color) {
@@ -225,7 +230,7 @@ public:
     }
 
     /** inline helper to provide the name as a null-terminated C string */
-    inline void setParameter(const char* name, RgbaType type, math::float4 color) {
+    inline void setParameter(const char* UTILS_NONNULL name, RgbaType type, math::float4 color) {
         setParameter(name, strlen(name), type, color);
     }
 

filament/include/filament/MorphTargetBuffer.h

@@ -68,14 +68,13 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this MorphTargetBuffer with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          *
          * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of
          *            memory or other resources.
          * @exception utils::PreConditionPanic if a parameter to a builder function was invalid.
          */
-        MorphTargetBuffer* build(Engine& engine);
+        MorphTargetBuffer* UTILS_NONNULL build(Engine& engine);
     private:
         friend class FMorphTargetBuffer;
     };
@@ -95,7 +94,7 @@ public:
      * @see setTangentsAt
      */
     void setPositionsAt(Engine& engine, size_t targetIndex,
-            math::float3 const* positions, size_t count, size_t offset = 0);
+            math::float3 const* UTILS_NONNULL positions, size_t count, size_t offset = 0);
 
     /**
      * Updates positions for the given morph target.
@@ -110,7 +109,7 @@ public:
      * @see setTangentsAt
      */
     void setPositionsAt(Engine& engine, size_t targetIndex,
-            math::float4 const* positions, size_t count, size_t offset = 0);
+            math::float4 const* UTILS_NONNULL positions, size_t count, size_t offset = 0);
 
     /**
      * Updates tangents for the given morph target.
@@ -126,7 +125,7 @@ public:
      * @see setPositionsAt
      */
     void setTangentsAt(Engine& engine, size_t targetIndex,
-            math::short4 const* tangents, size_t count, size_t offset = 0);
+            math::short4 const* UTILS_NONNULL tangents, size_t count, size_t offset = 0);
 
     /**
      * Returns the vertex count of this MorphTargetBuffer.

filament/include/filament/RenderTarget.h

@@ -106,7 +106,7 @@ public:
          * @param texture The associated texture object.
          * @return A reference to this Builder for chaining calls.
          */
-        Builder& texture(AttachmentPoint attachment, Texture* texture) noexcept;
+        Builder& texture(AttachmentPoint attachment, Texture* UTILS_NULLABLE texture) noexcept;
 
         /**
          * Sets the mipmap level for a given attachment point.
@@ -138,10 +138,9 @@ public:
         /**
          * Creates the RenderTarget object and returns a pointer to it.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          */
-        RenderTarget* build(Engine& engine);
+        RenderTarget* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FRenderTarget;
@@ -152,7 +151,7 @@ public:
      * @param attachment Attachment point
      * @return A Texture object or nullptr if no texture is set for this attachment point
      */
-    Texture* getTexture(AttachmentPoint attachment) const noexcept;
+    Texture* UTILS_NULLABLE getTexture(AttachmentPoint attachment) const noexcept;
 
     /**
      * Returns the mipmap level set on the given attachment point

filament/include/filament/RenderableManager.h

@@ -129,7 +129,7 @@ public:
      * Retrieve the Entities of all the components of this manager.
      * @return A list, in no particular order, of all the entities managed by this manager.
      */
-    utils::Entity const* getEntities() const noexcept;
+    utils::Entity const* UTILS_NONNULL getEntities() const noexcept;
 
     /**
      * The transformation associated with a skinning joint.
@@ -190,9 +190,19 @@ public:
          * @param maxIndex specifies the maximum index contained in the index buffer
          * @param count number of indices to read (for triangles, this should be a multiple of 3)
          */
-        Builder& geometry(size_t index, PrimitiveType type, VertexBuffer* vertices, IndexBuffer* indices, size_t offset, size_t minIndex, size_t maxIndex, size_t count) noexcept;
-        Builder& geometry(size_t index, PrimitiveType type, VertexBuffer* vertices, IndexBuffer* indices, size_t offset, size_t count) noexcept; //!< \overload
-        Builder& geometry(size_t index, PrimitiveType type, VertexBuffer* vertices, IndexBuffer* indices) noexcept; //!< \overload
+        Builder& geometry(size_t index, PrimitiveType type,
+                VertexBuffer* UTILS_NONNULL vertices,
+                IndexBuffer* UTILS_NONNULL indices,
+                size_t offset, size_t minIndex, size_t maxIndex, size_t count) noexcept;
+
+        Builder& geometry(size_t index, PrimitiveType type,
+                VertexBuffer* UTILS_NONNULL vertices,
+                IndexBuffer* UTILS_NONNULL indices,
+                size_t offset, size_t count) noexcept; //!< \overload
+
+        Builder& geometry(size_t index, PrimitiveType type,
+                VertexBuffer* UTILS_NONNULL vertices,
+                IndexBuffer* UTILS_NONNULL indices) noexcept; //!< \overload
 
         /**
          * Binds a material instance to the specified primitive.
@@ -209,7 +219,8 @@ public:
          *
          * @see Engine::setActiveFeatureLevel
          */
-        Builder& material(size_t index, MaterialInstance const* materialInstance) noexcept;
+        Builder& material(size_t index,
+                MaterialInstance const* UTILS_NONNULL materialInstance) noexcept;
 
         /**
          * The axis-aligned bounding box of the renderable.
@@ -357,7 +368,8 @@ public:
          * @param count 0 to disable, otherwise the number of bone transforms (up to 255)
          * @param offset offset in the SkinningBuffer
          */
-        Builder& skinning(SkinningBuffer* skinningBuffer, size_t count, size_t offset) noexcept;
+        Builder& skinning(SkinningBuffer* UTILS_NONNULL skinningBuffer,
+                size_t count, size_t offset) noexcept;
 
 
         /**
@@ -375,8 +387,8 @@ public:
          * @param boneCount 0 to disable, otherwise the number of bone transforms (up to 255)
          * @param transforms the initial set of transforms (one for each bone)
          */
-        Builder& skinning(size_t boneCount, math::mat4f const* transforms) noexcept;
-        Builder& skinning(size_t boneCount, Bone const* bones) noexcept; //!< \overload
+        Builder& skinning(size_t boneCount, math::mat4f const* UTILS_NONNULL transforms) noexcept;
+        Builder& skinning(size_t boneCount, Bone const* UTILS_NONNULL bones) noexcept; //!< \overload
         Builder& skinning(size_t boneCount) noexcept; //!< \overload
 
         /**
@@ -405,7 +417,8 @@ public:
          * @see VertexBuffer:Builder:advancedSkinning
          */
         Builder& boneIndicesAndWeights(size_t primitiveIndex,
-                math::float2 const* indicesAndWeights, size_t count, size_t bonesPerVertex) noexcept;
+                math::float2 const* UTILS_NONNULL indicesAndWeights,
+                size_t count, size_t bonesPerVertex) noexcept;
 
         /**
          * Define bone indices and weights "pairs" for vertex skinning as a float2.
@@ -468,10 +481,11 @@ public:
          * @param count number of vertices in the morph target buffer to read, must equal the geometry's count (for triangles, this should be a multiple of 3)
          */
         Builder& morphing(uint8_t level, size_t primitiveIndex,
-                MorphTargetBuffer* morphTargetBuffer, size_t offset, size_t count) noexcept;
+                MorphTargetBuffer* UTILS_NONNULL morphTargetBuffer,
+                size_t offset, size_t count) noexcept;
 
         inline Builder& morphing(uint8_t level, size_t primitiveIndex,
-                MorphTargetBuffer* morphTargetBuffer) noexcept;
+                MorphTargetBuffer* UTILS_NONNULL morphTargetBuffer) noexcept;
 
         /**
          * Sets the drawing order for blended primitives. The drawing order is either global or
@@ -538,7 +552,8 @@ public:
          *                      the result of Engine::getMaxAutomaticInstances().
          * @param instanceBuffer an InstanceBuffer containing at least instanceCount transforms
          */
-        Builder& instances(size_t instanceCount, InstanceBuffer* instanceBuffer) noexcept;
+        Builder& instances(size_t instanceCount,
+                InstanceBuffer* UTILS_NONNULL instanceBuffer) noexcept;
 
         /**
          * Adds the Renderable component to an entity.
@@ -565,18 +580,18 @@ public:
         friend class FRenderPrimitive;
         friend class FRenderableManager;
         struct Entry {
-            VertexBuffer* vertices = nullptr;
-            IndexBuffer* indices = nullptr;
+            VertexBuffer* UTILS_NULLABLE vertices = nullptr;
+            IndexBuffer* UTILS_NULLABLE indices = nullptr;
             size_t offset = 0;
             size_t minIndex = 0;
             size_t maxIndex = 0;
             size_t count = 0;
-            MaterialInstance const* materialInstance = nullptr;
+            MaterialInstance const* UTILS_NULLABLE materialInstance = nullptr;
             PrimitiveType type = PrimitiveType::TRIANGLES;
             uint16_t blendOrder = 0;
             bool globalBlendOrderEnabled = false;
             struct {
-                MorphTargetBuffer* buffer = nullptr;
+                MorphTargetBuffer* UTILS_NULLABLE buffer = nullptr;
                 size_t offset = 0;
                 size_t count = 0;
             } morphing;
@@ -694,8 +709,11 @@ public:
      * Updates the bone transforms in the range [offset, offset + boneCount).
      * The bones must be pre-allocated using Builder::skinning().
      */
-    void setBones(Instance instance, Bone const* transforms, size_t boneCount = 1, size_t offset = 0);
-    void setBones(Instance instance, math::mat4f const* transforms, size_t boneCount = 1, size_t offset = 0); //!< \overload
+    void setBones(Instance instance, Bone const* UTILS_NONNULL transforms,
+            size_t boneCount = 1, size_t offset = 0);
+
+    void setBones(Instance instance, math::mat4f const* UTILS_NONNULL transforms,
+            size_t boneCount = 1, size_t offset = 0); //!< \overload
 
     /**
      * Associates a region of a SkinningBuffer to a renderable instance
@@ -708,7 +726,7 @@ public:
      * @param count             Size of the region in bones, must be smaller or equal to 256.
      * @param offset            Start offset of the region in bones
      */
-    void setSkinningBuffer(Instance instance, SkinningBuffer* skinningBuffer,
+    void setSkinningBuffer(Instance instance, SkinningBuffer* UTILS_NONNULL skinningBuffer,
             size_t count, size_t offset);
 
     /**
@@ -723,24 +741,25 @@ public:
      * @param offset Index of the first morph target weight to set at instance.
      */
     void setMorphWeights(Instance instance,
-            float const* weights, size_t count, size_t offset = 0);
+            float const* UTILS_NONNULL weights, size_t count, size_t offset = 0);
 
     /**
      * Associates a MorphTargetBuffer to the given primitive.
      */
     void setMorphTargetBufferAt(Instance instance, uint8_t level, size_t primitiveIndex,
-            MorphTargetBuffer* morphTargetBuffer, size_t offset, size_t count);
+            MorphTargetBuffer* UTILS_NONNULL morphTargetBuffer, size_t offset, size_t count);
 
     /**
      * Utility method to change a MorphTargetBuffer to the given primitive
      */
     inline void setMorphTargetBufferAt(Instance instance, uint8_t level, size_t primitiveIndex,
-            MorphTargetBuffer* morphTargetBuffer);
+            MorphTargetBuffer* UTILS_NONNULL morphTargetBuffer);
 
     /**
      * Get a MorphTargetBuffer to the given primitive or null if it doesn't exist.
      */
-    MorphTargetBuffer* getMorphTargetBufferAt(Instance instance, uint8_t level, size_t primitiveIndex) const noexcept;
+    MorphTargetBuffer* UTILS_NULLABLE getMorphTargetBufferAt(Instance instance,
+            uint8_t level, size_t primitiveIndex) const noexcept;
 
     /**
      * Gets the number of morphing in the given entity.
@@ -782,20 +801,22 @@ public:
      * @see Engine::setActiveFeatureLevel
      */
     void setMaterialInstanceAt(Instance instance,
-            size_t primitiveIndex, MaterialInstance const* materialInstance);
+            size_t primitiveIndex, MaterialInstance const* UTILS_NONNULL materialInstance);
 
     /**
      * Retrieves the material instance that is bound to the given primitive.
      */
-    MaterialInstance* getMaterialInstanceAt(Instance instance, size_t primitiveIndex) const noexcept;
+    MaterialInstance* UTILS_NULLABLE getMaterialInstanceAt(
+            Instance instance, size_t primitiveIndex) const noexcept;
 
     /**
      * Changes the geometry for the given primitive.
      *
      * \see Builder::geometry()
      */
-    void setGeometryAt(Instance instance, size_t primitiveIndex,
-            PrimitiveType type, VertexBuffer* vertices, IndexBuffer* indices,
+    void setGeometryAt(Instance instance, size_t primitiveIndex, PrimitiveType type,
+            VertexBuffer* UTILS_NONNULL vertices,
+            IndexBuffer* UTILS_NONNULL indices,
             size_t offset, size_t count) noexcept;
 
     /**
@@ -856,7 +877,9 @@ public:
     template<typename VECTOR, typename INDEX,
             typename = typename is_supported_vector_type<VECTOR>::type,
             typename = typename is_supported_index_type<INDEX>::type>
-    static Box computeAABB(VECTOR const* vertices, INDEX const* indices, size_t count,
+    static Box computeAABB(
+            VECTOR const* UTILS_NONNULL vertices,
+            INDEX const* UTILS_NONNULL indices, size_t count,
             size_t stride = sizeof(VECTOR)) noexcept;
 
 protected:
@@ -864,21 +887,25 @@ protected:
     ~RenderableManager() = default;
 };
 
-RenderableManager::Builder& RenderableManager::Builder::morphing(uint8_t level, size_t primitiveIndex,
-        MorphTargetBuffer* morphTargetBuffer) noexcept {
+RenderableManager::Builder& RenderableManager::Builder::morphing(
+        uint8_t level, size_t primitiveIndex,
+        MorphTargetBuffer* UTILS_NONNULL morphTargetBuffer) noexcept {
     return morphing(level, primitiveIndex, morphTargetBuffer, 0,
             morphTargetBuffer->getVertexCount());
 }
 
-void RenderableManager::setMorphTargetBufferAt(Instance instance, uint8_t level, size_t primitiveIndex,
-        MorphTargetBuffer* morphTargetBuffer) {
+void RenderableManager::setMorphTargetBufferAt(
+        Instance instance, uint8_t level, size_t primitiveIndex,
+        MorphTargetBuffer* UTILS_NONNULL morphTargetBuffer) {
     setMorphTargetBufferAt(instance, level, primitiveIndex, morphTargetBuffer, 0,
             morphTargetBuffer->getVertexCount());
 }
 
 template<typename VECTOR, typename INDEX, typename, typename>
-Box RenderableManager::computeAABB(VECTOR const* vertices, INDEX const* indices, size_t count,
-        size_t stride) noexcept {
+Box RenderableManager::computeAABB(
+        VECTOR const* UTILS_NONNULL vertices,
+        INDEX const* UTILS_NONNULL indices,
+        size_t count, size_t stride) noexcept {
     math::float3 bmin(FLT_MAX);
     math::float3 bmax(-FLT_MAX);
     for (size_t i = 0; i < count; ++i) {

filament/include/filament/Renderer.h

@@ -181,14 +181,14 @@ public:
      *
      * @return A pointer to the Engine instance this Renderer is associated to.
      */
-    Engine* getEngine() noexcept;
+    Engine* UTILS_NONNULL getEngine() noexcept;
 
     /**
      * Get the Engine that created this Renderer.
      *
      * @return A constant pointer to the Engine instance this Renderer is associated to.
      */
-    inline Engine const* getEngine() const noexcept {
+    inline Engine const* UTILS_NONNULL getEngine() const noexcept {
         return const_cast<Renderer *>(this)->getEngine();
     }
 
@@ -264,7 +264,7 @@ public:
      * @see
      * endFrame()
      */
-    bool beginFrame(SwapChain* swapChain,
+    bool beginFrame(SwapChain* UTILS_NONNULL swapChain,
             uint64_t vsyncSteadyClockTimeNano = 0u);
 
     /**
@@ -335,7 +335,7 @@ public:
      * beginFrame(), endFrame(), View
      *
      */
-    void render(View const* view);
+    void render(View const* UTILS_NONNULL view);
 
     /**
      * Copy the currently rendered view to the indicated swap chain, using the
@@ -350,7 +350,7 @@ public:
      * copyFrame() should be called after a frame is rendered using render()
      * but before endFrame() is called.
      */
-    void copyFrame(SwapChain* dstSwapChain, Viewport const& dstViewport,
+    void copyFrame(SwapChain* UTILS_NONNULL dstSwapChain, Viewport const& dstViewport,
             Viewport const& srcViewport, uint32_t flags = 0);
 
     /**
@@ -490,7 +490,7 @@ public:
      * readPixels() is intended for debugging and testing. It will impact performance significantly.
      *
      */
-    void readPixels(RenderTarget* renderTarget,
+    void readPixels(RenderTarget* UTILS_NONNULL renderTarget,
             uint32_t xoffset, uint32_t yoffset, uint32_t width, uint32_t height,
             backend::PixelBufferDescriptor&& buffer);
 
@@ -517,7 +517,7 @@ public:
      * However, internally, renderStandaloneView() is highly multi-threaded to both improve
      * performance in mitigate the call's latency.
      */
-    void renderStandaloneView(View const* view);
+    void renderStandaloneView(View const* UTILS_NONNULL view);
 
 
     /**

filament/include/filament/Scene.h

@@ -75,14 +75,14 @@ public:
      *
      * @param skybox The Skybox to use to fill untouched pixels, or nullptr to unset the Skybox.
      */
-    void setSkybox(Skybox* skybox) noexcept;
+    void setSkybox(Skybox* UTILS_NULLABLE skybox) noexcept;
 
     /**
      * Returns the Skybox associated with the Scene.
      *
      * @return The associated Skybox, or nullptr if there is none.
      */
-    Skybox* getSkybox() const noexcept;
+    Skybox* UTILS_NULLABLE getSkybox() const noexcept;
 
     /**
      * Set the IndirectLight to use when rendering the Scene.
@@ -93,7 +93,7 @@ public:
      * @param ibl The IndirectLight to use when rendering the Scene or nullptr to unset.
      * @see getIndirectLight
      */
-    void setIndirectLight(IndirectLight* ibl) noexcept;
+    void setIndirectLight(IndirectLight* UTILS_NULLABLE ibl) noexcept;
 
     /**
      * Get the IndirectLight or nullptr if none is set.
@@ -101,7 +101,7 @@ public:
      * @return the the IndirectLight or nullptr if none is set
      * @see setIndirectLight
      */
-    IndirectLight* getIndirectLight() const noexcept;
+    IndirectLight* UTILS_NULLABLE getIndirectLight() const noexcept;
 
     /**
      * Adds an Entity to the Scene.
@@ -120,7 +120,7 @@ public:
      * @param entities Array containing entities to add to the scene.
      * @param count Size of the entity array.
      */
-    void addEntities(const utils::Entity* entities, size_t count);
+    void addEntities(const utils::Entity* UTILS_NONNULL entities, size_t count);
 
     /**
      * Removes the Renderable from the Scene.
@@ -139,7 +139,7 @@ public:
      * @param entities Array containing entities to remove from the scene.
      * @param count Size of the entity array.
      */
-    void removeEntities(const utils::Entity* entities, size_t count);
+    void removeEntities(const utils::Entity* UTILS_NONNULL entities, size_t count);
 
     /**
      * Returns the total number of Entities in the Scene, whether alive or not.

filament/include/filament/SkinningBuffer.h

@@ -74,8 +74,7 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this SkinningBuffer with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          *
          * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of
          *            memory or other resources.
@@ -83,7 +82,7 @@ public:
          *
          * @see SkinningBuffer::setBones
          */
-        SkinningBuffer* build(Engine& engine);
+        SkinningBuffer* UTILS_NONNULL build(Engine& engine);
     private:
         friend class FSkinningBuffer;
     };
@@ -96,7 +95,7 @@ public:
      * @param offset offset in elements (not bytes) in the SkinningBuffer (not in transforms)
      * @see RenderableManager::setSkinningBuffer
      */
-    void setBones(Engine& engine, RenderableManager::Bone const* transforms,
+    void setBones(Engine& engine, RenderableManager::Bone const* UTILS_NONNULL transforms,
             size_t count, size_t offset = 0);
 
     /**
@@ -107,7 +106,7 @@ public:
      * @param offset offset in elements (not bytes) in the SkinningBuffer (not in transforms)
      * @see RenderableManager::setSkinningBuffer
      */
-    void setBones(Engine& engine, math::mat4f const* transforms,
+    void setBones(Engine& engine, math::mat4f const* UTILS_NONNULL transforms,
             size_t count, size_t offset = 0);
 
     /**

filament/include/filament/Skybox.h

@@ -92,7 +92,7 @@ public:
          *
          * @see Texture
          */
-        Builder& environment(Texture* cubemap) noexcept;
+        Builder& environment(Texture* UTILS_NONNULL cubemap) noexcept;
 
         /**
          * Indicates whether the sun should be rendered. The sun can only be
@@ -136,9 +136,9 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this Skybox with.
          *
-         * @return pointer to the newly created object, or nullptr if the light couldn't be created.
+         * @return pointer to the newly created object.
          */
-        Skybox* build(Engine& engine);
+        Skybox* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FSkybox;
@@ -172,9 +172,9 @@ public:
     float getIntensity() const noexcept;
 
     /**
-     * @return the associated texture, or null if it does not exist
+     * @return the associated texture
      */
-    Texture const* getTexture() const noexcept;
+    Texture const* UTILS_NONNULL getTexture() const noexcept;
 
 protected:
     // prevent heap allocation

filament/include/filament/Stream.h

@@ -114,7 +114,7 @@ public:
          *
          * @return This Builder, for chaining calls.
          */
-        Builder& stream(void* stream) noexcept;
+        Builder& stream(void* UTILS_NULLABLE stream) noexcept;
 
         /**
          *
@@ -141,9 +141,9 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this Stream with.
          *
-         * @return pointer to the newly created object, or nullptr if the stream couldn't be created.
+         * @return pointer to the newly created object.
          */
-        Stream* build(Engine& engine);
+        Stream* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FStream;
@@ -171,11 +171,12 @@ public:
      *
      * @param image      Pointer to AHardwareBuffer, casted to void* since this is a public header.
      * @param callback   This is triggered by Filament when it wishes to release the image.
-     *                   It callback tales two arguments: the AHardwareBuffer and the userdata.
+     *                   The callback tales two arguments: the AHardwareBuffer and the userdata.
      * @param userdata   Optional closure data. Filament will pass this into the callback when it
      *                   releases the image.
      */
-    void setAcquiredImage(void* image, Callback callback, void* userdata) noexcept;
+    void setAcquiredImage(void* UTILS_NONNULL image,
+            Callback UTILS_NONNULL callback, void* UTILS_NULLABLE userdata) noexcept;
 
     /**
      * @see setAcquiredImage(void*, Callback, void*)
@@ -187,7 +188,9 @@ public:
      * @param userdata   Optional closure data. Filament will pass this into the callback when it
      *                   releases the image.
      */
-    void setAcquiredImage(void* image, backend::CallbackHandler* handler, Callback callback, void* userdata) noexcept;
+    void setAcquiredImage(void* UTILS_NONNULL image,
+            backend::CallbackHandler* UTILS_NULLABLE handler,
+            Callback UTILS_NONNULL callback, void* UTILS_NULLABLE userdata) noexcept;
 
     /**
      * Updates the size of the incoming stream. Whether this value is used is

filament/include/filament/SwapChain.h

@@ -152,7 +152,7 @@ class Engine;
 class UTILS_PUBLIC SwapChain : public FilamentAPI {
 public:
     using FrameScheduledCallback = backend::FrameScheduledCallback;
-    using FrameCompletedCallback = utils::Invocable<void(SwapChain*)>;
+    using FrameCompletedCallback = utils::Invocable<void(SwapChain* UTILS_NONNULL)>;
 
     /**
      * Requests a SwapChain with an alpha channel.
@@ -236,7 +236,7 @@ public:
      */
     static bool isSRGBSwapChainSupported(Engine& engine) noexcept;
 
-    void* getNativeWindow() const noexcept;
+    void* UTILS_NULLABLE getNativeWindow() const noexcept;
 
     /**
      * FrameScheduledCallback is a callback function that notifies an application when Filament has
@@ -269,7 +269,8 @@ public:
      *
      * @see PresentCallable
      */
-    void setFrameScheduledCallback(FrameScheduledCallback callback, void* user = nullptr);
+    void setFrameScheduledCallback(FrameScheduledCallback UTILS_NULLABLE callback,
+            void* UTILS_NULLABLE user = nullptr);
 
     /**
      * FrameCompletedCallback is a callback function that notifies an application when a frame's
@@ -290,7 +291,7 @@ public:
      *
      * @see CallbackHandler
      */
-    void setFrameCompletedCallback(backend::CallbackHandler* handler = nullptr,
+    void setFrameCompletedCallback(backend::CallbackHandler* UTILS_NULLABLE handler = nullptr,
             FrameCompletedCallback&& callback = {}) noexcept;
 
 

filament/include/filament/Texture.h

@@ -204,14 +204,13 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this Texture with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          *
          * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of
          *            memory or other resources.
          * @exception utils::PreConditionPanic if a parameter to a builder function was invalid.
          */
-        Texture* build(Engine& engine);
+        Texture* UTILS_NONNULL build(Engine& engine);
 
         /* no user serviceable parts below */
 
@@ -400,7 +399,7 @@ public:
      * @see Builder::sampler()
      *
      */
-    void setExternalImage(Engine& engine, void* image) noexcept;
+    void setExternalImage(Engine& engine, void* UTILS_NONNULL image) noexcept;
 
     /**
      * Specify the external image and plane to associate with this Texture. Typically the external
@@ -431,7 +430,7 @@ public:
      *                      kCVPixelFormatType_420YpCbCr8BiPlanarFullRange images. On platforms
      *                      other than iOS, this method is a no-op.
      */
-    void setExternalImage(Engine& engine, void* image, size_t plane) noexcept;
+    void setExternalImage(Engine& engine, void* UTILS_NONNULL image, size_t plane) noexcept;
 
     /**
      * Specify the external stream to associate with this Texture. Typically the external
@@ -450,7 +449,7 @@ public:
      * @see Builder::sampler(), Stream
      *
      */
-    void setExternalStream(Engine& engine, Stream* stream) noexcept;
+    void setExternalStream(Engine& engine, Stream* UTILS_NULLABLE stream) noexcept;
 
     /**
      * Generates all the mipmap levels automatically. This requires the texture to have a
@@ -500,7 +499,7 @@ public:
      */
     void generatePrefilterMipmap(Engine& engine,
             PixelBufferDescriptor&& buffer, const FaceOffsets& faceOffsets,
-            PrefilterOptions const* options = nullptr);
+            PrefilterOptions const* UTILS_NULLABLE options = nullptr);
 
 
     /** @deprecated */

filament/include/filament/TransformManager.h

@@ -140,7 +140,7 @@ public:
      * Retrieve the Entities of all the components of this manager.
      * @return A list, in no particular order, of all the entities managed by this manager.
      */
-    utils::Entity const* getEntities() const noexcept;
+    utils::Entity const* UTILS_NONNULL getEntities() const noexcept;
 
     /**
      * Enables or disable the accurate translation mode. Disabled by default.
@@ -224,7 +224,7 @@ public:
      * @param count The maximum number of children to retrieve.
      * @return The number of children written to the pointer.
      */
-    size_t getChildren(Instance i, utils::Entity* children, size_t count) const noexcept;
+    size_t getChildren(Instance i, utils::Entity* UTILS_NONNULL children, size_t count) const noexcept;
 
     /**
      * Returns an iterator to the Instance of the first child of the given parent.

filament/include/filament/VertexBuffer.h

@@ -163,14 +163,13 @@ public:
          *
          * @param engine Reference to the filament::Engine to associate this VertexBuffer with.
          *
-         * @return pointer to the newly created object or nullptr if exceptions are disabled and
-         *         an error occurred.
+         * @return pointer to the newly created object.
          *
          * @exception utils::PostConditionPanic if a runtime error occurred, such as running out of
          *            memory or other resources.
          * @exception utils::PreConditionPanic if a parameter to a builder function was invalid.
          */
-        VertexBuffer* build(Engine& engine);
+        VertexBuffer* UTILS_NONNULL build(Engine& engine);
 
     private:
         friend class FVertexBuffer;
@@ -209,7 +208,8 @@ public:
      *                    and Builder::bufferCount() - 1.
      * @param bufferObject The handle to the GPU data that will be used in this buffer slot.
      */
-    void setBufferObjectAt(Engine& engine, uint8_t bufferIndex, BufferObject const* bufferObject);
+    void setBufferObjectAt(Engine& engine, uint8_t bufferIndex,
+            BufferObject const*  UTILS_NONNULL bufferObject);
 
 protected:
     // prevent heap allocation

filament/include/filament/View.h

@@ -93,7 +93,7 @@ public:
      * Sets the View's name. Only useful for debugging.
      * @param name Pointer to the View's name. The string is copied.
      */
-    void setName(const char* name) noexcept;
+    void setName(const char* UTILS_NONNULL name) noexcept;
 
     /**
      * Returns the View's name
@@ -102,7 +102,7 @@ public:
      *
      * @attention Do *not* free the pointer or modify its content.
      */
-    const char* getName() const noexcept;
+    const char* UTILS_NULLABLE getName() const noexcept;
 
     /**
      * Set this View instance's Scene.
@@ -118,19 +118,19 @@ public:
      *  There is no reference-counting.
      *  Make sure to dissociate a Scene from all Views before destroying it.
      */
-    void setScene(Scene* scene);
+    void setScene(Scene* UTILS_NULLABLE scene);
 
     /**
      * Returns the Scene currently associated with this View.
      * @return A pointer to the Scene associated to this View. nullptr if no Scene is set.
      */
-    Scene* getScene() noexcept;
+    Scene* UTILS_NULLABLE getScene() noexcept;
 
     /**
      * Returns the Scene currently associated with this View.
      * @return A pointer to the Scene associated to this View. nullptr if no Scene is set.
      */
-    Scene const* getScene() const noexcept {
+    Scene const* UTILS_NULLABLE getScene() const noexcept {
         return const_cast<View*>(this)->getScene();
     }
 
@@ -145,7 +145,7 @@ public:
      *
      * @param renderTarget Render target associated with view, or nullptr for the swap chain.
      */
-    void setRenderTarget(RenderTarget* renderTarget) noexcept;
+    void setRenderTarget(RenderTarget* UTILS_NULLABLE renderTarget) noexcept;
 
     /**
      * Gets the offscreen render target associated with this view.
@@ -154,7 +154,7 @@ public:
      *
      * @see setRenderTarget
      */
-    RenderTarget* getRenderTarget() const noexcept;
+    RenderTarget* UTILS_NULLABLE getRenderTarget() const noexcept;
 
     /**
      * Sets the rectangular region to render to.
@@ -187,7 +187,7 @@ public:
      *  There is no reference-counting.
      *  Make sure to dissociate a Camera from all Views before destroying it.
      */
-    void setCamera(Camera* camera) noexcept;
+    void setCamera(Camera* UTILS_NONNULL camera) noexcept;
 
     /**
      * Returns the Camera currently associated with this View.
@@ -404,13 +404,13 @@ public:
      *  There is no reference-counting.
      *  Make sure to dissociate a ColorGrading from all Views before destroying it.
      */
-    void setColorGrading(ColorGrading* colorGrading) noexcept;
+    void setColorGrading(ColorGrading* UTILS_NULLABLE colorGrading) noexcept;
 
     /**
      * Returns the color grading transforms currently associated to this view.
      * @return A pointer to the ColorGrading associated to this View.
      */
-    const ColorGrading* getColorGrading() const noexcept;
+    const ColorGrading* UTILS_NULLABLE getColorGrading() const noexcept;
 
     /**
      * Sets ambient occlusion options.
@@ -716,10 +716,10 @@ public:
     bool isFrustumCullingEnabled() const noexcept;
 
     //! debugging: sets the Camera used for rendering. It may be different from the culling camera.
-    void setDebugCamera(Camera* camera) noexcept;
+    void setDebugCamera(Camera* UTILS_NULLABLE camera) noexcept;
 
     //! debugging: returns a Camera from the point of view of *the* dominant directional light used for shadowing.
-    Camera const* getDirectionalLightCamera() const noexcept;
+    Camera const* UTILS_NULLABLE getDirectionalLightCamera() const noexcept;
 
 
     /** Result of a picking query */
@@ -748,11 +748,12 @@ public:
     /** User data for PickingQueryResultCallback */
     struct PickingQuery {
         // note: this is enough to store a std::function<> -- just saying...
-        void* storage[4];
+        void* UTILS_NULLABLE storage[4];
     };
 
     /** callback type used for picking queries. */
-    using PickingQueryResultCallback = void(*)(PickingQueryResult const& result, PickingQuery* pq);
+    using PickingQueryResultCallback =
+            void(*)(PickingQueryResult const& result, PickingQuery* UTILS_NONNULL pq);
 
     /**
      * Helper for creating a picking query from Foo::method, by pointer.
@@ -766,8 +767,8 @@ public:
      * @param handler   Handler to dispatch the callback or nullptr for the default handler.
      */
     template<typename T, void(T::*method)(PickingQueryResult const&)>
-    void pick(uint32_t x, uint32_t y, T* instance,
-            backend::CallbackHandler* handler = nullptr) noexcept {
+    void pick(uint32_t x, uint32_t y, T* UTILS_NONNULL instance,
+            backend::CallbackHandler* UTILS_NULLABLE handler = nullptr) noexcept {
         PickingQuery& query = pick(x, y, [](PickingQueryResult const& result, PickingQuery* pq) {
             (static_cast<T*>(pq->storage[0])->*method)(result);
         }, handler);
@@ -787,7 +788,7 @@ public:
      */
     template<typename T, void(T::*method)(PickingQueryResult const&)>
     void pick(uint32_t x, uint32_t y, T instance,
-            backend::CallbackHandler* handler = nullptr) noexcept {
+            backend::CallbackHandler* UTILS_NULLABLE handler = nullptr) noexcept {
         static_assert(sizeof(instance) <= sizeof(PickingQuery::storage), "user data too large");
         PickingQuery& query = pick(x, y, [](PickingQueryResult const& result, PickingQuery* pq) {
             T* const that = static_cast<T*>(reinterpret_cast<void*>(pq->storage));
@@ -808,7 +809,7 @@ public:
      */
     template<typename T>
     void pick(uint32_t x, uint32_t y, T functor,
-            backend::CallbackHandler* handler = nullptr) noexcept {
+            backend::CallbackHandler* UTILS_NULLABLE handler = nullptr) noexcept {
         static_assert(sizeof(functor) <= sizeof(PickingQuery::storage), "functor too large");
         PickingQuery& query = pick(x, y, handler,
                 (PickingQueryResultCallback)[](PickingQueryResult const& result, PickingQuery* pq) {
@@ -834,8 +835,9 @@ public:
      *                  8*sizeof(void*) bytes of user data. This user data is later accessible
      *                  in the PickingQueryResultCallback callback 3rd parameter.
      */
-    PickingQuery& pick(uint32_t x, uint32_t y, backend::CallbackHandler* handler,
-            PickingQueryResultCallback callback) noexcept;
+    PickingQuery& pick(uint32_t x, uint32_t y,
+            backend::CallbackHandler* UTILS_NULLABLE handler,
+            PickingQueryResultCallback UTILS_NONNULL callback) noexcept;
 
     /**
      * Set the value of material global variables. There are up-to four such variable each of

filament/src/Allocators.h

@@ -54,7 +54,7 @@ using LinearAllocatorArena = utils::Arena<
 
 #endif
 
-using ArenaScope = utils::ArenaScope<LinearAllocatorArena>;
+using RootArenaScope = utils::ArenaScope<LinearAllocatorArena>;
 
 } // namespace filament
 

filament/src/Froxelizer.cpp

@@ -168,7 +168,8 @@ void Froxelizer::setProjection(const mat4f& projection,
 }
 
 bool Froxelizer::prepare(
-        FEngine::DriverApi& driverApi, ArenaScope& arena, filament::Viewport const& viewport,
+        FEngine::DriverApi& driverApi, RootArenaScope& rootArenaScope,
+        filament::Viewport const& viewport,
         const mat4f& projection, float projectionNear, float projectionFar) noexcept {
     setViewport(viewport);
     setProjection(projection, projectionNear, projectionFar);
@@ -199,12 +200,12 @@ bool Froxelizer::prepare(
 
     // light records per froxel (~256 KiB)
     mLightRecords = {
-            arena.allocate<LightRecord>(getFroxelBufferEntryCount(), CACHELINE_SIZE),
+            rootArenaScope.allocate<LightRecord>(getFroxelBufferEntryCount(), CACHELINE_SIZE),
             getFroxelBufferEntryCount() };
 
     // froxel thread data (~256 KiB)
     mFroxelShardedData = {
-            arena.allocate<FroxelThreadData>(GROUP_COUNT, CACHELINE_SIZE),
+            rootArenaScope.allocate<FroxelThreadData>(GROUP_COUNT, CACHELINE_SIZE),
             uint32_t(GROUP_COUNT)
     };
 

filament/src/Froxelizer.h

@@ -110,7 +110,7 @@ public:
      *
      * return true if updateUniforms() needs to be called
      */
-    bool prepare(backend::DriverApi& driverApi, ArenaScope& arena, Viewport const& viewport,
+    bool prepare(backend::DriverApi& driverApi, RootArenaScope& rootArenaScope, Viewport const& viewport,
             const math::mat4f& projection, float projectionNear, float projectionFar) noexcept;
 
     Froxel getFroxelAt(size_t x, size_t y, size_t z) const noexcept;

filament/src/Material.cpp

@@ -25,7 +25,7 @@ MaterialInstance* Material::createInstance(const char* name) const noexcept {
 }
 
 const char* Material::getName() const noexcept {
-    return downcast(this)->getName().c_str();
+    return downcast(this)->getName().c_str_safe();
 }
 
 Shading Material::getShading()  const noexcept {

filament/src/PostProcessManager.cpp

@@ -414,7 +414,7 @@ void PostProcessManager::commitAndRender(FrameGraphResources::RenderPassInfo con
 // ------------------------------------------------------------------------------------------------
 
 PostProcessManager::StructurePassOutput PostProcessManager::structure(FrameGraph& fg,
-        RenderPass const& pass, uint8_t structureRenderFlags,
+        RenderPassBuilder const& passBuilder, uint8_t structureRenderFlags,
         uint32_t width, uint32_t height,
         StructurePassConfig const& config) noexcept {
 
@@ -466,17 +466,19 @@ PostProcessManager::StructurePassOutput PostProcessManager::structure(FrameGraph
                         .clearFlags = TargetBufferFlags::COLOR0 | TargetBufferFlags::DEPTH
                 });
             },
-            [=, renderPass = pass](FrameGraphResources const& resources,
+            [=, passBuilder = passBuilder](FrameGraphResources const& resources,
                     auto const&, DriverApi&) mutable {
                 Variant structureVariant(Variant::DEPTH_VARIANT);
                 structureVariant.setPicking(config.picking);
 
                 auto out = resources.getRenderPassInfo();
-                renderPass.setRenderFlags(structureRenderFlags);
-                renderPass.setVariant(structureVariant);
-                renderPass.appendCommands(mEngine, RenderPass::CommandTypeFlags::SSAO);
-                renderPass.sortCommands(mEngine);
-                renderPass.execute(mEngine, resources.getPassName(), out.target, out.params);
+
+                passBuilder.renderFlags(structureRenderFlags);
+                passBuilder.variant(structureVariant);
+                passBuilder.commandTypeFlags(RenderPass::CommandTypeFlags::SSAO);
+
+                RenderPass const pass{ passBuilder.build(mEngine) };
+                RenderPass::execute(pass, mEngine, resources.getPassName(), out.target, out.params);
             });
 
     auto depth = structurePass->depth;
@@ -523,7 +525,7 @@ PostProcessManager::StructurePassOutput PostProcessManager::structure(FrameGraph
 // ------------------------------------------------------------------------------------------------
 
 FrameGraphId<FrameGraphTexture> PostProcessManager::ssr(FrameGraph& fg,
-        RenderPass const& pass,
+        RenderPassBuilder const& passBuilder,
         FrameHistory const& frameHistory,
         CameraInfo const& cameraInfo,
         PerViewUniforms& uniforms,
@@ -586,7 +588,7 @@ FrameGraphId<FrameGraphTexture> PostProcessManager::ssr(FrameGraph& fg,
             },
             [this, projection = cameraInfo.projection,
                     userViewMatrix = cameraInfo.getUserViewMatrix(), uvFromClipMatrix, historyProjection,
-                    options, &uniforms, renderPass = pass]
+                    options, &uniforms, passBuilder = passBuilder]
             (FrameGraphResources const& resources, auto const& data, DriverApi& driver) mutable {
                 // set structure sampler
                 uniforms.prepareStructure(data.structure ?
@@ -607,17 +609,17 @@ FrameGraphId<FrameGraphTexture> PostProcessManager::ssr(FrameGraph& fg,
                 auto out = resources.getRenderPassInfo();
 
                 // Remove the HAS_SHADOWING RenderFlags, since it's irrelevant when rendering reflections
-                RenderPass::RenderFlags flags = renderPass.getRenderFlags();
-                flags &= ~RenderPass::HAS_SHADOWING;
-                renderPass.setRenderFlags(flags);
+                passBuilder.renderFlags(~RenderPass::HAS_SHADOWING, 0);
 
                 // use our special SSR variant, it can only be applied to object that have
                 // the SCREEN_SPACE ReflectionMode.
-                renderPass.setVariant(Variant{Variant::SPECIAL_SSR});
+                passBuilder.variant(Variant{ Variant::SPECIAL_SSR });
+
                 // generate all our drawing commands, except blended objects.
-                renderPass.appendCommands(mEngine, RenderPass::CommandTypeFlags::SCREEN_SPACE_REFLECTIONS);
-                renderPass.sortCommands(mEngine);
-                renderPass.execute(mEngine, resources.getPassName(), out.target, out.params);
+                passBuilder.commandTypeFlags(RenderPass::CommandTypeFlags::SCREEN_SPACE_REFLECTIONS);
+
+                RenderPass const pass{ passBuilder.build(mEngine) };
+                RenderPass::execute(pass, mEngine, resources.getPassName(), out.target, out.params);
             });
 
     return ssrPass->reflections;

filament/src/PostProcessManager.h

@@ -50,6 +50,7 @@ class FMaterialInstance;
 class FrameGraph;
 class PerViewUniforms;
 class RenderPass;
+class RenderPassBuilder;
 struct CameraInfo;
 
 class PostProcessManager {
@@ -99,12 +100,12 @@ public:
         FrameGraphId<FrameGraphTexture> picking;
     };
     StructurePassOutput structure(FrameGraph& fg,
-            RenderPass const& pass, uint8_t structureRenderFlags,
+            RenderPassBuilder const& passBuilder, uint8_t structureRenderFlags,
             uint32_t width, uint32_t height, StructurePassConfig const& config) noexcept;
 
     // reflections pass
     FrameGraphId<FrameGraphTexture> ssr(FrameGraph& fg,
-            RenderPass const& pass,
+            RenderPassBuilder const& passBuilder,
             FrameHistory const& frameHistory,
             CameraInfo const& cameraInfo,
             PerViewUniforms& uniforms,

filament/src/RenderPass.cpp

@@ -19,17 +19,43 @@
 #include "RenderPrimitive.h"
 #include "ShadowMap.h"
 
+#include "details/Camera.h"
 #include "details/Material.h"
 #include "details/MaterialInstance.h"
 #include "details/View.h"
 
+#include "components/RenderableManager.h"
+
+#include <private/filament/EngineEnums.h>
 #include <private/filament/UibStructs.h>
+#include <private/filament/Variant.h>
 
+#include <filament/MaterialEnums.h>
+
+#include <backend/DriverApiForward.h>
+#include <backend/DriverEnums.h>
+#include <backend/Handle.h>
+#include <backend/PipelineState.h>
+
+#include "private/backend/CircularBuffer.h"
+
+#include <utils/compiler.h>
+#include <utils/debug.h>
 #include <utils/JobSystem.h>
+#include <utils/Panic.h>
+#include <utils/Slice.h>
 #include <utils/Systrace.h>
+#include <utils/Range.h>
 
+#include <algorithm>
+#include <functional>
+#include <limits>
 #include <utility>
 
+#include <stddef.h>
+#include <stdint.h>
+#include <stdlib.h>
+
 using namespace utils;
 using namespace filament::math;
 
@@ -37,60 +63,103 @@ namespace filament {
 
 using namespace backend;
 
-RenderPass::RenderPass(FEngine& engine,
-        RenderPass::Arena& arena) noexcept
-        : mCommandArena(arena),
-          mCustomCommands(engine.getPerRenderPassAllocator()) {
+RenderPassBuilder& RenderPassBuilder::customCommand(
+        FEngine& engine,
+        uint8_t channel,
+        RenderPass::Pass pass,
+        RenderPass::CustomCommand custom,
+        uint32_t order,
+        RenderPass::Executor::CustomCommandFn const& command) {
+    if (!mCustomCommands.has_value()) {
+        // construct the vector the first time
+        mCustomCommands.emplace(engine.getPerRenderPassArena());
+    }
+    mCustomCommands->emplace_back(channel, pass, custom, order, command);
+    return *this;
 }
 
-RenderPass::RenderPass(RenderPass const& rhs) = default;
+RenderPass RenderPassBuilder::build(FEngine& engine) {
+    ASSERT_POSTCONDITION(mRenderableSoa, "RenderPassBuilder::geometry() hasn't been called");
+    assert_invariant(mScissorViewport.width  <= std::numeric_limits<int32_t>::max());
+    assert_invariant(mScissorViewport.height <= std::numeric_limits<int32_t>::max());
+    return RenderPass{ engine, *this };
+}
+
+// ------------------------------------------------------------------------------------------------
+
+RenderPass::RenderPass(FEngine& engine, RenderPassBuilder const& builder) noexcept
+        : mRenderableSoa(*builder.mRenderableSoa),
+          mVisibleRenderables(builder.mVisibleRenderables),
+          mUboHandle(builder.mUboHandle),
+          mCameraPosition(builder.mCameraPosition),
+          mCameraForwardVector(builder.mCameraForwardVector),
+          mFlags(builder.mFlags),
+          mVariant(builder.mVariant),
+          mVisibilityMask(builder.mVisibilityMask),
+          mScissorViewport(builder.mScissorViewport),
+          mCustomCommands(engine.getPerRenderPassArena()) {
+
+    // compute the number of commands we need
+    updateSummedPrimitiveCounts(
+            const_cast<FScene::RenderableSoa&>(mRenderableSoa), mVisibleRenderables);
+
+    uint32_t commandCount =
+            FScene::getPrimitiveCount(mRenderableSoa, mVisibleRenderables.last);
+    const bool colorPass  = bool(builder.mCommandTypeFlags & CommandTypeFlags::COLOR);
+    const bool depthPass  = bool(builder.mCommandTypeFlags & CommandTypeFlags::DEPTH);
+    commandCount *= uint32_t(colorPass * 2 + depthPass);
+    commandCount += 1; // for the sentinel
+
+    uint32_t const customCommandCount =
+            builder.mCustomCommands.has_value() ? builder.mCustomCommands->size() : 0;
+
+    Command* const curr = builder.mArena.alloc<Command>(commandCount + customCommandCount);
+    assert_invariant(curr);
+
+    if (UTILS_UNLIKELY(builder.mArena.getAllocator().isHeapAllocation(curr))) {
+        static bool sLogOnce = true;
+        if (UTILS_UNLIKELY(sLogOnce)) {
+            sLogOnce = false;
+            PANIC_LOG("RenderPass arena is full, using slower system heap. Please increase "
+                      "the appropriate constant (e.g. FILAMENT_PER_RENDER_PASS_ARENA_SIZE_IN_MB).");
+        }
+    }
+
+    mCommandBegin = curr;
+    mCommandEnd = curr + commandCount + customCommandCount;
+
+    appendCommands(engine, { curr, commandCount }, builder.mCommandTypeFlags);
+
+    if (builder.mCustomCommands.has_value()) {
+        Command* p = curr + commandCount;
+        for (auto [channel, passId, command, order, fn]: builder.mCustomCommands.value()) {
+            appendCustomCommand(p++, channel, passId, command, order, fn);
+        }
+    }
+
+    // sort commands once we're done adding commands
+    sortCommands(builder.mArena);
+
+    if (engine.isAutomaticInstancingEnabled()) {
+        instanceify(engine, builder.mArena);
+    }
+}
 
 // this destructor is actually heavy because it inlines ~vector<>
 RenderPass::~RenderPass() noexcept = default;
 
-RenderPass::Command* RenderPass::append(size_t count) noexcept {
-    // this is like an "in-place" realloc(). Works only with LinearAllocator.
-    Command* const curr = mCommandArena.alloc<Command>(count);
-    assert_invariant(curr);
-    assert_invariant(mCommandBegin == nullptr || curr == mCommandEnd);
-    if (mCommandBegin == nullptr) {
-        mCommandBegin = mCommandEnd = curr;
-    }
-    mCommandEnd += count;
-    return curr;
-}
-
-void RenderPass::resize(size_t count) noexcept {
+void RenderPass::resize(Arena& arena, size_t count) noexcept {
     if (mCommandBegin) {
         mCommandEnd = mCommandBegin + count;
-        mCommandArena.rewind(mCommandEnd);
+        arena.rewind(mCommandEnd);
     }
 }
 
-void RenderPass::setGeometry(FScene::RenderableSoa const& soa, Range<uint32_t> vr,
-        backend::Handle<backend::HwBufferObject> uboHandle) noexcept {
-    mRenderableSoa = &soa;
-    mVisibleRenderables = vr;
-    mUboHandle = uboHandle;
-}
-
-void RenderPass::setCamera(const CameraInfo& camera) noexcept {
-    mCameraPosition = camera.getPosition();
-    mCameraForwardVector = camera.getForwardVector();
-}
-
-void RenderPass::setScissorViewport(backend::Viewport viewport) noexcept {
-    assert_invariant(viewport.width  <= std::numeric_limits<int32_t>::max());
-    assert_invariant(viewport.height <= std::numeric_limits<int32_t>::max());
-    mScissorViewport = viewport;
-}
-
-void RenderPass::appendCommands(FEngine& engine, CommandTypeFlags const commandTypeFlags) noexcept {
+void RenderPass::appendCommands(FEngine& engine,
+        Slice<Command> commands, CommandTypeFlags const commandTypeFlags) noexcept {
     SYSTRACE_CALL();
     SYSTRACE_CONTEXT();
 
-    assert_invariant(mRenderableSoa);
-
     utils::Range<uint32_t> const vr = mVisibleRenderables;
     // trace the number of visible renderables
     SYSTRACE_VALUE32("visibleRenderables", vr.size());
@@ -104,17 +173,10 @@ void RenderPass::appendCommands(FEngine& engine, CommandTypeFlags const commandT
     const FScene::VisibleMaskType visibilityMask = mVisibilityMask;
 
     // up-to-date summed primitive counts needed for generateCommands()
-    FScene::RenderableSoa const& soa = *mRenderableSoa;
-    updateSummedPrimitiveCounts(const_cast<FScene::RenderableSoa&>(soa), vr);
+    FScene::RenderableSoa const& soa = mRenderableSoa;
 
-    // compute how much maximum storage we need for this pass
-    uint32_t commandCount = FScene::getPrimitiveCount(soa, vr.last);
-    // double the color pass for transparent objects that need to render twice
-    const bool colorPass  = bool(commandTypeFlags & CommandTypeFlags::COLOR);
-    const bool depthPass  = bool(commandTypeFlags & CommandTypeFlags::DEPTH);
-    commandCount *= uint32_t(colorPass * 2 + depthPass);
-    commandCount += 1; // for the sentinel
-    Command* const curr = append(commandCount);
+    Command* curr = commands.data();
+    size_t const commandCount = commands.size();
 
     auto stereoscopicEyeCount =
             renderFlags & IS_STEREOSCOPIC ? engine.getConfig().stereoscopicEyeCount : 1;
@@ -152,7 +214,8 @@ void RenderPass::appendCommands(FEngine& engine, CommandTypeFlags const commandT
     }
 }
 
-void RenderPass::appendCustomCommand(uint8_t channel, Pass pass, CustomCommand custom, uint32_t order,
+void RenderPass::appendCustomCommand(Command* commands,
+        uint8_t channel, Pass pass, CustomCommand custom, uint32_t order,
         Executor::CustomCommandFn command) {
 
     assert_invariant((uint64_t(order) << CUSTOM_ORDER_SHIFT) <=  CUSTOM_ORDER_MASK);
@@ -168,11 +231,10 @@ void RenderPass::appendCustomCommand(uint8_t channel, Pass pass, CustomCommand c
     cmd |= uint64_t(order) << CUSTOM_ORDER_SHIFT;
     cmd |= uint64_t(index);
 
-    Command* const curr = append(1);
-    curr->key = cmd;
+    commands->key = cmd;
 }
 
-void RenderPass::sortCommands(FEngine& engine) noexcept {
+void RenderPass::sortCommands(Arena& arena) noexcept {
     SYSTRACE_NAME("sort and trim commands");
 
     std::sort(mCommandBegin, mCommandEnd);
@@ -183,30 +245,20 @@ void RenderPass::sortCommands(FEngine& engine) noexcept {
                 return c.key != uint64_t(Pass::SENTINEL);
             });
 
-    resize(uint32_t(last - mCommandBegin));
-
-    if (engine.isAutomaticInstancingEnabled()) {
-        instanceify(engine);
-    }
+    resize(arena, uint32_t(last - mCommandBegin));
 }
 
-void RenderPass::execute(FEngine& engine, const char* name,
+void RenderPass::execute(RenderPass const& pass,
+        FEngine& engine, const char* name,
         backend::Handle<backend::HwRenderTarget> renderTarget,
-        backend::RenderPassParams params) const noexcept {
-
+        backend::RenderPassParams params) noexcept {
     DriverApi& driver = engine.getDriverApi();
-
-    // this is a good time to flush the CommandStream, because we're about to potentially
-    // output a lot of commands. This guarantees here that we have at least
-    // FILAMENT_MIN_COMMAND_BUFFERS_SIZE_IN_MB bytes (1MiB by default).
-    engine.flush();
-
     driver.beginRenderPass(renderTarget, params);
-    getExecutor().execute(engine, name);
+    pass.getExecutor().execute(engine, name);
     driver.endRenderPass();
 }
 
-void RenderPass::instanceify(FEngine& engine) noexcept {
+void RenderPass::instanceify(FEngine& engine, Arena& arena) noexcept {
     SYSTRACE_NAME("instanceify");
 
     // instanceify works by scanning the **sorted** command stream, looking for repeat draw
@@ -262,7 +314,8 @@ void RenderPass::instanceify(FEngine& engine) noexcept {
                 // buffer large enough for all instances data
                 stagingBufferSize = sizeof(PerRenderableData) * (last - curr);
                 stagingBuffer = (PerRenderableData*)::malloc(stagingBufferSize);
-                uboData = mRenderableSoa->data<FScene::UBO>();
+                uboData = mRenderableSoa.data<FScene::UBO>();
+                assert_invariant(uboData);
             }
 
             // copy the ubo data to a staging buffer
@@ -315,7 +368,7 @@ void RenderPass::instanceify(FEngine& engine) noexcept {
             return command.key == uint64_t(Pass::SENTINEL);
         });
 
-        resize(uint32_t(lastCommand - mCommandBegin));
+        resize(arena, uint32_t(lastCommand - mCommandBegin));
     }
 
     assert_invariant(stagingBuffer == nullptr);
@@ -323,7 +376,7 @@ void RenderPass::instanceify(FEngine& engine) noexcept {
 
 
 /* static */
-UTILS_ALWAYS_INLINE // this function exists only to make the code more readable. we want it inlined.
+UTILS_ALWAYS_INLINE // This function exists only to make the code more readable. we want it inlined.
 inline              // and we don't need it in the compilation unit
 void RenderPass::setupColorCommand(Command& cmdDraw, Variant variant,
         FMaterialInstance const* const UTILS_RESTRICT mi, bool inverseFrontFaces) noexcept {
@@ -374,7 +427,7 @@ void RenderPass::setupColorCommand(Command& cmdDraw, Variant variant,
 
 /* static */
 UTILS_NOINLINE
-void RenderPass::generateCommands(uint32_t commandTypeFlags, Command* const commands,
+void RenderPass::generateCommands(CommandTypeFlags commandTypeFlags, Command* const commands,
         FScene::RenderableSoa const& soa, Range<uint32_t> range,
         Variant variant, RenderFlags renderFlags,
         FScene::VisibleMaskType visibilityMask, float3 cameraPosition, float3 cameraForward,
@@ -432,9 +485,9 @@ void RenderPass::generateCommands(uint32_t commandTypeFlags, Command* const comm
 }
 
 /* static */
-template<uint32_t commandTypeFlags>
+template<RenderPass::CommandTypeFlags commandTypeFlags>
 UTILS_NOINLINE
-RenderPass::Command* RenderPass::generateCommandsImpl(uint32_t extraFlags,
+RenderPass::Command* RenderPass::generateCommandsImpl(RenderPass::CommandTypeFlags extraFlags,
         Command* UTILS_RESTRICT curr,
         FScene::RenderableSoa const& UTILS_RESTRICT soa, Range<uint32_t> range,
         Variant const variant, RenderFlags renderFlags, FScene::VisibleMaskType visibilityMask,
@@ -737,13 +790,13 @@ void RenderPass::updateSummedPrimitiveCounts(
 // ------------------------------------------------------------------------------------------------
 
 void RenderPass::Executor::overridePolygonOffset(backend::PolygonOffset const* polygonOffset) noexcept {
-    if ((mPolygonOffsetOverride = (polygonOffset != nullptr))) {
+    if ((mPolygonOffsetOverride = (polygonOffset != nullptr))) { // NOLINT(*-assignment-in-if-condition)
         mPolygonOffset = *polygonOffset;
     }
 }
 
 void RenderPass::Executor::overrideScissor(backend::Viewport const* scissor) noexcept {
-    if ((mScissorOverride = (scissor != nullptr))) {
+    if ((mScissorOverride = (scissor != nullptr))) { // NOLINT(*-assignment-in-if-condition)
         mScissor = *scissor;
     }
 }
@@ -754,15 +807,20 @@ void RenderPass::Executor::overrideScissor(backend::Viewport const& scissor) noe
 }
 
 void RenderPass::Executor::execute(FEngine& engine, const char*) const noexcept {
-    execute(engine.getDriverApi(), mCommands.begin(), mCommands.end());
+    execute(engine, mCommands.begin(), mCommands.end());
 }
 
 UTILS_NOINLINE // no need to be inlined
-void RenderPass::Executor::execute(backend::DriverApi& driver,
+void RenderPass::Executor::execute(FEngine& engine,
         const Command* first, const Command* last) const noexcept {
+
     SYSTRACE_CALL();
     SYSTRACE_CONTEXT();
 
+    DriverApi& driver = engine.getDriverApi();
+    size_t const capacity = engine.getMinCommandBufferSize();
+    CircularBuffer const& circularBuffer = driver.getCircularBuffer();
+
     if (first != last) {
         SYSTRACE_VALUE32("commandCount", last - first);
 
@@ -781,126 +839,163 @@ void RenderPass::Executor::execute(backend::DriverApi& driver,
         FMaterial const* UTILS_RESTRICT ma = nullptr;
         auto const* UTILS_RESTRICT pCustomCommands = mCustomCommands.data();
 
-        first--;
-        while (++first != last) {
-            assert_invariant(first->key != uint64_t(Pass::SENTINEL));
+        // Maximum space occupied in the CircularBuffer by a single `Command`. This must be
+        // reevaluated when the inner loop below adds DriverApi commands or when we change the
+        // CommandStream protocol. Currently, the maximum is 240 bytes, and we use 256 to be on
+        // the safer side.
+        size_t const maxCommandSizeInBytes = 256;
 
-            /*
-             * Be careful when changing code below, this is the hot inner-loop
-             */
+        // Number of Commands that can be issued and guaranteed to fit in the current
+        // CircularBuffer allocation. In practice, we'll have tons of headroom especially if
+        // skinning and morphing aren't used. With a 2 MiB buffer (the default) a batch is
+        // 8192 commands (i.e. draw calls).
+        size_t const batchCommandCount = capacity / maxCommandSizeInBytes;
+        while(first != last) {
+            Command const* const batchLast = std::min(first + batchCommandCount, last);
 
-            if (UTILS_UNLIKELY((first->key & CUSTOM_MASK) != uint64_t(CustomCommand::PASS))) {
-                mi = nullptr; // custom command could change the currently bound MaterialInstance
-                uint32_t const index = (first->key & CUSTOM_INDEX_MASK) >> CUSTOM_INDEX_SHIFT;
-                assert_invariant(index < mCustomCommands.size());
-                pCustomCommands[index]();
-                continue;
+            // actual number of commands we need to write (can be smaller than batchCommandCount)
+            size_t const commandCount = batchLast - first;
+            size_t const commandSizeInBytes = commandCount * maxCommandSizeInBytes;
+
+            // check we have enough capacity to write these commandCount commands, if not,
+            // request a new CircularBuffer allocation of `capacity` bytes.
+            if (UTILS_UNLIKELY(circularBuffer.getUsed() > capacity - commandSizeInBytes)) {
+                engine.flush(); // TODO: we should use a "fast" flush if possible
             }
 
-            // primitiveHandle may be invalid if no geometry was set on the renderable.
-            if (UTILS_UNLIKELY(!first->primitive.primitiveHandle)) {
-                continue;
-            }
+            first--;
+            while (++first != batchLast) {
+                assert_invariant(first->key != uint64_t(Pass::SENTINEL));
 
-            // per-renderable uniform
-            const PrimitiveInfo info = first->primitive;
-            pipeline.rasterState = info.rasterState;
+                /*
+                 * Be careful when changing code below, this is the hot inner-loop
+                 */
 
-            if (UTILS_UNLIKELY(mi != info.mi)) {
-                // this is always taken the first time
-                mi = info.mi;
-                ma = mi->getMaterial();
-
-                auto const& scissor = mi->getScissor();
-                if (UTILS_UNLIKELY(mi->hasScissor())) {
-                    // scissor is set, we need to apply the offset/clip
-                    // clang vectorizes this!
-                    constexpr int32_t maxvali = std::numeric_limits<int32_t>::max();
-                    const backend::Viewport scissorViewport = mScissorViewport;
-                    // compute new left/bottom, assume no overflow
-                    int32_t l = scissor.left + scissorViewport.left;
-                    int32_t b = scissor.bottom + scissorViewport.bottom;
-                    // compute right/top without overflowing, scissor.width/height guaranteed
-                    // to convert to int32
-                    int32_t r = (l > maxvali - int32_t(scissor.width)) ?
-                            maxvali : l + int32_t(scissor.width);
-                    int32_t t = (b > maxvali - int32_t(scissor.height)) ?
-                            maxvali : b + int32_t(scissor.height);
-                    // clip to the viewport
-                    l = std::max(l, scissorViewport.left);
-                    b = std::max(b, scissorViewport.bottom);
-                    r = std::min(r, scissorViewport.left + int32_t(scissorViewport.width));
-                    t = std::min(t, scissorViewport.bottom + int32_t(scissorViewport.height));
-                    assert_invariant(r >= l && t >= b);
-                    *pScissor = { l, b, uint32_t(r - l), uint32_t(t - b) };
-                } else {
-                    // no scissor set (common case), 'scissor' has its default value, use that.
-                    *pScissor = scissor;
+                if (UTILS_UNLIKELY((first->key & CUSTOM_MASK) != uint64_t(CustomCommand::PASS))) {
+                    mi = nullptr; // custom command could change the currently bound MaterialInstance
+                    uint32_t const index = (first->key & CUSTOM_INDEX_MASK) >> CUSTOM_INDEX_SHIFT;
+                    assert_invariant(index < mCustomCommands.size());
+                    pCustomCommands[index]();
+                    continue;
                 }
 
-                *pPipelinePolygonOffset = mi->getPolygonOffset();
-                pipeline.stencilState = mi->getStencilState();
-                mi->use(driver);
-            }
-
-            pipeline.program = ma->getProgram(info.materialVariant);
-
-            uint16_t const instanceCount = info.instanceCount & PrimitiveInfo::INSTANCE_COUNT_MASK;
-            auto getPerObjectUboHandle =
-                    [this, &info, &instanceCount]() -> std::pair<Handle<backend::HwBufferObject>, uint32_t> {
-                if (info.instanceBufferHandle) {
-                    // "hybrid" instancing -- instanceBufferHandle takes the place of the UBO
-                    return { info.instanceBufferHandle, 0 };
+                // primitiveHandle may be invalid if no geometry was set on the renderable.
+                if (UTILS_UNLIKELY(!first->primitive.primitiveHandle)) {
+                    continue;
                 }
-                bool const userInstancing =
-                        (info.instanceCount & PrimitiveInfo::USER_INSTANCE_MASK) != 0u;
-                if (!userInstancing && instanceCount > 1) {
-                    // automatic instancing
-                    return { mInstancedUboHandle, info.index * sizeof(PerRenderableData) };
-                } else {
-                    // manual instancing
-                    return { mUboHandle, info.index * sizeof(PerRenderableData) };
+
+                // per-renderable uniform
+                const PrimitiveInfo info = first->primitive;
+                pipeline.rasterState = info.rasterState;
+
+                if (UTILS_UNLIKELY(mi != info.mi)) {
+                    // this is always taken the first time
+                    mi = info.mi;
+                    assert_invariant(mi);
+
+                    ma = mi->getMaterial();
+
+                    auto const& scissor = mi->getScissor();
+                    if (UTILS_UNLIKELY(mi->hasScissor())) {
+                        // scissor is set, we need to apply the offset/clip
+                        // clang vectorizes this!
+                        constexpr int32_t maxvali = std::numeric_limits<int32_t>::max();
+                        const backend::Viewport scissorViewport = mScissorViewport;
+                        // compute new left/bottom, assume no overflow
+                        int32_t l = scissor.left + scissorViewport.left;
+                        int32_t b = scissor.bottom + scissorViewport.bottom;
+                        // compute right/top without overflowing, scissor.width/height guaranteed
+                        // to convert to int32
+                        int32_t r = (l > maxvali - int32_t(scissor.width)) ?
+                                    maxvali : l + int32_t(scissor.width);
+                        int32_t t = (b > maxvali - int32_t(scissor.height)) ?
+                                    maxvali : b + int32_t(scissor.height);
+                        // clip to the viewport
+                        l = std::max(l, scissorViewport.left);
+                        b = std::max(b, scissorViewport.bottom);
+                        r = std::min(r, scissorViewport.left + int32_t(scissorViewport.width));
+                        t = std::min(t, scissorViewport.bottom + int32_t(scissorViewport.height));
+                        assert_invariant(r >= l && t >= b);
+                        *pScissor = { l, b, uint32_t(r - l), uint32_t(t - b) };
+                    } else {
+                        // no scissor set (common case), 'scissor' has its default value, use that.
+                        *pScissor = scissor;
+                    }
+
+                    *pPipelinePolygonOffset = mi->getPolygonOffset();
+                    pipeline.stencilState = mi->getStencilState();
+                    mi->use(driver);
                 }
-            };
 
-            // bind per-renderable uniform block. there is no need to attempt to skip this command
-            // because the backends already do this.
-            auto const [perObjectUboHandle, offset] = getPerObjectUboHandle();
-            assert_invariant(perObjectUboHandle);
-            driver.bindBufferRange(BufferObjectBinding::UNIFORM,
-                    +UniformBindingPoints::PER_RENDERABLE,
-                    perObjectUboHandle,
-                    offset,
-                    sizeof(PerRenderableUib));
+                assert_invariant(ma);
+                pipeline.program = ma->getProgram(info.materialVariant);
 
-            if (UTILS_UNLIKELY(info.skinningHandle)) {
-                // note: we can't bind less than sizeof(PerRenderableBoneUib) due to glsl limitations
+                uint16_t const instanceCount =
+                        info.instanceCount & PrimitiveInfo::INSTANCE_COUNT_MASK;
+                auto getPerObjectUboHandle =
+                        [this, &info, &instanceCount]() -> std::pair<Handle<backend::HwBufferObject>, uint32_t> {
+                            if (info.instanceBufferHandle) {
+                                // "hybrid" instancing -- instanceBufferHandle takes the place of the UBO
+                                return { info.instanceBufferHandle, 0 };
+                            }
+                            bool const userInstancing =
+                                    (info.instanceCount & PrimitiveInfo::USER_INSTANCE_MASK) != 0u;
+                            if (!userInstancing && instanceCount > 1) {
+                                // automatic instancing
+                                return {
+                                        mInstancedUboHandle,
+                                        info.index * sizeof(PerRenderableData) };
+                            } else {
+                                // manual instancing
+                                return { mUboHandle, info.index * sizeof(PerRenderableData) };
+                            }
+                        };
+
+                // Bind per-renderable uniform block. There is no need to attempt to skip this command
+                // because the backends already do this.
+                auto const [perObjectUboHandle, offset] = getPerObjectUboHandle();
+                assert_invariant(perObjectUboHandle);
                 driver.bindBufferRange(BufferObjectBinding::UNIFORM,
-                        +UniformBindingPoints::PER_RENDERABLE_BONES,
-                        info.skinningHandle,
-                        info.skinningOffset * sizeof(PerRenderableBoneUib::BoneData),
-                        sizeof(PerRenderableBoneUib));
-                // note: always bind the skinningTexture because the shader needs it.
-                driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_SKINNING,
-                        info.skinningTexture);
-                // note: even if only skinning is enabled, binding morphTargetBuffer is needed.
-                driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_MORPHING,
-                        info.morphTargetBuffer);
-           }
+                        +UniformBindingPoints::PER_RENDERABLE,
+                        perObjectUboHandle,
+                        offset,
+                        sizeof(PerRenderableUib));
 
-            if (UTILS_UNLIKELY(info.morphWeightBuffer)) {
-                // Instead of using a UBO per primitive, we could also have a single UBO for all
-                // primitives and use bindUniformBufferRange which might be more efficient.
-                driver.bindUniformBuffer(+UniformBindingPoints::PER_RENDERABLE_MORPHING,
-                        info.morphWeightBuffer);
-                driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_MORPHING,
-                        info.morphTargetBuffer);
-                // note: even if only morphing is enabled, binding skinningTexture is needed.
-                driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_SKINNING,
-                        info.skinningTexture);
+                if (UTILS_UNLIKELY(info.skinningHandle)) {
+                    // note: we can't bind less than sizeof(PerRenderableBoneUib) due to glsl limitations
+                    driver.bindBufferRange(BufferObjectBinding::UNIFORM,
+                            +UniformBindingPoints::PER_RENDERABLE_BONES,
+                            info.skinningHandle,
+                            info.skinningOffset * sizeof(PerRenderableBoneUib::BoneData),
+                            sizeof(PerRenderableBoneUib));
+                    // note: always bind the skinningTexture because the shader needs it.
+                    driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_SKINNING,
+                            info.skinningTexture);
+                    // note: even if only skinning is enabled, binding morphTargetBuffer is needed.
+                    driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_MORPHING,
+                            info.morphTargetBuffer);
+                }
+
+                if (UTILS_UNLIKELY(info.morphWeightBuffer)) {
+                    // Instead of using a UBO per primitive, we could also have a single UBO for all
+                    // primitives and use bindUniformBufferRange which might be more efficient.
+                    driver.bindUniformBuffer(+UniformBindingPoints::PER_RENDERABLE_MORPHING,
+                            info.morphWeightBuffer);
+                    driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_MORPHING,
+                            info.morphTargetBuffer);
+                    // note: even if only morphing is enabled, binding skinningTexture is needed.
+                    driver.bindSamplers(+SamplerBindingPoints::PER_RENDERABLE_SKINNING,
+                            info.skinningTexture);
+                }
+
+                driver.draw(pipeline, info.primitiveHandle, instanceCount);
             }
+        }
 
-            driver.draw(pipeline, info.primitiveHandle, instanceCount);
+        // If the remaining space is less than half the capacity, we flush right away to
+        // allow some headroom for commands that might come later.
+        if (UTILS_UNLIKELY(circularBuffer.getUsed() > capacity / 2)) {
+            engine.flush();
         }
     }
 

filament/src/RenderPass.h

@@ -22,26 +22,38 @@
 #include "details/Camera.h"
 #include "details/Scene.h"
 
-#include "backend/DriverApiForward.h"
-
-#include <private/filament/Variant.h>
+#include "private/filament/Variant.h"
+#include "utils/BitmaskEnum.h"
 
 #include <backend/DriverEnums.h>
 #include <backend/Handle.h>
 
 #include <utils/Allocator.h>
 #include <utils/Range.h>
+#include <utils/Slice.h>
 #include <utils/architecture.h>
-#include <utils/compiler.h>
 #include <utils/debug.h>
 
+#include <math/mathfwd.h>
+
 #include <functional>
 #include <limits>
+#include <optional>
+#include <type_traits>
+#include <tuple>
 #include <vector>
 
+#include <stddef.h>
+#include <stdint.h>
+
 namespace filament {
 
+namespace backend {
+class CommandBufferQueue;
+}
+
 class FMaterialInstance;
+class RenderPassBuilder;
 
 class RenderPass {
 public:
@@ -171,7 +183,7 @@ public:
         EPILOG  = uint64_t(0x2) << CUSTOM_SHIFT
     };
 
-    enum CommandTypeFlags : uint8_t {
+    enum class CommandTypeFlags : uint32_t {
         COLOR = 0x1,    // generate the color pass only
         DEPTH = 0x2,    // generate the depth pass only ( e.g. shadowmap)
 
@@ -191,7 +203,6 @@ public:
         SCREEN_SPACE_REFLECTIONS = COLOR | FILTER_TRANSLUCENT_OBJECTS
     };
 
-
     /*
      * The sorting material key is 32 bits and encoded as:
      *
@@ -240,7 +251,6 @@ public:
         uint32_t skinningOffset = 0;                                    // 4 bytes
         uint16_t instanceCount;                                         // 2 bytes [MSb: user]
         Variant materialVariant;                                        // 1 byte
-//        uint8_t reserved[0] = {};                                       // 0 bytes
 
         static const uint16_t USER_INSTANCE_MASK = 0x8000u;
         static const uint16_t INSTANCE_COUNT_MASK = 0x7fffu;
@@ -253,7 +263,7 @@ public:
         uint64_t reserved[1] = {};  //  8 bytes
         bool operator < (Command const& rhs) const noexcept { return key < rhs.key; }
         // placement new declared as "throw" to avoid the compiler's null-check
-        inline void* operator new (std::size_t, void* ptr) {
+        inline void* operator new (size_t, void* ptr) {
             assert_invariant(ptr);
             return ptr;
         }
@@ -269,61 +279,31 @@ public:
 
     // Arena used for commands
     using Arena = utils::Arena<
-            utils::LinearAllocator,                 // note: can't change this allocator
+            utils::LinearAllocatorWithFallback,
             utils::LockingPolicy::NoLock,
             utils::TrackingPolicy::HighWatermark,
             utils::AreaPolicy::StaticArea>;
 
-    /*
-     * Create a RenderPass.
-     * The Arena is used to allocate commands which are then owned by the Arena.
-     */
-    RenderPass(FEngine& engine, Arena& arena) noexcept;
+    // RenderPass can only be moved
+    RenderPass(RenderPass&& rhs) = default;
 
-    // Copy the RenderPass as is. This can be used to create a RenderPass from a "template"
-    // by copying from an "empty" RenderPass.
-    RenderPass(RenderPass const& rhs);
+    // RenderPass can't be copied
+    RenderPass(RenderPass const& rhs) = delete;
+    RenderPass& operator=(RenderPass const& rhs) = delete;
+    RenderPass& operator=(RenderPass&& rhs) = delete;
 
     // allocated commands ARE NOT freed, they're owned by the Arena
     ~RenderPass() noexcept;
 
-    // a box that both offsets the viewport and clips it
-    void setScissorViewport(backend::Viewport viewport) noexcept;
-
-    // specifies the geometry to generate commands for
-    void setGeometry(FScene::RenderableSoa const& soa, utils::Range<uint32_t> vr,
-            backend::Handle<backend::HwBufferObject> uboHandle) noexcept;
-
-    // specifies camera information (e.g. used for sorting commands)
-    void setCamera(const CameraInfo& camera) noexcept;
-
-    //  flags controlling how commands are generated
-    void setRenderFlags(RenderFlags flags) noexcept { mFlags = flags; }
-    RenderFlags getRenderFlags() const noexcept { return mFlags; }
-
-    // variant to use
-    void setVariant(Variant variant) noexcept { mVariant = variant; }
-
-    // Sets the visibility mask, which is AND-ed against each Renderable's VISIBLE_MASK to determine
-    // if the renderable is visible for this pass.
-    // Defaults to all 1's, which means all renderables in this render pass will be rendered.
-    void setVisibilityMask(FScene::VisibleMaskType mask) noexcept { mVisibilityMask = mask; }
-
     Command const* begin() const noexcept { return mCommandBegin; }
     Command const* end() const noexcept { return mCommandEnd; }
     bool empty() const noexcept { return begin() == end(); }
 
-    // This is the main function of this class, this appends commands to the pass using
-    // the current camera, geometry and flags set. This can be called multiple times if needed.
-    void appendCommands(FEngine& engine, CommandTypeFlags commandTypeFlags) noexcept;
-
-    // sorts and instanceify commands then trims sentinels
-    void sortCommands(FEngine& engine) noexcept;
-
     // Helper to execute all the commands generated by this RenderPass
-    void execute(FEngine& engine, const char* name,
+    static void execute(RenderPass const& pass,
+            FEngine& engine, const char* name,
             backend::Handle<backend::HwRenderTarget> renderTarget,
-            backend::RenderPassParams params) const noexcept;
+            backend::RenderPassParams params) noexcept;
 
     /*
      * Executor holds the range of commands to execute for a given pass
@@ -331,6 +311,7 @@ public:
     class Executor {
         using CustomCommandFn = std::function<void()>;
         friend class RenderPass;
+        friend class RenderPassBuilder;
 
         // these fields are constant after creation
         utils::Slice<Command> mCommands;
@@ -346,8 +327,7 @@ public:
 
         Executor(RenderPass const* pass, Command const* b, Command const* e) noexcept;
 
-        void execute(backend::DriverApi& driver,
-                const Command* first, const Command* last) const noexcept;
+        void execute(FEngine& engine, const Command* first, const Command* last) const noexcept;
 
     public:
         Executor() = default;
@@ -366,37 +346,39 @@ public:
     };
 
     // returns a new executor for this pass
-    Executor getExecutor() {
-        return { this, mCommandBegin, mCommandEnd };
-    }
-
     Executor getExecutor() const {
         return { this, mCommandBegin, mCommandEnd };
     }
 
-    // returns a new executor for this pass with a custom range
-    Executor getExecutor(Command const* b, Command const* e) {
-        return { this, b, e };
-    }
-
     Executor getExecutor(Command const* b, Command const* e) const {
         return { this, b, e };
     }
 
-    // Appends a custom command.
-    void appendCustomCommand(uint8_t channel, Pass pass, CustomCommand custom, uint32_t order,
-            Executor::CustomCommandFn command);
-
-
 private:
     friend class FRenderer;
+    friend class RenderPassBuilder;
+    RenderPass(FEngine& engine, RenderPassBuilder const& builder) noexcept;
 
-    Command* append(size_t count) noexcept;
-    void resize(size_t count) noexcept;
-    void instanceify(FEngine& engine) noexcept;
+    // This is the main function of this class, this appends commands to the pass using
+    // the current camera, geometry and flags set. This can be called multiple times if needed.
+    void appendCommands(FEngine& engine,
+            utils::Slice<Command> commands, CommandTypeFlags commandTypeFlags) noexcept;
 
-    // we choose the command count per job to minimize JobSystem overhead.
-    // on a Pixel 4, 2048 commands is about half a millisecond of processing.
+    // Appends a custom command.
+    void appendCustomCommand(Command* commands,
+            uint8_t channel, Pass pass, CustomCommand custom, uint32_t order,
+            Executor::CustomCommandFn command);
+
+    void resize(Arena& arena, size_t count) noexcept;
+
+    // sorts commands then trims sentinels
+    void sortCommands(Arena& arena) noexcept;
+
+    // instanceify commands then trims sentinels
+    void instanceify(FEngine& engine, Arena& arena) noexcept;
+
+    // We choose the command count per job to minimize JobSystem overhead.
+    // On a Pixel 4, 2048 commands is about half a millisecond of processing.
     static constexpr size_t JOBS_PARALLEL_FOR_COMMANDS_COUNT = 2048;
     static constexpr size_t JOBS_PARALLEL_FOR_COMMANDS_SIZE  =
             sizeof(Command) * JOBS_PARALLEL_FOR_COMMANDS_COUNT;
@@ -404,15 +386,15 @@ private:
     static_assert(JOBS_PARALLEL_FOR_COMMANDS_SIZE % utils::CACHELINE_SIZE == 0,
             "Size of Commands jobs must be multiple of a cache-line size");
 
-    static inline void generateCommands(uint32_t commandTypeFlags, Command* commands,
+    static inline void generateCommands(CommandTypeFlags commandTypeFlags, Command* commands,
             FScene::RenderableSoa const& soa, utils::Range<uint32_t> range,
             Variant variant, RenderFlags renderFlags,
             FScene::VisibleMaskType visibilityMask,
             math::float3 cameraPosition, math::float3 cameraForward,
             uint8_t instancedStereoEyeCount) noexcept;
 
-    template<uint32_t commandTypeFlags>
-    static inline Command* generateCommandsImpl(uint32_t extraFlags, Command* curr,
+    template<RenderPass::CommandTypeFlags commandTypeFlags>
+    static inline Command* generateCommandsImpl(RenderPass::CommandTypeFlags extraFlags, Command* curr,
             FScene::RenderableSoa const& soa, utils::Range<uint32_t> range,
             Variant variant, RenderFlags renderFlags, FScene::VisibleMaskType visibilityMask,
             math::float3 cameraPosition, math::float3 cameraForward,
@@ -424,50 +406,129 @@ private:
     static void updateSummedPrimitiveCounts(
             FScene::RenderableSoa& renderableData, utils::Range<uint32_t> vr) noexcept;
 
-    // a reference to the Engine, mostly to get to things like JobSystem
 
     // Arena where all Commands are allocated. The Arena owns the commands.
-    Arena& mCommandArena;
+    FScene::RenderableSoa const& mRenderableSoa;
+    utils::Range<uint32_t> const mVisibleRenderables;
+    backend::Handle<backend::HwBufferObject> const mUboHandle;
+    math::float3 const mCameraPosition;
+    math::float3 const mCameraForwardVector;
+    RenderFlags const mFlags;
+    Variant const mVariant;
+    FScene::VisibleMaskType const mVisibilityMask;
+    backend::Viewport const mScissorViewport;
 
     // Pointer to the first command
     Command* mCommandBegin = nullptr;
-
     // Pointer to one past the last command
     Command* mCommandEnd = nullptr;
-
-    // the SOA containing the renderables we're interested in
-    FScene::RenderableSoa const* mRenderableSoa = nullptr;
-
-    // The range of visible renderables in the SOA above
-    utils::Range<uint32_t> mVisibleRenderables{};
-
-    // the UBO containing the data for the renderables
-    backend::Handle<backend::HwBufferObject> mUboHandle;
+    // a UBO for instanced primitives
     backend::Handle<backend::HwBufferObject> mInstancedUboHandle;
-
-    // info about the camera
-    math::float3 mCameraPosition{};
-    math::float3 mCameraForwardVector{};
-
-    // info about the scene features (e.g.: has shadows, lighting, etc...)
-    RenderFlags mFlags{};
-
-    // Variant to use
-    Variant mVariant{};
-
-    // Additional visibility mask
-    FScene::VisibleMaskType mVisibilityMask = std::numeric_limits<FScene::VisibleMaskType>::max();
-
-    backend::Viewport mScissorViewport{ 0, 0,
-            std::numeric_limits<int32_t>::max(),
-            std::numeric_limits<int32_t>::max() };
-
     // a vector for our custom commands
     using CustomCommandVector = std::vector<Executor::CustomCommandFn,
             utils::STLAllocator<Executor::CustomCommandFn, LinearAllocatorArena>>;
     mutable CustomCommandVector mCustomCommands;
 };
 
+class RenderPassBuilder {
+    friend class RenderPass;
+
+    RenderPass::Arena& mArena;
+    RenderPass::CommandTypeFlags mCommandTypeFlags{};
+    backend::Viewport mScissorViewport{ 0, 0, INT32_MAX, INT32_MAX };
+    FScene::RenderableSoa const* mRenderableSoa = nullptr;
+    utils::Range<uint32_t> mVisibleRenderables{};
+    backend::Handle<backend::HwBufferObject> mUboHandle;
+    math::float3 mCameraPosition{};
+    math::float3 mCameraForwardVector{};
+    RenderPass::RenderFlags mFlags{};
+    Variant mVariant{};
+    FScene::VisibleMaskType mVisibilityMask = std::numeric_limits<FScene::VisibleMaskType>::max();
+
+    using CustomCommandRecord = std::tuple<
+            uint8_t,
+            RenderPass::Pass,
+            RenderPass::CustomCommand,
+            uint32_t,
+            RenderPass::Executor::CustomCommandFn>;
+
+    using CustomCommandContainer = std::vector<CustomCommandRecord,
+            utils::STLAllocator<CustomCommandRecord, LinearAllocatorArena>>;
+
+    // we make this optional because it's not used often, and we don't want to have
+    // to construct it by default.
+    std::optional<CustomCommandContainer> mCustomCommands;
+
+public:
+    explicit RenderPassBuilder(RenderPass::Arena& arena) : mArena(arena) { }
+
+    RenderPassBuilder& commandTypeFlags(RenderPass::CommandTypeFlags commandTypeFlags) noexcept {
+        mCommandTypeFlags = commandTypeFlags;
+        return *this;
+    }
+
+    RenderPassBuilder& scissorViewport(backend::Viewport viewport) noexcept {
+        mScissorViewport = viewport;
+        return *this;
+    }
+
+    // specifies the geometry to generate commands for
+    RenderPassBuilder& geometry(FScene::RenderableSoa const& soa, utils::Range<uint32_t> vr,
+            backend::Handle<backend::HwBufferObject> uboHandle) noexcept {
+        mRenderableSoa = &soa;
+        mVisibleRenderables = vr;
+        mUboHandle = uboHandle;
+        return *this;
+    }
+
+    // Specifies camera information (e.g. used for sorting commands)
+    RenderPassBuilder& camera(const CameraInfo& camera) noexcept {
+        mCameraPosition = camera.getPosition();
+        mCameraForwardVector = camera.getForwardVector();
+        return *this;
+    }
+
+    //  flags controlling how commands are generated
+    RenderPassBuilder& renderFlags(RenderPass::RenderFlags flags) noexcept {
+        mFlags = flags;
+        return *this;
+    }
+
+    // like above but allows to set specific flags
+    RenderPassBuilder& renderFlags(
+            RenderPass::RenderFlags mask, RenderPass::RenderFlags value) noexcept {
+        mFlags = (mFlags & mask) | (value & mask);
+        return *this;
+    }
+
+    // variant to use
+    RenderPassBuilder& variant(Variant variant) noexcept {
+        mVariant = variant;
+        return *this;
+    }
+
+    // Sets the visibility mask, which is AND-ed against each Renderable's VISIBLE_MASK to
+    // determine if the renderable is visible for this pass.
+    // Defaults to all 1's, which means all renderables in this render pass will be rendered.
+    RenderPassBuilder& visibilityMask(FScene::VisibleMaskType mask) noexcept {
+        mVisibilityMask = mask;
+        return *this;
+    }
+
+    RenderPassBuilder& customCommand(FEngine& engine,
+            uint8_t channel,
+            RenderPass::Pass pass,
+            RenderPass::CustomCommand custom,
+            uint32_t order,
+            const RenderPass::Executor::CustomCommandFn& command);
+
+    RenderPass build(FEngine& engine);
+};
+
+
 } // namespace filament
 
+template<> struct utils::EnableBitMaskOperators<filament::RenderPass::CommandTypeFlags>
+        : public std::true_type {};
+
 #endif // TNT_FILAMENT_RENDERPASS_H

filament/src/RendererUtils.cpp

@@ -228,10 +228,6 @@ FrameGraphId<FrameGraphTexture> RendererUtils::colorPass(
                     out.params.subpassMask = 1;
                 }
 
-                // this is a good time to flush the CommandStream, because we're about to potentially
-                // output a lot of commands. This guarantees here that we have at least
-                // FILAMENT_MIN_COMMAND_BUFFERS_SIZE_IN_MB bytes (1MiB by default).
-                engine.flush();
                 driver.beginRenderPass(out.target, out.params);
                 passExecutor.execute(engine, resources.getPassName());
                 driver.endRenderPass();

filament/src/ResourceAllocator.cpp

@@ -16,15 +16,30 @@
 
 #include "ResourceAllocator.h"
 
-#include "private/backend/DriverApi.h"
+#include <filament/Engine.h>
 
 #include "details/Texture.h"
 
+#include <backend/DriverApiForward.h>
+#include <backend/Handle.h>
+#include <backend/TargetBufferInfo.h>
+#include <backend/DriverEnums.h>
+
+#include "private/backend/DriverApi.h"
+
+#include <utils/compiler.h>
+#include <utils/debug.h>
 #include <utils/FixedCapacityVector.h>
 #include <utils/Log.h>
-#include <utils/debug.h>
+#include <utils/ostream.h>
 
+#include <array>
+#include <algorithm>
 #include <iterator>
+#include <utility>
+
+#include <stddef.h>
+#include <stdint.h>
 
 using namespace utils;
 
@@ -42,8 +57,7 @@ ResourceAllocator::AssociativeContainer<K, V, H>::AssociativeContainer() {
 
 template<typename K, typename V, typename H>
 UTILS_NOINLINE
-ResourceAllocator::AssociativeContainer<K, V, H>::~AssociativeContainer() noexcept {
-}
+ResourceAllocator::AssociativeContainer<K, V, H>::~AssociativeContainer() noexcept = default;
 
 template<typename K, typename V, typename H>
 UTILS_NOINLINE
@@ -78,9 +92,9 @@ void ResourceAllocator::AssociativeContainer<K, V, H>::emplace(ARGS&& ... args)
 ResourceAllocatorInterface::~ResourceAllocatorInterface() = default;
 
 size_t ResourceAllocator::TextureKey::getSize() const noexcept {
-    size_t pixelCount = width * height * depth;
+    size_t const pixelCount = width * height * depth;
     size_t size = pixelCount * FTexture::getFormatSize(format);
-    size_t s = std::max(uint8_t(1), samples);
+    size_t const s = std::max(uint8_t(1), samples);
     if (s > 1) {
         // if we have MSAA, we assume N times the storage
         size *= s;
@@ -94,8 +108,10 @@ size_t ResourceAllocator::TextureKey::getSize() const noexcept {
     return size;
 }
 
-ResourceAllocator::ResourceAllocator(DriverApi& driverApi) noexcept
-        : mBackend(driverApi) {
+ResourceAllocator::ResourceAllocator(Engine::Config const& config, DriverApi& driverApi) noexcept
+        : mCacheCapacity(config.resourceAllocatorCacheSizeMB),
+          mCacheMaxAge(config.resourceAllocatorCacheMaxAge),
+          mBackend(driverApi) {
 }
 
 ResourceAllocator::~ResourceAllocator() noexcept {
@@ -112,7 +128,7 @@ void ResourceAllocator::terminate() noexcept {
     }
 }
 
-RenderTargetHandle ResourceAllocator::createRenderTarget(const char* name,
+RenderTargetHandle ResourceAllocator::createRenderTarget(const char*,
         TargetBufferFlags targetBufferFlags, uint32_t width, uint32_t height,
         uint8_t samples, MRT color, TargetBufferInfo depth,
         TargetBufferInfo stencil) noexcept {
@@ -181,7 +197,7 @@ void ResourceAllocator::destroyTexture(TextureHandle h) noexcept {
 
         // move it to the cache
         const TextureKey key = it->second;
-        uint32_t size = key.getSize();
+        uint32_t const size = key.getSize();
 
         mTextureCache.emplace(key, TextureCachePayload{ h, mAge, size });
         mCacheSize += size;
@@ -208,9 +224,9 @@ void ResourceAllocator::gc() noexcept {
     auto& textureCache = mTextureCache;
     for (auto it = textureCache.begin(); it != textureCache.end();) {
         const size_t ageDiff = age - it->second.age;
-        if (ageDiff >= CACHE_MAX_AGE) {
+        if (ageDiff >= mCacheMaxAge) {
             it = purge(it);
-            if (mCacheSize < CACHE_CAPACITY) {
+            if (mCacheSize < mCacheCapacity) {
                 // if we're not at capacity, only purge a single entry per gc, trying to
                 // avoid a burst of work.
                 break;
@@ -220,7 +236,7 @@ void ResourceAllocator::gc() noexcept {
         }
     }
 
-    if (UTILS_UNLIKELY(mCacheSize >= CACHE_CAPACITY)) {
+    if (UTILS_UNLIKELY(mCacheSize >= mCacheCapacity)) {
         // make a copy of our CacheContainer to a vector
         using Vector = FixedCapacityVector<std::pair<TextureKey, TextureCachePayload>>;
         auto cache = Vector::with_capacity(textureCache.size());
@@ -233,14 +249,14 @@ void ResourceAllocator::gc() noexcept {
 
         // now remove entries until we're at capacity
         auto curr = cache.begin();
-        while (mCacheSize >= CACHE_CAPACITY) {
+        while (mCacheSize >= mCacheCapacity) {
             // by construction this entry must exist
             purge(textureCache.find(curr->first));
             ++curr;
         }
 
         // Since we're sorted already, reset the oldestAge of the whole system
-        size_t oldestAge = cache.front().second.age;
+        size_t const oldestAge = cache.front().second.age;
         for (auto& it : textureCache) {
             it.second.age -= oldestAge;
         }

filament/src/ResourceAllocator.h

@@ -17,6 +17,8 @@
 #ifndef TNT_FILAMENT_RESOURCEALLOCATOR_H
 #define TNT_FILAMENT_RESOURCEALLOCATOR_H
 
+#include <filament/Engine.h>
+
 #include <backend/DriverEnums.h>
 #include <backend/Handle.h>
 #include <backend/TargetBufferInfo.h>
@@ -27,7 +29,9 @@
 
 #include <array>
 #include <vector>
+#include <utility>
 
+#include <stddef.h>
 #include <stdint.h>
 
 namespace filament {
@@ -62,7 +66,8 @@ protected:
 
 class ResourceAllocator final : public ResourceAllocatorInterface {
 public:
-    explicit ResourceAllocator(backend::DriverApi& driverApi) noexcept;
+    explicit ResourceAllocator(
+            Engine::Config const& config, backend::DriverApi& driverApi) noexcept;
     ~ResourceAllocator() noexcept override;
 
     void terminate() noexcept;
@@ -89,9 +94,8 @@ public:
     void gc() noexcept;
 
 private:
-    // TODO: these should be settings of the engine
-    static constexpr size_t CACHE_CAPACITY = 64u << 20u;   // 64 MiB
-    static constexpr size_t CACHE_MAX_AGE  = 30u;
+    size_t const mCacheCapacity;
+    size_t const mCacheMaxAge;
 
     struct TextureKey {
         const char* name; // doesn't participate in the hash

filament/src/ShadowMap.h

@@ -163,7 +163,7 @@ public:
     FCamera const& getCamera() const noexcept { return *mCamera; }
 
     // use only for debugging
-    FCamera const& getDebugCamera() const noexcept { return *mDebugCamera; }
+    FCamera const* getDebugCamera() const noexcept { return mDebugCamera; }
 
     // Update SceneInfo struct for a given light
     static void updateSceneInfoDirectional(const math::mat4f& Mv, FScene const& scene,

filament/src/ShadowMapManager.cpp

@@ -19,14 +19,21 @@
 #include "RenderPass.h"
 #include "ShadowMap.h"
 
+#include "details/DebugRegistry.h"
 #include "details/Texture.h"
 #include "details/View.h"
 
 #include <fg/FrameGraph.h>
 
+#include <backend/DriverEnums.h>
+
+#include <utils/compiler.h>
 #include <utils/debug.h>
 #include <utils/FixedCapacityVector.h>
 
+#include <new>
+#include <memory>
+
 namespace filament {
 
 using namespace backend;
@@ -128,7 +135,8 @@ void ShadowMapManager::addShadowMap(size_t lightIndex, bool spotlight,
 }
 
 FrameGraphId<FrameGraphTexture> ShadowMapManager::render(FEngine& engine, FrameGraph& fg,
-        RenderPass const& pass, FView& view, CameraInfo const& mainCameraInfo,
+        RenderPassBuilder const& passBuilder,
+        FView& view, CameraInfo const& mainCameraInfo,
         float4 const& userTime) noexcept {
 
     const float moment2 = std::numeric_limits<half>::max();
@@ -206,8 +214,8 @@ FrameGraphId<FrameGraphTexture> ShadowMapManager::render(FEngine& engine, FrameG
                 builder.sideEffect();
             },
             [this, &engine, &view, vsmShadowOptions,
-                scene, mainCameraInfo, userTime, passTemplate = pass](
-                    FrameGraphResources const&, auto const& data, DriverApi& driver) {
+                scene, mainCameraInfo, userTime, passBuilder = passBuilder](
+                    FrameGraphResources const&, auto const& data, DriverApi& driver) mutable {
 
                 // Note: we could almost parallel_for the loop below, the problem currently is
                 // that updatePrimitivesLod() updates temporary global state.
@@ -262,19 +270,20 @@ FrameGraphId<FrameGraphTexture> ShadowMapManager::render(FEngine& engine, FrameG
                                 cameraInfo, scene->getRenderableData(), entry.range);
 
                         // generate and sort the commands for rendering the shadow map
-                        RenderPass pass(passTemplate);
-                        pass.setCamera(cameraInfo);
-                        pass.setVisibilityMask(entry.visibilityMask);
-                        pass.setGeometry(scene->getRenderableData(),
-                                entry.range, scene->getRenderableUBO());
-                        pass.appendCommands(engine, RenderPass::SHADOW);
-                        pass.sortCommands(engine);
+
+                        RenderPass const pass = passBuilder
+                            .camera(cameraInfo)
+                            .visibilityMask(entry.visibilityMask)
+                            .geometry(scene->getRenderableData(),
+                                    entry.range, scene->getRenderableUBO())
+                            .commandTypeFlags(RenderPass::CommandTypeFlags::SHADOW)
+                            .build(engine);
 
                         entry.executor = pass.getExecutor();
 
                         if (!view.hasVSM()) {
                             auto const* options = shadowMap.getShadowOptions();
-                            const PolygonOffset polygonOffset = { // handle reversed Z
+                            PolygonOffset const polygonOffset = { // handle reversed Z
                                     .slope    = -options->polygonOffsetSlope,
                                     .constant = -options->polygonOffsetConstant
                             };
@@ -395,7 +404,6 @@ FrameGraphId<FrameGraphTexture> ShadowMapManager::render(FEngine& engine, FrameG
 
                     auto rt = resources.getRenderPassInfo(data.rt);
 
-                    engine.flush();
                     driver.beginRenderPass(rt.target, rt.params);
                     entry.shadowMap->bind(driver);
                     entry.executor.overrideScissor(entry.shadowMap->getScissor());

filament/src/ShadowMapManager.h

@@ -43,6 +43,7 @@ namespace filament {
 class FView;
 class FrameGraph;
 class RenderPass;
+class RenderPassBuilder;
 
 struct ShadowMappingUniforms {
     math::float4 cascadeSplits;
@@ -86,7 +87,8 @@ public:
             FScene::RenderableSoa& renderableData, FScene::LightSoa const& lightData) noexcept;
 
     // Renders all the shadow maps.
-    FrameGraphId<FrameGraphTexture> render(FEngine& engine, FrameGraph& fg, RenderPass const& pass,
+    FrameGraphId<FrameGraphTexture> render(FEngine& engine, FrameGraph& fg,
+            RenderPassBuilder const& passBuilder,
             FView& view, CameraInfo const& mainCameraInfo, math::float4 const& userTime) noexcept;
 
     // valid after calling update() above
@@ -100,7 +102,7 @@ public:
 
     // for debugging only
     FCamera const* getDirectionalLightCamera() const noexcept {
-        return &getShadowMap(0).getDebugCamera();
+        return getShadowMap(0).getDebugCamera();
     }
 
 private:

filament/src/Stream.cpp

@@ -28,7 +28,8 @@ void Stream::setAcquiredImage(void* image, Callback callback, void* userdata) no
     downcast(this)->setAcquiredImage(image, callback, userdata);
 }
 
-void Stream::setAcquiredImage(void* image, backend::CallbackHandler* handler, Callback callback, void* userdata) noexcept {
+void Stream::setAcquiredImage(void* image,
+        backend::CallbackHandler* handler, Callback callback, void* userdata) noexcept {
     downcast(this)->setAcquiredImage(image, handler, callback, userdata);
 }
 

filament/src/details/DebugRegistry.h

@@ -34,6 +34,10 @@ class FEngine;
 
 class FDebugRegistry : public DebugRegistry {
 public:
+    enum Type {
+        BOOL, INT, FLOAT, FLOAT2, FLOAT3, FLOAT4
+    };
+
     FDebugRegistry() noexcept;
 
     void registerProperty(std::string_view name, bool* p) noexcept {

filament/src/details/Engine.cpp

@@ -198,7 +198,7 @@ FEngine::FEngine(Engine::Builder const& builder) :
         mCommandBufferQueue(
                 builder->mConfig.minCommandBufferSizeMB * MiB,
                 builder->mConfig.commandBufferSizeMB * MiB),
-        mPerRenderPassAllocator(
+        mPerRenderPassArena(
                 "FEngine::mPerRenderPassAllocator",
                 builder->mConfig.perRenderPassArenaSizeMB * MiB),
         mHeapAllocator("FEngine::mHeapAllocator", AreaPolicy::NullArea{}),
@@ -252,7 +252,7 @@ void FEngine::init() {
     slog.i << "FEngine feature level: " << int(mActiveFeatureLevel) << io::endl;
 
 
-    mResourceAllocator = new ResourceAllocator(driverApi);
+    mResourceAllocator = new ResourceAllocator(mConfig, driverApi);
 
     mFullScreenTriangleVb = downcast(VertexBuffer::Builder()
             .vertexCount(3)
@@ -709,7 +709,9 @@ const FMaterial* FEngine::getSkyboxMaterial() const noexcept {
 template<typename T>
 inline T* FEngine::create(ResourceList<T>& list, typename T::Builder const& builder) noexcept {
     T* p = mHeapAllocator.make<T>(*this, builder);
-    list.insert(p);
+    if (UTILS_UNLIKELY(p)) { // this should never happen
+        list.insert(p);
+    }
     return p;
 }
 
@@ -771,7 +773,7 @@ FRenderTarget* FEngine::createRenderTarget(const RenderTarget::Builder& builder)
 
 FRenderer* FEngine::createRenderer() noexcept {
     FRenderer* p = mHeapAllocator.make<FRenderer>(*this);
-    if (p) {
+    if (UTILS_UNLIKELY(p)) { // should never happen
         mRenderers.insert(p);
     }
     return p;
@@ -780,7 +782,7 @@ FRenderer* FEngine::createRenderer() noexcept {
 FMaterialInstance* FEngine::createMaterialInstance(const FMaterial* material,
         const FMaterialInstance* other, const char* name) noexcept {
     FMaterialInstance* p = mHeapAllocator.make<FMaterialInstance>(*this, other, name);
-    if (p) {
+    if (UTILS_UNLIKELY(p)) { // should never happen
         auto pos = mMaterialInstances.emplace(material, "MaterialInstance");
         pos.first->second.insert(p);
     }
@@ -793,7 +795,7 @@ FMaterialInstance* FEngine::createMaterialInstance(const FMaterial* material,
 
 FScene* FEngine::createScene() noexcept {
     FScene* p = mHeapAllocator.make<FScene>(*this);
-    if (p) {
+    if (UTILS_UNLIKELY(p)) { // should never happen
         mScenes.insert(p);
     }
     return p;
@@ -801,7 +803,7 @@ FScene* FEngine::createScene() noexcept {
 
 FView* FEngine::createView() noexcept {
     FView* p = mHeapAllocator.make<FView>(*this);
-    if (p) {
+    if (UTILS_UNLIKELY(p)) { // should never happen
         mViews.insert(p);
     }
     return p;
@@ -809,7 +811,7 @@ FView* FEngine::createView() noexcept {
 
 FFence* FEngine::createFence() noexcept {
     FFence* p = mHeapAllocator.make<FFence>(*this);
-    if (p) {
+    if (UTILS_UNLIKELY(p)) { // should never happen
         std::lock_guard const guard(mFenceListLock);
         mFences.insert(p);
     }
@@ -825,7 +827,7 @@ FSwapChain* FEngine::createSwapChain(void* nativeWindow, uint64_t flags) noexcep
         getDriverApi().setupExternalImage(nativeWindow);
     }
     FSwapChain* p = mHeapAllocator.make<FSwapChain>(*this, nativeWindow, flags);
-    if (p) {
+    if (UTILS_UNLIKELY(p)) { // should never happen
         mSwapChains.insert(p);
     }
     return p;

filament/src/details/Engine.h

@@ -58,17 +58,6 @@
 #include <filament/Texture.h>
 #include <filament/VertexBuffer.h>
 
-#if FILAMENT_ENABLE_MATDBG
-#include <matdbg/DebugServer.h>
-#else
-namespace filament {
-namespace matdbg {
-class DebugServer;
-using MaterialKey = uint32_t;
-} // namespace matdbg
-} // namespace filament
-#endif
-
 #include <utils/compiler.h>
 #include <utils/Allocator.h>
 #include <utils/JobSystem.h>
@@ -78,8 +67,19 @@ using MaterialKey = uint32_t;
 #include <memory>
 #include <new>
 #include <random>
+#include <thread>
+#include <type_traits>
 #include <unordered_map>
 
+#if FILAMENT_ENABLE_MATDBG
+#include <matdbg/DebugServer.h>
+#else
+namespace filament::matdbg {
+class DebugServer;
+using MaterialKey = uint32_t;
+} // namespace filament::matdbg
+#endif
+
 namespace filament {
 
 class Renderer;
@@ -142,7 +142,7 @@ public:
     // the per-frame Area is used by all Renderer, so they must run in sequence and
     // have freed all allocated memory when done. If this needs to change in the future,
     // we'll simply have to use separate Areas (for instance).
-    LinearAllocatorArena& getPerRenderPassAllocator() noexcept { return mPerRenderPassAllocator; }
+    LinearAllocatorArena& getPerRenderPassArena() noexcept { return mPerRenderPassArena; }
 
     // Material IDs...
     uint32_t getMaterialId() const noexcept { return mMaterialId++; }
@@ -508,7 +508,7 @@ private:
 
     uint32_t mFlushCounter = 0;
 
-    LinearAllocatorArena mPerRenderPassAllocator;
+    RootArenaScope::Arena mPerRenderPassArena;
     HeapAllocatorArena mHeapAllocator;
 
     utils::JobSystem mJobSystem;

filament/src/details/MaterialInstance.cpp

@@ -269,7 +269,7 @@ const char* FMaterialInstance::getName() const noexcept {
     // the instance's CString rather than calling empty(). This allows instances to override the
     // parent material's name with a blank string.
     if (mName.data() == nullptr) {
-        return mMaterial->getName().c_str();
+        return mMaterial->getName().c_str_safe();
     }
     return mName.c_str();
 }

filament/src/details/Renderer.cpp

@@ -16,6 +16,9 @@
 
 #include "details/Renderer.h"
 
+#include "Allocators.h"
+#include "DebugRegistry.h"
+#include "FrameHistory.h"
 #include "PostProcessManager.h"
 #include "RendererUtils.h"
 #include "RenderPass.h"
@@ -28,21 +31,40 @@
 #include "details/Texture.h"
 #include "details/View.h"
 
+#include <filament/Camera.h>
+#include <filament/Fence.h>
+#include <filament/Options.h>
 #include <filament/Renderer.h>
 
+#include <backend/DriverEnums.h>
+#include <backend/DriverApiForward.h>
+#include <backend/Handle.h>
 #include <backend/PixelBufferDescriptor.h>
 
 #include "fg/FrameGraph.h"
 #include "fg/FrameGraphId.h"
 #include "fg/FrameGraphResources.h"
+#include "fg/FrameGraphTexture.h"
+
+#include <math/vec2.h>
+#include <math/vec3.h>
+#include <math/mat4.h>
 
 #include <utils/compiler.h>
 #include <utils/JobSystem.h>
+#include <utils/Log.h>
+#include <utils/ostream.h>
 #include <utils/Panic.h>
 #include <utils/Systrace.h>
-#include <utils/vector.h>
 #include <utils/debug.h>
 
+#include <chrono>
+#include <limits>
+#include <utility>
+
+#include <stddef.h>
+#include <stdint.h>
+
 // this helps visualize what dynamic-scaling is doing
 #define DEBUG_DYNAMIC_SCALING false
 
@@ -62,8 +84,7 @@ FRenderer::FRenderer(FEngine& engine) :
         mHdrQualityMedium(TextureFormat::R11F_G11F_B10F),
         mHdrQualityHigh(TextureFormat::RGB16F),
         mIsRGB8Supported(false),
-        mUserEpoch(engine.getEngineEpoch()),
-        mPerRenderPassArena(engine.getPerRenderPassAllocator())
+        mUserEpoch(engine.getEngineEpoch())
 {
     FDebugRegistry& debugRegistry = engine.getDebugRegistry();
     debugRegistry.registerProperty("d.renderer.doFrameCapture",
@@ -442,7 +463,7 @@ void FRenderer::render(FView const* view) {
 
     if (UTILS_LIKELY(view && view->getScene())) {
         if (mViewRenderedCount) {
-            // this is a good place to kick the GPU, since we've rendered a View before,
+            // This is a good place to kick the GPU, since we've rendered a View before,
             // and we're about to render another one.
             mEngine.getDriverApi().flush();
         }
@@ -452,17 +473,17 @@ void FRenderer::render(FView const* view) {
 }
 
 void FRenderer::renderInternal(FView const* view) {
-    // per-renderpass data
-    ArenaScope rootArena(mPerRenderPassArena);
-
     FEngine& engine = mEngine;
-    JobSystem& js = engine.getJobSystem();
+
+    // per-renderpass data
+    RootArenaScope rootArenaScope(engine.getPerRenderPassArena());
 
     // create a root job so no other job can escape
+    JobSystem& js = engine.getJobSystem();
     auto *rootJob = js.setRootJob(js.createJob());
 
     // execute the render pass
-    renderJob(rootArena, const_cast<FView&>(*view));
+    renderJob(rootArenaScope, const_cast<FView&>(*view));
 
     // make sure to flush the command buffer
     engine.flush();
@@ -471,7 +492,7 @@ void FRenderer::renderInternal(FView const* view) {
     js.runAndWait(rootJob);
 }
 
-void FRenderer::renderJob(ArenaScope& arena, FView& view) {
+void FRenderer::renderJob(RootArenaScope& rootArenaScope, FView& view) {
     FEngine& engine = mEngine;
     JobSystem& js = engine.getJobSystem();
     FEngine::DriverApi& driver = engine.getDriverApi();
@@ -636,7 +657,7 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
         xvp.bottom = int32_t(guardBand);
     }
 
-    view.prepare(engine, driver, arena, svp, cameraInfo, getShaderUserTime(), needsAlphaChannel);
+    view.prepare(engine, driver, rootArenaScope, svp, cameraInfo, getShaderUserTime(), needsAlphaChannel);
 
     view.prepareUpscaler(scale, taaOptions, dsrOptions);
 
@@ -649,8 +670,10 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     // Allocate some space for our commands in the per-frame Arena, and use that space as
     // an Arena for commands. All this space is released when we exit this method.
     size_t const perFrameCommandsSize = engine.getPerFrameCommandsSize();
-    void* const arenaBegin = arena.allocate(perFrameCommandsSize, CACHELINE_SIZE);
+    void* const arenaBegin = rootArenaScope.allocate(perFrameCommandsSize, CACHELINE_SIZE);
     void* const arenaEnd = pointermath::add(arenaBegin, perFrameCommandsSize);
+
+    // This arena *must* stay valid until all commands have been processed
     RenderPass::Arena commandArena("Command Arena", { arenaBegin, arenaEnd });
 
     RenderPass::RenderFlags renderFlags = 0;
@@ -658,8 +681,8 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     if (view.isFrontFaceWindingInverted())  renderFlags |= RenderPass::HAS_INVERSE_FRONT_FACES;
     if (view.hasInstancedStereo())          renderFlags |= RenderPass::IS_STEREOSCOPIC;
 
-    RenderPass pass(engine, commandArena);
-    pass.setRenderFlags(renderFlags);
+    RenderPassBuilder passBuilder(commandArena);
+    passBuilder.renderFlags(renderFlags);
 
     Variant variant;
     variant.setDirectionalLighting(view.hasDirectionalLight());
@@ -682,10 +705,10 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     if (view.needsShadowMap()) {
         Variant shadowVariant(Variant::DEPTH_VARIANT);
         shadowVariant.setVsm(view.getShadowType() == ShadowType::VSM);
-
-        RenderPass shadowPass(pass);
-        shadowPass.setVariant(shadowVariant);
-        auto shadows = view.renderShadowMaps(engine, fg, cameraInfo, mShaderUserTime, shadowPass);
+        auto shadows = view.renderShadowMaps(engine, fg, cameraInfo, mShaderUserTime,
+                RenderPassBuilder{ commandArena }
+                    .renderFlags(renderFlags)
+                    .variant(shadowVariant));
         blackboard["shadows"] = shadows;
     }
 
@@ -771,8 +794,9 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     view.updatePrimitivesLod(engine, cameraInfo,
             scene.getRenderableData(), view.getVisibleRenderables());
 
-    pass.setCamera(cameraInfo);
-    pass.setGeometry(scene.getRenderableData(), view.getVisibleRenderables(), scene.getRenderableUBO());
+    passBuilder.camera(cameraInfo);
+    passBuilder.geometry(scene.getRenderableData(),
+            view.getVisibleRenderables(), scene.getRenderableUBO());
 
     // view set-ups that need to happen before rendering
     fg.addTrivialSideEffectPass("Prepare View Uniforms",
@@ -818,7 +842,8 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     // This is normally used by SSAO and contact-shadows
 
     // TODO: the scaling should depends on all passes that need the structure pass
-    const auto [structure, picking_] = ppm.structure(fg, pass, renderFlags, svp.width, svp.height, {
+    const auto [structure, picking_] = ppm.structure(fg,
+            passBuilder, renderFlags, svp.width, svp.height, {
             .scale = aoOptions.resolution,
             .picking = view.hasPicking()
     });
@@ -876,7 +901,7 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     // screen-space reflections pass
 
     if (ssReflectionsOptions.enabled) {
-        auto reflections = ppm.ssr(fg, pass,
+        auto reflections = ppm.ssr(fg, passBuilder,
                 view.getFrameHistory(), cameraInfo,
                 view.getPerViewUniforms(),
                 structure,
@@ -894,10 +919,15 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
     // --------------------------------------------------------------------------------------------
     // Color passes
 
+    // this makes the viewport relative to xvp
+    // FIXME: we should use 'vp' when rendering directly into the swapchain, but that's hard to
+    //        know at this point. This will usually be the case when post-process is disabled.
+    // FIXME: we probably should take the dynamic scaling into account too
+    passBuilder.scissorViewport(hasPostProcess ? xvp : vp);
+
     // This one doesn't need to be a FrameGraph pass because it always happens by construction
     // (i.e. it won't be culled, unless everything is culled), so no need to complexify things.
-    pass.setVariant(variant);
-    pass.appendCommands(engine, RenderPass::COLOR);
+    passBuilder.variant(variant);
 
     // color-grading as subpass is done either by the color pass or the TAA pass if any
     auto colorGradingConfigForColor = colorGradingConfig;
@@ -905,7 +935,7 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
 
     if (colorGradingConfigForColor.asSubpass) {
         // append color grading subpass after all other passes
-        pass.appendCustomCommand(3,
+        passBuilder.customCommand(engine, 3,
                 RenderPass::Pass::BLENDED,
                 RenderPass::CustomCommand::EPILOG,
                 0, [&ppm, &driver, colorGradingConfigForColor]() {
@@ -913,7 +943,7 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
                 });
     } else if (colorGradingConfig.customResolve) {
         // append custom resolve subpass after all other passes
-        pass.appendCustomCommand(3,
+        passBuilder.customCommand(engine, 3,
                 RenderPass::Pass::BLENDED,
                 RenderPass::CustomCommand::EPILOG,
                 0, [&ppm, &driver]() {
@@ -921,16 +951,9 @@ void FRenderer::renderJob(ArenaScope& arena, FView& view) {
                 });
     }
 
-    // sort commands once we're done adding commands
-    pass.sortCommands(engine);
-
-
-    // this makes the viewport relative to xvp
-    // FIXME: we should use 'vp' when rendering directly into the swapchain, but that's hard to
-    //        know at this point. This will usually be the case when post-process is disabled.
-    // FIXME: we probably should take the dynamic scaling into account too
-    pass.setScissorViewport(hasPostProcess ? xvp : vp);
+    passBuilder.commandTypeFlags(RenderPass::CommandTypeFlags::COLOR);
 
+    RenderPass const pass{ passBuilder.build(engine) };
 
     FrameGraphTexture::Descriptor const desc = {
             .width = config.physicalViewport.width,

filament/src/details/Renderer.h

@@ -163,7 +163,7 @@ private:
     }
 
     void renderInternal(FView const* view);
-    void renderJob(ArenaScope& arena, FView& view);
+    void renderJob(RootArenaScope& rootArenaScope, FView& view);
 
     // keep a reference to our engine
     FEngine& mEngine;
@@ -187,9 +187,6 @@ private:
     backend::TargetBufferFlags mClearFlags{};
     tsl::robin_set<FRenderTarget*> mPreviousRenderTargets;
     std::function<void()> mBeginFrameInternal;
-
-    // per-frame arena for this Renderer
-    LinearAllocatorArena& mPerRenderPassArena;
 };
 
 FILAMENT_DOWNCAST(Renderer)

filament/src/details/Scene.cpp

@@ -53,7 +53,7 @@ FScene::~FScene() noexcept = default;
 
 
 void FScene::prepare(utils::JobSystem& js,
-        LinearAllocatorArena& allocator,
+        RootArenaScope& rootArenaScope,
         mat4 const& worldTransform,
         bool shadowReceiversAreCasters) noexcept {
     // TODO: can we skip this in most cases? Since we rely on indices staying the same,
@@ -64,7 +64,7 @@ void FScene::prepare(utils::JobSystem& js,
     SYSTRACE_CONTEXT();
 
     // This will reset the allocator upon exiting
-    ArenaScope const arena(allocator);
+    ArenaScope<RootArenaScope::Arena> localArenaScope(rootArenaScope.getArena());
 
     FEngine& engine = mEngine;
     EntityManager const& em = engine.getEntityManager();
@@ -85,10 +85,10 @@ void FScene::prepare(utils::JobSystem& js,
             utils::STLAllocator< LightContainerData, LinearAllocatorArena >, false>;
 
     RenderableInstanceContainer renderableInstances{
-            RenderableInstanceContainer::with_capacity(entities.size(), allocator) };
+            RenderableInstanceContainer::with_capacity(entities.size(), localArenaScope.getArena()) };
 
     LightInstanceContainer lightInstances{
-            LightInstanceContainer::with_capacity(entities.size(), allocator) };
+            LightInstanceContainer::with_capacity(entities.size(), localArenaScope.getArena()) };
 
     SYSTRACE_NAME_BEGIN("InstanceLoop");
 
@@ -454,7 +454,7 @@ void FScene::terminate(FEngine&) {
     mRenderableViewUbh.clear();
 }
 
-void FScene::prepareDynamicLights(const CameraInfo& camera, ArenaScope&,
+void FScene::prepareDynamicLights(const CameraInfo& camera,
         Handle<HwBufferObject> lightUbh) noexcept {
     FEngine::DriverApi& driver = mEngine.getDriverApi();
     FLightManager const& lcm = mEngine.getLightManager();

filament/src/details/Scene.h

@@ -31,6 +31,8 @@
 #include <filament/Box.h>
 #include <filament/Scene.h>
 
+#include <math/mathfwd.h>
+
 #include <utils/compiler.h>
 #include <utils/Entity.h>
 #include <utils/Slice.h>
@@ -70,12 +72,12 @@ public:
     ~FScene() noexcept;
     void terminate(FEngine& engine);
 
-    void prepare(utils::JobSystem& js, LinearAllocatorArena& allocator,
+    void prepare(utils::JobSystem& js, RootArenaScope& rootArenaScope,
             math::mat4 const& worldTransform, bool shadowReceiversAreCasters) noexcept;
 
     void prepareVisibleRenderables(utils::Range<uint32_t> visibleRenderables) noexcept;
 
-    void prepareDynamicLights(const CameraInfo& camera, ArenaScope& arena,
+    void prepareDynamicLights(const CameraInfo& camera,
             backend::Handle<backend::HwBufferObject> lightUbh) noexcept;
 
     backend::Handle<backend::HwBufferObject> getRenderableUBO() const noexcept {

filament/src/details/Stream.cpp

@@ -86,11 +86,13 @@ void FStream::terminate(FEngine& engine) noexcept {
     engine.getDriverApi().destroyStream(mStreamHandle);
 }
 
-void FStream::setAcquiredImage(void* image, Callback callback, void* userdata) noexcept {
+void FStream::setAcquiredImage(void* image,
+        Callback callback, void* userdata) noexcept {
     mEngine.getDriverApi().setAcquiredImage(mStreamHandle, image, nullptr, callback, userdata);
 }
 
-void FStream::setAcquiredImage(void* image, CallbackHandler* handler, Callback callback, void* userdata) noexcept {
+void FStream::setAcquiredImage(void* image,
+        CallbackHandler* handler, Callback callback, void* userdata) noexcept {
     mEngine.getDriverApi().setAcquiredImage(mStreamHandle, image, handler, callback, userdata);
 }
 

filament/src/details/View.cpp

@@ -341,8 +341,7 @@ void FView::prepareShadowing(FEngine& engine, FScene::RenderableSoa& renderableD
     mNeedsShadowMap = any(shadowTechnique & ShadowMapManager::ShadowTechnique::SHADOW_MAP);
 }
 
-void FView::prepareLighting(FEngine& engine, ArenaScope& arena,
-        CameraInfo const& cameraInfo) noexcept {
+void FView::prepareLighting(FEngine& engine, CameraInfo const& cameraInfo) noexcept {
     SYSTRACE_CALL();
     SYSTRACE_CONTEXT();
 
@@ -354,7 +353,7 @@ void FView::prepareLighting(FEngine& engine, ArenaScope& arena,
      */
 
     if (hasDynamicLighting()) {
-        scene->prepareDynamicLights(cameraInfo, arena, mLightUbh);
+        scene->prepareDynamicLights(cameraInfo, mLightUbh);
     }
 
     // here the array of visible lights has been shrunk to CONFIG_MAX_LIGHT_COUNT
@@ -427,7 +426,7 @@ CameraInfo FView::computeCameraInfo(FEngine& engine) const noexcept {
     return { *camera, mat4{ rotation } * mat4::translation(translation) };
 }
 
-void FView::prepare(FEngine& engine, DriverApi& driver, ArenaScope& arena,
+void FView::prepare(FEngine& engine, DriverApi& driver, RootArenaScope& rootArenaScope,
         filament::Viewport viewport, CameraInfo cameraInfo,
         float4 const& userTime, bool needsAlphaChannel) noexcept {
 
@@ -465,7 +464,7 @@ void FView::prepare(FEngine& engine, DriverApi& driver, ArenaScope& arena,
      * Gather all information needed to render this scene. Apply the world origin to all
      * objects in the scene.
      */
-    scene->prepare(js, arena.getAllocator(),
+    scene->prepare(js, rootArenaScope,
             cameraInfo.worldTransform,
             hasVSM());
 
@@ -475,14 +474,22 @@ void FView::prepare(FEngine& engine, DriverApi& driver, ArenaScope& arena,
 
     JobSystem::Job* froxelizeLightsJob = nullptr;
     JobSystem::Job* prepareVisibleLightsJob = nullptr;
-    if (scene->getLightData().size() > FScene::DIRECTIONAL_LIGHTS_COUNT) {
+    size_t const lightCount = scene->getLightData().size();
+    if (lightCount > FScene::DIRECTIONAL_LIGHTS_COUNT) {
         // create and start the prepareVisibleLights job
         // note: this job updates LightData (non const)
+        // allocate a scratch buffer for distances outside the job below, so we don't need
+        // to use a locked allocator; the downside is that we need to account for the worst case.
+        size_t const positionalLightCount = lightCount - FScene::DIRECTIONAL_LIGHTS_COUNT;
+        float* const distances = rootArenaScope.allocate<float>(
+                (positionalLightCount + 3u) & ~3u, CACHELINE_SIZE);
+
         prepareVisibleLightsJob = js.runAndRetain(js.createJob(nullptr,
-                [&engine, &arena, &viewMatrix = cameraInfo.view, &cullingFrustum,
+                [&engine, distances, positionalLightCount, &viewMatrix = cameraInfo.view, &cullingFrustum,
                  &lightData = scene->getLightData()]
                         (JobSystem&, JobSystem::Job*) {
-                    FView::prepareVisibleLights(engine.getLightManager(), arena,
+                    FView::prepareVisibleLights(engine.getLightManager(),
+                            { distances, distances + positionalLightCount },
                             viewMatrix, cullingFrustum, lightData);
                 }));
     }
@@ -530,7 +537,7 @@ void FView::prepare(FEngine& engine, DriverApi& driver, ArenaScope& arena,
         // As soon as prepareVisibleLight finishes, we can kick-off the froxelization
         if (hasDynamicLighting()) {
             auto& froxelizer = mFroxelizer;
-            if (froxelizer.prepare(driver, arena, viewport,
+            if (froxelizer.prepare(driver, rootArenaScope, viewport,
                     cameraInfo.projection, cameraInfo.zn, cameraInfo.zf)) {
                 // TODO: might be more consistent to do this in prepareLighting(), but it's not
                 //       strictly necessary
@@ -645,7 +652,7 @@ void FView::prepare(FEngine& engine, DriverApi& driver, ArenaScope& arena,
      * Relies on FScene::prepare() and prepareVisibleLights()
      */
 
-    prepareLighting(engine, arena, cameraInfo);
+    prepareLighting(engine, cameraInfo);
 
     /*
      * Update driver state
@@ -850,7 +857,8 @@ void FView::cullRenderables(JobSystem&,
     functor(0, renderableData.size());
 }
 
-void FView::prepareVisibleLights(FLightManager const& lcm, ArenaScope& rootArena,
+void FView::prepareVisibleLights(FLightManager const& lcm,
+        utils::Slice<float> scratch,
         mat4f const& viewMatrix, Frustum const& frustum,
         FScene::LightSoa& lightData) noexcept {
     SYSTRACE_CALL();
@@ -918,28 +926,25 @@ void FView::prepareVisibleLights(FLightManager const& lcm, ArenaScope& rootArena
      * - This helps our limited numbers of spot-shadow as well.
      */
 
-    ArenaScope arena(rootArena.getAllocator());
-    size_t const size = visibleLightCount;
     // number of point/spotlights
-    size_t const positionalLightCount = size - FScene::DIRECTIONAL_LIGHTS_COUNT;
+    size_t const positionalLightCount = visibleLightCount - FScene::DIRECTIONAL_LIGHTS_COUNT;
     if (positionalLightCount) {
-        // always allocate at least 4 entries, because the vectorized loops below rely on that
-        float* const UTILS_RESTRICT distances =
-                arena.allocate<float>((size + 3u) & ~3u, CACHELINE_SIZE);
-
+        assert_invariant(positionalLightCount <= scratch.size());
         // pre-compute the lights' distance to the camera, for sorting below
         // - we don't skip the directional light, because we don't care, it's ignored during sorting
+        float* const UTILS_RESTRICT distances = scratch.data();
         float4 const* const UTILS_RESTRICT spheres = lightData.data<FScene::POSITION_RADIUS>();
-        computeLightCameraDistances(distances, viewMatrix, spheres, size);
+        computeLightCameraDistances(distances, viewMatrix, spheres, visibleLightCount);
 
         // skip directional light
         Zip2Iterator<FScene::LightSoa::iterator, float*> b = { lightData.begin(), distances };
-        std::sort(b + FScene::DIRECTIONAL_LIGHTS_COUNT, b + size,
+        std::sort(b + FScene::DIRECTIONAL_LIGHTS_COUNT, b + visibleLightCount,
                 [](auto const& lhs, auto const& rhs) { return lhs.second < rhs.second; });
     }
 
     // drop excess lights
-    lightData.resize(std::min(size, CONFIG_MAX_LIGHT_COUNT + FScene::DIRECTIONAL_LIGHTS_COUNT));
+    lightData.resize(std::min(visibleLightCount,
+            CONFIG_MAX_LIGHT_COUNT + FScene::DIRECTIONAL_LIGHTS_COUNT));
 }
 
 // These methods need to exist so clang honors the __restrict__ keyword, which in turn
@@ -972,8 +977,9 @@ void FView::updatePrimitivesLod(FEngine& engine, const CameraInfo&,
 }
 
 FrameGraphId<FrameGraphTexture> FView::renderShadowMaps(FEngine& engine, FrameGraph& fg,
-        CameraInfo const& cameraInfo, float4 const& userTime, RenderPass const& pass) noexcept {
-    return mShadowMapManager.render(engine, fg, pass, *this, cameraInfo, userTime);
+        CameraInfo const& cameraInfo, float4 const& userTime,
+        RenderPassBuilder const& passBuilder) noexcept {
+    return mShadowMapManager.render(engine, fg, passBuilder, *this, cameraInfo, userTime);
 }
 
 void FView::commitFrameHistory(FEngine& engine) noexcept {

filament/src/details/View.h

@@ -88,7 +88,7 @@ public:
 
     // note: viewport/cameraInfo are passed by value to make it clear that prepare cannot
     // keep references on them that would outlive the scope of prepare() (e.g. with JobSystem).
-    void prepare(FEngine& engine, backend::DriverApi& driver, ArenaScope& arena,
+    void prepare(FEngine& engine, backend::DriverApi& driver, RootArenaScope& rootArenaScope,
             filament::Viewport viewport, CameraInfo cameraInfo,
             math::float4 const& userTime, bool needsAlphaChannel) noexcept;
 
@@ -144,7 +144,7 @@ public:
 
     void prepareShadowing(FEngine& engine, FScene::RenderableSoa& renderableData,
             FScene::LightSoa const& lightData, CameraInfo const& cameraInfo) noexcept;
-    void prepareLighting(FEngine& engine, ArenaScope& arena, CameraInfo const& cameraInfo) noexcept;
+    void prepareLighting(FEngine& engine, CameraInfo const& cameraInfo) noexcept;
 
     void prepareSSAO(backend::Handle<backend::HwTexture> ssao) const noexcept;
     void prepareSSR(backend::Handle<backend::HwTexture> ssr, bool disableSSR,
@@ -176,7 +176,7 @@ public:
 
     FrameGraphId<FrameGraphTexture> renderShadowMaps(FEngine& engine, FrameGraph& fg,
             CameraInfo const& cameraInfo, math::float4 const& userTime,
-            RenderPass const& pass) noexcept;
+            RenderPassBuilder const& passBuilder) noexcept;
 
     void updatePrimitivesLod(
             FEngine& engine, const CameraInfo& camera,
@@ -460,7 +460,8 @@ private:
     void prepareVisibleRenderables(utils::JobSystem& js,
             Frustum const& frustum, FScene::RenderableSoa& renderableData) const noexcept;
 
-    static void prepareVisibleLights(FLightManager const& lcm, ArenaScope& rootArena,
+    static void prepareVisibleLights(FLightManager const& lcm,
+            utils::Slice<float> scratch,
             math::mat4f const& viewMatrix, Frustum const& frustum,
             FScene::LightSoa& lightData) noexcept;
 
@@ -490,7 +491,7 @@ private:
 
     FScene* mScene = nullptr;
     // The camera set by the user, used for culling and viewing
-    FCamera* mCullingCamera = nullptr;
+    FCamera* /* UTILS_NONNULL */ mCullingCamera = nullptr; // FIXME: should alaways be non-null
     // The optional (debug) camera, used only for viewing
     FCamera* mViewingCamera = nullptr;
 

ios/CocoaPods/Filament.podspec

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

libs/astrict/CMakeLists.txt

@@ -1,108 +0,0 @@
-cmake_minimum_required(VERSION 3.19)
-project(astrict)
-
-set(TARGET         astrict)
-set(PUBLIC_HDR_DIR include)
-
-# ==================================================================================================
-# Sources and headers
-# ==================================================================================================
-set(HDRS
-        include/astrict/CommonTypes.h
-        include/astrict/DebugCommon.h
-        include/astrict/DebugGlsl.h
-        include/astrict/FromGlsl.h
-        include/astrict/GlslTypes.h
-        include/astrict/ToGlsl.h)
-
-set(PRIVATE_HDRS)
-
-set(SRCS
-        src/DebugCommon.cpp
-        src/DebugGlsl.cpp
-        src/FromGlsl.cpp
-        src/ToGlsl.cpp)
-
-# ==================================================================================================
-# Include and target definitions
-# ==================================================================================================
-include_directories(${PUBLIC_HDR_DIR})
-include_directories(${CMAKE_BINARY_DIR})
-
-# astrict
-add_library(${TARGET} STATIC ${HDRS} ${PRIVATE_HDRS} ${SRCS})
-target_include_directories(${TARGET} PUBLIC ${PUBLIC_HDR_DIR})
-set_target_properties(${TARGET} PROPERTIES FOLDER Libs)
-target_link_libraries(${TARGET} backend_headers math utils)
-
-# We are being naughty and accessing private headers here
-# For spirv-tools, we're just following glslang's example
-target_include_directories(${TARGET} PRIVATE ${spirv-tools_SOURCE_DIR}/include)
-
-# glslang libraries have circular dependencies. To make sure the proper object are part of the link
-# we need to force archive re-scan on new symbol dependencies via start/end-group.
-# Read more about this here https://eli.thegreenplace.net/2013/07/09/library-order-in-static-linking
-if (APPLE OR MSVC)
-    target_link_libraries(${TARGET} glslang SPIRV SPIRV-Tools-opt spirv-cross-glsl)
-else()
-    target_link_libraries(${TARGET}
-            -Wl,--start-group glslang SPIRV SPIRV-Tools-opt spirv-cross-glsl -Wl,--end-group)
-endif()
-
-# ==================================================================================================
-# Compiler flags
-# ==================================================================================================
-# this must match options enabled in glslang's CMakeLists.txt
-target_compile_options(${TARGET} PRIVATE -DAMD_EXTENSIONS -DNV_EXTENSIONS )
-
-if (MSVC)
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W0 /Zc:__cplusplus")
-endif()
-
-if (FILAMENT_ENABLE_MATDBG)
-    add_definitions(-DFILAMENT_ENABLE_MATDBG)
-endif()
-
-# ==================================================================================================
-# Installation
-# ==================================================================================================
-
-# Astrict has dependencies on a bunch of SPIRV-related libraries. To make things simpler, we bundle
-# them together into a single shared library and copy this into the installation folder. This
-# requires us to explicitly list the dependencies below, as CMake doesn't have a way to recursively
-# query dependencies.
-set(ASTRICT_DEPS
-        OGLCompiler
-        OSDependent
-        SPIRV
-        SPIRV-Tools
-        SPIRV-Tools-opt
-        astrict
-        glslang
-        spirv-cross-core
-        spirv-cross-glsl
-        spirv-cross-msl
-        )
-
-set(ASTRICT_COMBINED_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/libastrict_combined.a")
-combine_static_libs(astrict "${ASTRICT_COMBINED_OUTPUT}" "${ASTRICT_DEPS}")
-
-set(ASTRICT_LIB_NAME ${CMAKE_STATIC_LIBRARY_PREFIX}astrict${CMAKE_STATIC_LIBRARY_SUFFIX})
-install(FILES "${ASTRICT_COMBINED_OUTPUT}" DESTINATION lib/${DIST_DIR} RENAME ${ASTRICT_LIB_NAME})
-install(DIRECTORY ${PUBLIC_HDR_DIR}/astrict DESTINATION include)
-
-# ==================================================================================================
-# Tests
-# ==================================================================================================
-project(test_astrict)
-set(TARGET test_astrict)
-set(SRCS
-        tests/test_FromGlsl.cpp)
-
-add_executable(${TARGET} ${SRCS})
-
-target_include_directories(${TARGET} PRIVATE src)
-
-target_link_libraries(${TARGET} astrict gtest)
-
-set_target_properties(${TARGET} PROPERTIES FOLDER Tests)

libs/astrict/include/astrict/AstrictBuilder.h

@@ -1,86 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_ASTRICT_BUILDER_H
-#define TNT_ASTRICT_ASTRICT_BUILDER_H
-
-#include <set>
-#include <unordered_map>
-
-#include <astrict/CommonTypes.h>
-
-namespace astrict {
-
-using StringId = Newtype<int, struct StringIdTag>;
-using ExpressionId = Newtype<int, struct ExpressionIdTag>;
-using GlobalVariableId = Newtype<int, struct GlobalVariableIdTag>;
-using StructId = Newtype<int, struct StructIdTag>;
-using FunctionId = Newtype<int, struct FunctionIdTag>;
-
-using LocalVariableId = Newtype<int, struct LocalVariableIdTag>;
-
-template<typename Id, typename Value>
-class IdStore {
-public:
-    // Inserts if non-existent.
-    Id insert(Value value, bool* outWasExtant = nullptr) {
-        auto it = mMap.find(value);
-        if (it == mMap.end()) {
-            Id id(mMap.size() + 1);
-            mMap[value] = id;
-            if (outWasExtant) {
-                *outWasExtant = false;
-            }
-            return id;
-        }
-        if (outWasExtant) {
-            *outWasExtant = true;
-        }
-        return it->second;
-    }
-
-    std::vector<Value> getFinal() {
-        std::vector<Value> r(mMap.size());
-        for (const auto& pair : mMap) {
-            r[pair.second] = pair.first;
-        }
-        return r;
-    }
-
-private:
-    std::unordered_map<Value, Id> mMap;
-};
-
-using ByteVector = std::vector<uint8_t>;
-
-class AstrictBuilder {
-public:
-    std::vector<ByteVector> build();
-
-private:
-    IdStore<StringId, std::string> mStrings;
-    IdStore<ExpressionId, ByteVector> mExpressions;
-    IdStore<StructId, ByteVector> mStructs;
-    IdStore<GlobalVariableId, ByteVector> mGlobalSymbols;
-    IdStore<FunctionId, ByteVector> mFunctions;
-    IdStore<FunctionId, ByteVector> mFunctionBodies;
-    std::unordered_map<StructId, std::string> mStructNames;
-    std::unordered_map<GlobalVariableId, std::string> mGlobalVariableNames;
-};
-
-}  // namespace astrict
-
-#endif  // TNT_ASTRICT_ASTRICT_BUILDER_H

libs/astrict/include/astrict/CommonTypes.h

@@ -1,473 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_COMMONTYPES_H
-#define TNT_ASTRICT_COMMONTYPES_H
-
-#include <variant>
-#include <vector>
-
-namespace astrict {
-
-template<typename T, typename Tag>
-class Newtype {
-public:
-    Newtype() : mValue() {}
-    Newtype(const Newtype<T, Tag> &other) : mValue(other.mValue) {}
-    Newtype(Newtype<T, Tag> &&other) : mValue(other.mValue) {}
-    explicit Newtype(T& value) : mValue(value) {}
-    explicit Newtype(T&& value) : mValue(value) {}
-
-    Newtype& operator=(const Newtype<T, Tag>& other) {
-        mValue = other.mValue;
-        return *this;
-    }
-
-    Newtype& operator=(Newtype<T, Tag>&& other) {
-        mValue = other.mValue;
-        return *this;
-    }
-
-    const T& operator*() const {
-        return mValue;
-    }
-
-    bool operator==(const Newtype<T, Tag>& o) const {
-        return mValue == o.mValue;
-    }
-
-    bool operator<(const Newtype<T, Tag>& o) const {
-        return mValue < o.mValue;
-    }
-private:
-    T mValue;
-};
-
-template<class>
-inline constexpr bool always_false_v = false;
-
-}  // namespace astrict
-
-namespace std {
-
-template<typename Tag>
-struct hash<astrict::Newtype<int, Tag>> {
-    std::size_t operator()(const astrict::Newtype<int, Tag>& o) const {
-        return *o;
-    }
-};
-
-template<typename Tag>
-struct hash<astrict::Newtype<uint16_t, Tag>> {
-    std::size_t operator()(const astrict::Newtype<uint16_t, Tag>& o) const {
-        return *o;
-    }
-};
-
-}  // namespace std
-
-namespace astrict {
-
-enum class BranchOperator : uint8_t {
-    Discard,             // Fragment only
-    TerminateInvocation, // Fragment only
-    Demote,              // Fragment only
-    TerminateRayEXT,         // Any-hit only
-    IgnoreIntersectionEXT,   // Any-hit only
-    Return,
-    Break,
-    Continue,
-    Case,
-    Default,
-};
-
-// Represents an operation whose syntax differs from a function call. For example, addition,
-// equality.
-enum class ExpressionOperator : uint8_t {
-    // Unary
-    Negative,
-    LogicalNot,
-    BitwiseNot,
-    PostIncrement,
-    PostDecrement,
-    PreIncrement,
-    PreDecrement,
-    ArrayLength,
-
-    // Binary
-    Add,
-    Sub,
-    Mul,
-    Div,
-    Mod,
-    RightShift,
-    LeftShift,
-    And,
-    InclusiveOr,
-    ExclusiveOr,
-    Equal,
-    NotEqual,
-    LessThan,
-    GreaterThan,
-    LessThanEqual,
-    GreaterThanEqual,
-    LogicalOr,
-    LogicalXor,
-    LogicalAnd,
-    Index,
-    Assign,
-    AddAssign,
-    SubAssign,
-    MulAssign,
-    DivAssign,
-    ModAssign,
-    AndAssign,
-    InclusiveOrAssign,
-    ExclusiveOrAssign,
-    LeftShiftAssign,
-    RightShiftAssign,
-
-    // Ternary
-    Ternary,
-
-    // Variadic
-    Comma,
-};
-
-using VariableOrExpressionId = std::variant<GlobalVariableId, LocalVariableId, ExpressionId>;
-
-struct StructMember {
-    StringId qualifier;
-    StringId type;
-
-    bool operator==(const StructMember& o) const {
-        return qualifier == o.qualifier
-                && type == o.type;
-    }
-};
-
-struct Struct {
-    StringId qualifier;
-    std::vector<StructMember> members;
-    std::vector<StringId> memberNames;
-
-    bool operator==(const Struct& o) const {
-        return qualifier == o.qualifier
-                && members == o.members
-                && memberNames == o.memberNames;
-    }
-};
-
-struct Type {
-    std::variant<StringId, StructId> name;
-    std::optional<StringId> qualifiers;
-    std::vector<std::size_t> arraySizes;
-
-    bool operator==(const Type& o) const {
-        return name == o.name
-                && qualifiers == o.qualifiers
-                && arraySizes == o.arraySizes;
-    }
-};
-
-struct Variable {
-    StringId qualifier;
-    StringId type;
-    std::optional<StringId> name;
-
-    bool operator==(const Variable& o) const {
-        return qualifier == o.qualifier
-                && type == o.type
-                && name == o.name;
-    }
-};
-
-struct ExpressionOperandExpression {
-    std::variant<ExpressionOperator, FunctionId, StructId> op;
-    std::vector<VariableOrExpressionId> args;
-
-    bool operator==(const ExpressionOperandExpression& o) const {
-        return op == o.op
-                && args == o.args;
-    }
-};
-
-struct VectorSwizzleExpression {
-    VariableOrExpressionId operand;
-    uint16_t swizzle;
-
-    bool operator==(const VectorSwizzleExpression& o) const {
-        return operand == o.operand
-                && swizzle == o.swizzle;
-    }
-};
-
-struct IndexStructExpression {
-    VariableOrExpressionId operand;
-    StructId strukt;
-    uint16_t index;
-
-    bool operator==(const IndexStructExpression& o) const {
-        return operand == o.operand
-                && strukt == o.strukt
-                && index == o.index;
-    }
-};
-
-struct LiteralExpression {
-    std::variant<
-        bool,
-        int,
-        double,
-        unsigned int> value;
-
-    bool operator==(const LiteralExpression& o) const {
-        return value == o.value;
-    }
-};
-
-using Expression = std::variant<
-    ExpressionOperandExpression,
-    VectorSwizzleExpression,
-    IndexStructExpression,
-    LiteralExpression>;
-
-struct Function {
-    FunctionId name;
-    TypeId returnType;
-    std::vector<LocalVariableId> parameters;
-    StatementBlockId body;
-    std::unordered_map<LocalVariableId, Variable> localVariables;
-
-    bool operator==(const Function& o) const {
-        return name == o.name
-                && returnType == o.returnType
-                && parameters == o.parameters
-                && body == o.body
-                && localVariables == o.localVariables;
-    }
-};
-
-struct IfStatement {
-    VariableOrExpressionId condition;
-    StatementBlockId thenBlock;
-    std::optional<StatementBlockId> elseBlock;
-
-    bool operator==(const IfStatement& o) const {
-        return condition == o.condition
-                && thenBlock == o.thenBlock
-                && elseBlock == o.elseBlock;
-    }
-};
-
-struct SwitchStatement {
-    VariableOrExpressionId condition;
-    StatementBlockId body;
-
-    bool operator==(const SwitchStatement& o) const {
-        return condition == o.condition
-                && body == o.body;
-    }
-};
-
-struct BranchStatement {
-    BranchOperator op;
-    std::optional<VariableOrExpressionId> operand;
-
-    bool operator==(const BranchStatement& o) const {
-        return op == o.op
-                && operand == o.operand;
-    }
-};
-
-struct LoopStatement {
-    VariableOrExpressionId condition;
-    std::optional<ExpressionId> terminal;
-    bool testFirst;
-    StatementBlockId body;
-
-    bool operator==(const LoopStatement& o) const {
-        return condition == o.condition
-                && terminal == o.terminal
-                && testFirst == o.testFirst
-                && body == o.body;
-    }
-};
-
-using Statement = std::variant<
-    ExpressionId,
-    IfStatement,
-    SwitchStatement,
-    BranchStatement,
-    LoopStatement>;
-
-template <typename T, typename... Rest>
-void hashCombine(std::size_t& seed, const T& v, const Rest&... rest) {
-    seed ^= std::hash<T>{}(v) + 0x9e3779b9 + (seed << 6) + (seed >> 2);
-    (hashCombine(seed, rest), ...);
-}
-
-} // namespace astrict
-
-namespace std {
-
-template<>
-struct hash<astrict::StructMember> {
-    std::size_t operator()(const astrict::StructMember& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.name, o.type);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::Struct> {
-    std::size_t operator()(const astrict::Struct& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.name, o.members.size());
-        for (const auto& member : o.members) {
-            astrict::hashCombine(result, member);
-        }
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::Type> {
-    std::size_t operator()(const astrict::Type& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.name, o.qualifiers, o.arraySizes.size());
-        for (const auto& size : o.arraySizes) {
-            astrict::hashCombine(result, size);
-        }
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::Variable> {
-    std::size_t operator()(const astrict::Variable& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.name, o.type);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::ExpressionOperandExpression> {
-    std::size_t operator()(const astrict::ExpressionOperandExpression& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.op, o.args.size());
-        for (const auto& arg : o.args) {
-            astrict::hashCombine(result, arg);
-        }
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::IndexStructExpression> {
-    std::size_t operator()(const astrict::IndexStructExpression& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.operand, o.strukt, o.index);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::VectorSwizzleExpression> {
-    std::size_t operator()(const astrict::VectorSwizzleExpression& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.operand, o.swizzle);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::LiteralExpression> {
-    std::size_t operator()(const astrict::LiteralExpression& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.value);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::Function> {
-    std::size_t operator()(const astrict::Function& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.name, o.returnType, o.body,
-                o.parameters.size(), o.localVariables.size());
-        for (const auto& argument : o.parameters) {
-            astrict::hashCombine(result, argument);
-        }
-        for (const auto& symbol : o.localVariables) {
-            astrict::hashCombine(result, symbol.first, symbol.second);
-        }
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::IfStatement> {
-    std::size_t operator()(const astrict::IfStatement& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.condition, o.thenBlock, o.elseBlock);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::SwitchStatement> {
-    std::size_t operator()(const astrict::SwitchStatement& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.condition, o.body);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::BranchStatement> {
-    std::size_t operator()(const astrict::BranchStatement& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.op, o.operand);
-        return result;
-    }
-};
-
-template<>
-struct hash<astrict::LoopStatement> {
-    std::size_t operator()(const astrict::LoopStatement& o) const {
-        std::size_t result = 0;
-        astrict::hashCombine(result, o.condition, o.terminal, o.testFirst, o.body);
-        return result;
-    }
-};
-
-template<>
-struct hash<std::vector<astrict::Statement>> {
-    std::size_t operator()(const std::vector<astrict::Statement>& o) const {
-        std::size_t result = o.size();
-        for (const auto& statement : o) {
-            astrict::hashCombine(result, statement);
-        }
-        return result;
-    }
-};
-
-}  // namespace std
-
-#endif  // TNT_ASTRICT_COMMONTYPES_H

libs/astrict/include/astrict/DebugCommon.h

@@ -1,28 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_DEBUGCOMMON_H
-#define TNT_ASTRICT_DEBUGCOMMON_H
-
-#include <astrict/CommonTypes.h>
-
-namespace astrict {
-
-const char* rValueOperatorToString(ExpressionOperator op);
-
-} // namespace astrict
-
-#endif  // TNT_ASTRICT_DEBUGCOMMON_H

libs/astrict/include/astrict/DebugGlsl.h

@@ -1,31 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_DEBUGGLSL_H
-#define TNT_ASTRICT_DEBUGGLSL_H
-
-#include "glslang/Include/intermediate.h"
-
-namespace astrict {
-
-const char* glslangOperatorToString(glslang::TOperator op);
-std::string glslangNodeToString(const TIntermNode* node);
-std::string glslangLocToString(const glslang::TSourceLoc& loc);
-std::string glslangNodeToStringWithLoc(const TIntermNode* node);
-
-} // namespace astrict
-
-#endif  // TNT_ASTRICT_DEBUGGLSL_H

libs/astrict/include/astrict/FromGlsl.h

@@ -1,30 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_FROMGLSL_H
-#define TNT_ASTRICT_FROMGLSL_H
-
-#include <astrict/GlslTypes.h>
-
-#include "glslang/Include/intermediate.h"
-
-namespace astrict {
-
-PackFromGlsl fromGlsl(const glslang::TIntermediate& intermediate);
-
-} // namespace astrict
-
-#endif  // TNT_ASTRICT_FROMGLSL_H

libs/astrict/include/astrict/GlslTypes.h

@@ -1,46 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_GLSLTYPES_H
-#define TNT_ASTRICT_GLSLTYPES_H
-
-#include <astrict/CommonTypes.h>
-#include <set>
-#include <unordered_map>
-#include <vector>
-
-namespace astrict {
-
-struct PackFromGlsl {
-    int version;
-    std::unordered_map<StringId, std::string> strings;
-    std::unordered_map<TypeId, Type> types;
-    std::unordered_map<StructId, Struct> structs;
-    std::unordered_map<GlobalVariableId, Variable> globalVariables;
-    std::unordered_map<ExpressionId, Expression> expressions;
-    std::unordered_map<FunctionId, std::string> functionNames;
-    std::unordered_map<StatementBlockId, std::vector<Statement>> statementBlocks;
-    std::unordered_map<FunctionId, Function> functions;
-    // The below serve as the roots for conversion to glsl.
-    std::vector<StructId> structsInOrder;
-    std::set<FunctionId> functionPrototypes;
-    std::vector<std::pair<GlobalVariableId, VariableOrExpressionId>> globalSymbolsInOrder;
-    std::vector<FunctionId> functionsInOrder;
-};
-
-};
-
-#endif  // TNT_ASTRICT_GLSLTYPES_H

libs/astrict/include/astrict/ToGlsl.h

@@ -1,29 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#ifndef TNT_ASTRICT_TOGLSL_H
-#define TNT_ASTRICT_TOGLSL_H
-
-#include <astrict/GlslTypes.h>
-#include <sstream>
-
-namespace astrict {
-
-void toGlsl(const PackFromGlsl& pack, std::ostringstream& out);
-
-};
-
-#endif  // TNT_ASTRICT_TOGLSL_H

libs/astrict/src/AstrictBuilder.cpp

@@ -1,36 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#include <astrict/AstrictBuilder.h>
-
-#include <astrict/CommonTypes.h>
-#include <astrict/DebugGlsl.h>
-#include <utils/Log.h>
-#include <utils/Panic.h>
-#include <optional>
-#include <set>
-
-#include "ConstantUnion.h"
-#include "Types.h"
-#include "glslang/MachineIndependent/localintermediate.h"
-#include "intermediate.h"
-#include "utils/ostream.h"
-
-namespace astrict {
-
-
-
-}  // namespace astrict

libs/astrict/src/DebugCommon.cpp

@@ -1,67 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#include <astrict/DebugCommon.h>
-
-namespace astrict {
-
-const char* rValueOperatorToString(ExpressionOperator op) {
-    switch(op) {
-        case ExpressionOperator::Negative: return "Negative";
-        case ExpressionOperator::LogicalNot: return "LogicalNot";
-        case ExpressionOperator::BitwiseNot: return "BitwiseNot";
-        case ExpressionOperator::PostIncrement: return "PostIncrement";
-        case ExpressionOperator::PostDecrement: return "PostDecrement";
-        case ExpressionOperator::PreIncrement: return "PreIncrement";
-        case ExpressionOperator::PreDecrement: return "PreDecrement";
-        case ExpressionOperator::ArrayLength: return "ArrayLength";
-        case ExpressionOperator::Add: return "Add";
-        case ExpressionOperator::Sub: return "Sub";
-        case ExpressionOperator::Mul: return "Mul";
-        case ExpressionOperator::Div: return "Div";
-        case ExpressionOperator::Mod: return "Mod";
-        case ExpressionOperator::RightShift: return "RightShift";
-        case ExpressionOperator::LeftShift: return "LeftShift";
-        case ExpressionOperator::And: return "And";
-        case ExpressionOperator::InclusiveOr: return "InclusiveOr";
-        case ExpressionOperator::ExclusiveOr: return "ExclusiveOr";
-        case ExpressionOperator::Equal: return "Equal";
-        case ExpressionOperator::NotEqual: return "NotEqual";
-        case ExpressionOperator::LessThan: return "LessThan";
-        case ExpressionOperator::GreaterThan: return "GreaterThan";
-        case ExpressionOperator::LessThanEqual: return "LessThanEqual";
-        case ExpressionOperator::GreaterThanEqual: return "GreaterThanEqual";
-        case ExpressionOperator::LogicalOr: return "LogicalOr";
-        case ExpressionOperator::LogicalXor: return "LogicalXor";
-        case ExpressionOperator::LogicalAnd: return "LogicalAnd";
-        case ExpressionOperator::Index: return "Index";
-        case ExpressionOperator::Assign: return "Assign";
-        case ExpressionOperator::AddAssign: return "AddAssign";
-        case ExpressionOperator::SubAssign: return "SubAssign";
-        case ExpressionOperator::MulAssign: return "MulAssign";
-        case ExpressionOperator::DivAssign: return "DivAssign";
-        case ExpressionOperator::ModAssign: return "ModAssign";
-        case ExpressionOperator::AndAssign: return "AndAssign";
-        case ExpressionOperator::InclusiveOrAssign: return "InclusiveOrAssign";
-        case ExpressionOperator::ExclusiveOrAssign: return "ExclusiveOrAssign";
-        case ExpressionOperator::LeftShiftAssign: return "LeftShiftAssign";
-        case ExpressionOperator::RightShiftAssign: return "RightShiftAssign";
-        case ExpressionOperator::Ternary: return "Ternary";
-        case ExpressionOperator::Comma: return "Comma";
-    }
-}
-
-} // namespace astrict

libs/astrict/src/DebugGlsl.cpp

@@ -1,925 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#include <astrict/DebugGlsl.h>
-
-namespace astrict {
-
-const char* glslangOperatorToString(glslang::TOperator op) {
-    using namespace glslang;
-    switch (op) {
-        case EOpNull: return "EOpNull";
-        case EOpSequence: return "EOpSequence";
-        case EOpScope: return "EOpScope";
-        case EOpLinkerObjects: return "EOpLinkerObjects";
-        case EOpFunctionCall: return "EOpFunctionCall";
-        case EOpFunction: return "EOpFunction";
-        case EOpParameters: return "EOpParameters";
-        case EOpSpirvInst: return "EOpSpirvInst";
-        case EOpNegative: return "EOpNegative";
-        case EOpLogicalNot: return "EOpLogicalNot";
-        case EOpVectorLogicalNot: return "EOpVectorLogicalNot";
-        case EOpBitwiseNot: return "EOpBitwiseNot";
-        case EOpPostIncrement: return "EOpPostIncrement";
-        case EOpPostDecrement: return "EOpPostDecrement";
-        case EOpPreIncrement: return "EOpPreIncrement";
-        case EOpPreDecrement: return "EOpPreDecrement";
-        case EOpCopyObject: return "EOpCopyObject";
-        case EOpDeclare: return "EOpDeclare";
-        case EOpConvInt8ToBool: return "EOpConvInt8ToBool";
-        case EOpConvUint8ToBool: return "EOpConvUint8ToBool";
-        case EOpConvInt16ToBool: return "EOpConvInt16ToBool";
-        case EOpConvUint16ToBool: return "EOpConvUint16ToBool";
-        case EOpConvIntToBool: return "EOpConvIntToBool";
-        case EOpConvUintToBool: return "EOpConvUintToBool";
-        case EOpConvInt64ToBool: return "EOpConvInt64ToBool";
-        case EOpConvUint64ToBool: return "EOpConvUint64ToBool";
-        case EOpConvFloat16ToBool: return "EOpConvFloat16ToBool";
-        case EOpConvFloatToBool: return "EOpConvFloatToBool";
-        case EOpConvDoubleToBool: return "EOpConvDoubleToBool";
-        case EOpConvBoolToInt8: return "EOpConvBoolToInt8";
-        case EOpConvBoolToUint8: return "EOpConvBoolToUint8";
-        case EOpConvBoolToInt16: return "EOpConvBoolToInt16";
-        case EOpConvBoolToUint16: return "EOpConvBoolToUint16";
-        case EOpConvBoolToInt: return "EOpConvBoolToInt";
-        case EOpConvBoolToUint: return "EOpConvBoolToUint";
-        case EOpConvBoolToInt64: return "EOpConvBoolToInt64";
-        case EOpConvBoolToUint64: return "EOpConvBoolToUint64";
-        case EOpConvBoolToFloat16: return "EOpConvBoolToFloat16";
-        case EOpConvBoolToFloat: return "EOpConvBoolToFloat";
-        case EOpConvBoolToDouble: return "EOpConvBoolToDouble";
-        case EOpConvInt8ToInt16: return "EOpConvInt8ToInt16";
-        case EOpConvInt8ToInt: return "EOpConvInt8ToInt";
-        case EOpConvInt8ToInt64: return "EOpConvInt8ToInt64";
-        case EOpConvInt8ToUint8: return "EOpConvInt8ToUint8";
-        case EOpConvInt8ToUint16: return "EOpConvInt8ToUint16";
-        case EOpConvInt8ToUint: return "EOpConvInt8ToUint";
-        case EOpConvInt8ToUint64: return "EOpConvInt8ToUint64";
-        case EOpConvUint8ToInt8: return "EOpConvUint8ToInt8";
-        case EOpConvUint8ToInt16: return "EOpConvUint8ToInt16";
-        case EOpConvUint8ToInt: return "EOpConvUint8ToInt";
-        case EOpConvUint8ToInt64: return "EOpConvUint8ToInt64";
-        case EOpConvUint8ToUint16: return "EOpConvUint8ToUint16";
-        case EOpConvUint8ToUint: return "EOpConvUint8ToUint";
-        case EOpConvUint8ToUint64: return "EOpConvUint8ToUint64";
-        case EOpConvInt8ToFloat16: return "EOpConvInt8ToFloat16";
-        case EOpConvInt8ToFloat: return "EOpConvInt8ToFloat";
-        case EOpConvInt8ToDouble: return "EOpConvInt8ToDouble";
-        case EOpConvUint8ToFloat16: return "EOpConvUint8ToFloat16";
-        case EOpConvUint8ToFloat: return "EOpConvUint8ToFloat";
-        case EOpConvUint8ToDouble: return "EOpConvUint8ToDouble";
-        case EOpConvInt16ToInt8: return "EOpConvInt16ToInt8";
-        case EOpConvInt16ToInt: return "EOpConvInt16ToInt";
-        case EOpConvInt16ToInt64: return "EOpConvInt16ToInt64";
-        case EOpConvInt16ToUint8: return "EOpConvInt16ToUint8";
-        case EOpConvInt16ToUint16: return "EOpConvInt16ToUint16";
-        case EOpConvInt16ToUint: return "EOpConvInt16ToUint";
-        case EOpConvInt16ToUint64: return "EOpConvInt16ToUint64";
-        case EOpConvUint16ToInt8: return "EOpConvUint16ToInt8";
-        case EOpConvUint16ToInt16: return "EOpConvUint16ToInt16";
-        case EOpConvUint16ToInt: return "EOpConvUint16ToInt";
-        case EOpConvUint16ToInt64: return "EOpConvUint16ToInt64";
-        case EOpConvUint16ToUint8: return "EOpConvUint16ToUint8";
-        case EOpConvUint16ToUint: return "EOpConvUint16ToUint";
-        case EOpConvUint16ToUint64: return "EOpConvUint16ToUint64";
-        case EOpConvInt16ToFloat16: return "EOpConvInt16ToFloat16";
-        case EOpConvInt16ToFloat: return "EOpConvInt16ToFloat";
-        case EOpConvInt16ToDouble: return "EOpConvInt16ToDouble";
-        case EOpConvUint16ToFloat16: return "EOpConvUint16ToFloat16";
-        case EOpConvUint16ToFloat: return "EOpConvUint16ToFloat";
-        case EOpConvUint16ToDouble: return "EOpConvUint16ToDouble";
-        case EOpConvIntToInt8: return "EOpConvIntToInt8";
-        case EOpConvIntToInt16: return "EOpConvIntToInt16";
-        case EOpConvIntToInt64: return "EOpConvIntToInt64";
-        case EOpConvIntToUint8: return "EOpConvIntToUint8";
-        case EOpConvIntToUint16: return "EOpConvIntToUint16";
-        case EOpConvIntToUint: return "EOpConvIntToUint";
-        case EOpConvIntToUint64: return "EOpConvIntToUint64";
-        case EOpConvUintToInt8: return "EOpConvUintToInt8";
-        case EOpConvUintToInt16: return "EOpConvUintToInt16";
-        case EOpConvUintToInt: return "EOpConvUintToInt";
-        case EOpConvUintToInt64: return "EOpConvUintToInt64";
-        case EOpConvUintToUint8: return "EOpConvUintToUint8";
-        case EOpConvUintToUint16: return "EOpConvUintToUint16";
-        case EOpConvUintToUint64: return "EOpConvUintToUint64";
-        case EOpConvIntToFloat16: return "EOpConvIntToFloat16";
-        case EOpConvIntToFloat: return "EOpConvIntToFloat";
-        case EOpConvIntToDouble: return "EOpConvIntToDouble";
-        case EOpConvUintToFloat16: return "EOpConvUintToFloat16";
-        case EOpConvUintToFloat: return "EOpConvUintToFloat";
-        case EOpConvUintToDouble: return "EOpConvUintToDouble";
-        case EOpConvInt64ToInt8: return "EOpConvInt64ToInt8";
-        case EOpConvInt64ToInt16: return "EOpConvInt64ToInt16";
-        case EOpConvInt64ToInt: return "EOpConvInt64ToInt";
-        case EOpConvInt64ToUint8: return "EOpConvInt64ToUint8";
-        case EOpConvInt64ToUint16: return "EOpConvInt64ToUint16";
-        case EOpConvInt64ToUint: return "EOpConvInt64ToUint";
-        case EOpConvInt64ToUint64: return "EOpConvInt64ToUint64";
-        case EOpConvUint64ToInt8: return "EOpConvUint64ToInt8";
-        case EOpConvUint64ToInt16: return "EOpConvUint64ToInt16";
-        case EOpConvUint64ToInt: return "EOpConvUint64ToInt";
-        case EOpConvUint64ToInt64: return "EOpConvUint64ToInt64";
-        case EOpConvUint64ToUint8: return "EOpConvUint64ToUint8";
-        case EOpConvUint64ToUint16: return "EOpConvUint64ToUint16";
-        case EOpConvUint64ToUint: return "EOpConvUint64ToUint";
-        case EOpConvInt64ToFloat16: return "EOpConvInt64ToFloat16";
-        case EOpConvInt64ToFloat: return "EOpConvInt64ToFloat";
-        case EOpConvInt64ToDouble: return "EOpConvInt64ToDouble";
-        case EOpConvUint64ToFloat16: return "EOpConvUint64ToFloat16";
-        case EOpConvUint64ToFloat: return "EOpConvUint64ToFloat";
-        case EOpConvUint64ToDouble: return "EOpConvUint64ToDouble";
-        case EOpConvFloat16ToInt8: return "EOpConvFloat16ToInt8";
-        case EOpConvFloat16ToInt16: return "EOpConvFloat16ToInt16";
-        case EOpConvFloat16ToInt: return "EOpConvFloat16ToInt";
-        case EOpConvFloat16ToInt64: return "EOpConvFloat16ToInt64";
-        case EOpConvFloat16ToUint8: return "EOpConvFloat16ToUint8";
-        case EOpConvFloat16ToUint16: return "EOpConvFloat16ToUint16";
-        case EOpConvFloat16ToUint: return "EOpConvFloat16ToUint";
-        case EOpConvFloat16ToUint64: return "EOpConvFloat16ToUint64";
-        case EOpConvFloat16ToFloat: return "EOpConvFloat16ToFloat";
-        case EOpConvFloat16ToDouble: return "EOpConvFloat16ToDouble";
-        case EOpConvFloatToInt8: return "EOpConvFloatToInt8";
-        case EOpConvFloatToInt16: return "EOpConvFloatToInt16";
-        case EOpConvFloatToInt: return "EOpConvFloatToInt";
-        case EOpConvFloatToInt64: return "EOpConvFloatToInt64";
-        case EOpConvFloatToUint8: return "EOpConvFloatToUint8";
-        case EOpConvFloatToUint16: return "EOpConvFloatToUint16";
-        case EOpConvFloatToUint: return "EOpConvFloatToUint";
-        case EOpConvFloatToUint64: return "EOpConvFloatToUint64";
-        case EOpConvFloatToFloat16: return "EOpConvFloatToFloat16";
-        case EOpConvFloatToDouble: return "EOpConvFloatToDouble";
-        case EOpConvDoubleToInt8: return "EOpConvDoubleToInt8";
-        case EOpConvDoubleToInt16: return "EOpConvDoubleToInt16";
-        case EOpConvDoubleToInt: return "EOpConvDoubleToInt";
-        case EOpConvDoubleToInt64: return "EOpConvDoubleToInt64";
-        case EOpConvDoubleToUint8: return "EOpConvDoubleToUint8";
-        case EOpConvDoubleToUint16: return "EOpConvDoubleToUint16";
-        case EOpConvDoubleToUint: return "EOpConvDoubleToUint";
-        case EOpConvDoubleToUint64: return "EOpConvDoubleToUint64";
-        case EOpConvDoubleToFloat16: return "EOpConvDoubleToFloat16";
-        case EOpConvDoubleToFloat: return "EOpConvDoubleToFloat";
-        case EOpConvUint64ToPtr: return "EOpConvUint64ToPtr";
-        case EOpConvPtrToUint64: return "EOpConvPtrToUint64";
-        case EOpConvUvec2ToPtr: return "EOpConvUvec2ToPtr";
-        case EOpConvPtrToUvec2: return "EOpConvPtrToUvec2";
-        case EOpConvUint64ToAccStruct: return "EOpConvUint64ToAccStruct";
-        case EOpConvUvec2ToAccStruct: return "EOpConvUvec2ToAccStruct";
-        case EOpAdd: return "EOpAdd";
-        case EOpSub: return "EOpSub";
-        case EOpMul: return "EOpMul";
-        case EOpDiv: return "EOpDiv";
-        case EOpMod: return "EOpMod";
-        case EOpRightShift: return "EOpRightShift";
-        case EOpLeftShift: return "EOpLeftShift";
-        case EOpAnd: return "EOpAnd";
-        case EOpInclusiveOr: return "EOpInclusiveOr";
-        case EOpExclusiveOr: return "EOpExclusiveOr";
-        case EOpEqual: return "EOpEqual";
-        case EOpNotEqual: return "EOpNotEqual";
-        case EOpVectorEqual: return "EOpVectorEqual";
-        case EOpVectorNotEqual: return "EOpVectorNotEqual";
-        case EOpLessThan: return "EOpLessThan";
-        case EOpGreaterThan: return "EOpGreaterThan";
-        case EOpLessThanEqual: return "EOpLessThanEqual";
-        case EOpGreaterThanEqual: return "EOpGreaterThanEqual";
-        case EOpComma: return "EOpComma";
-        case EOpVectorTimesScalar: return "EOpVectorTimesScalar";
-        case EOpVectorTimesMatrix: return "EOpVectorTimesMatrix";
-        case EOpMatrixTimesVector: return "EOpMatrixTimesVector";
-        case EOpMatrixTimesScalar: return "EOpMatrixTimesScalar";
-        case EOpLogicalOr: return "EOpLogicalOr";
-        case EOpLogicalXor: return "EOpLogicalXor";
-        case EOpLogicalAnd: return "EOpLogicalAnd";
-        case EOpIndexDirect: return "EOpIndexDirect";
-        case EOpIndexIndirect: return "EOpIndexIndirect";
-        case EOpIndexDirectStruct: return "EOpIndexDirectStruct";
-        case EOpVectorSwizzle: return "EOpVectorSwizzle";
-        case EOpMethod: return "EOpMethod";
-        case EOpScoping: return "EOpScoping";
-        case EOpRadians: return "EOpRadians";
-        case EOpDegrees: return "EOpDegrees";
-        case EOpSin: return "EOpSin";
-        case EOpCos: return "EOpCos";
-        case EOpTan: return "EOpTan";
-        case EOpAsin: return "EOpAsin";
-        case EOpAcos: return "EOpAcos";
-        case EOpAtan: return "EOpAtan";
-        case EOpSinh: return "EOpSinh";
-        case EOpCosh: return "EOpCosh";
-        case EOpTanh: return "EOpTanh";
-        case EOpAsinh: return "EOpAsinh";
-        case EOpAcosh: return "EOpAcosh";
-        case EOpAtanh: return "EOpAtanh";
-        case EOpPow: return "EOpPow";
-        case EOpExp: return "EOpExp";
-        case EOpLog: return "EOpLog";
-        case EOpExp2: return "EOpExp2";
-        case EOpLog2: return "EOpLog2";
-        case EOpSqrt: return "EOpSqrt";
-        case EOpInverseSqrt: return "EOpInverseSqrt";
-        case EOpAbs: return "EOpAbs";
-        case EOpSign: return "EOpSign";
-        case EOpFloor: return "EOpFloor";
-        case EOpTrunc: return "EOpTrunc";
-        case EOpRound: return "EOpRound";
-        case EOpRoundEven: return "EOpRoundEven";
-        case EOpCeil: return "EOpCeil";
-        case EOpFract: return "EOpFract";
-        case EOpModf: return "EOpModf";
-        case EOpMin: return "EOpMin";
-        case EOpMax: return "EOpMax";
-        case EOpClamp: return "EOpClamp";
-        case EOpMix: return "EOpMix";
-        case EOpStep: return "EOpStep";
-        case EOpSmoothStep: return "EOpSmoothStep";
-        case EOpIsNan: return "EOpIsNan";
-        case EOpIsInf: return "EOpIsInf";
-        case EOpFma: return "EOpFma";
-        case EOpFrexp: return "EOpFrexp";
-        case EOpLdexp: return "EOpLdexp";
-        case EOpFloatBitsToInt: return "EOpFloatBitsToInt";
-        case EOpFloatBitsToUint: return "EOpFloatBitsToUint";
-        case EOpIntBitsToFloat: return "EOpIntBitsToFloat";
-        case EOpUintBitsToFloat: return "EOpUintBitsToFloat";
-        case EOpDoubleBitsToInt64: return "EOpDoubleBitsToInt64";
-        case EOpDoubleBitsToUint64: return "EOpDoubleBitsToUint64";
-        case EOpInt64BitsToDouble: return "EOpInt64BitsToDouble";
-        case EOpUint64BitsToDouble: return "EOpUint64BitsToDouble";
-        case EOpFloat16BitsToInt16: return "EOpFloat16BitsToInt16";
-        case EOpFloat16BitsToUint16: return "EOpFloat16BitsToUint16";
-        case EOpInt16BitsToFloat16: return "EOpInt16BitsToFloat16";
-        case EOpUint16BitsToFloat16: return "EOpUint16BitsToFloat16";
-        case EOpPackSnorm2x16: return "EOpPackSnorm2x16";
-        case EOpUnpackSnorm2x16: return "EOpUnpackSnorm2x16";
-        case EOpPackUnorm2x16: return "EOpPackUnorm2x16";
-        case EOpUnpackUnorm2x16: return "EOpUnpackUnorm2x16";
-        case EOpPackSnorm4x8: return "EOpPackSnorm4x8";
-        case EOpUnpackSnorm4x8: return "EOpUnpackSnorm4x8";
-        case EOpPackUnorm4x8: return "EOpPackUnorm4x8";
-        case EOpUnpackUnorm4x8: return "EOpUnpackUnorm4x8";
-        case EOpPackHalf2x16: return "EOpPackHalf2x16";
-        case EOpUnpackHalf2x16: return "EOpUnpackHalf2x16";
-        case EOpPackDouble2x32: return "EOpPackDouble2x32";
-        case EOpUnpackDouble2x32: return "EOpUnpackDouble2x32";
-        case EOpPackInt2x32: return "EOpPackInt2x32";
-        case EOpUnpackInt2x32: return "EOpUnpackInt2x32";
-        case EOpPackUint2x32: return "EOpPackUint2x32";
-        case EOpUnpackUint2x32: return "EOpUnpackUint2x32";
-        case EOpPackFloat2x16: return "EOpPackFloat2x16";
-        case EOpUnpackFloat2x16: return "EOpUnpackFloat2x16";
-        case EOpPackInt2x16: return "EOpPackInt2x16";
-        case EOpUnpackInt2x16: return "EOpUnpackInt2x16";
-        case EOpPackUint2x16: return "EOpPackUint2x16";
-        case EOpUnpackUint2x16: return "EOpUnpackUint2x16";
-        case EOpPackInt4x16: return "EOpPackInt4x16";
-        case EOpUnpackInt4x16: return "EOpUnpackInt4x16";
-        case EOpPackUint4x16: return "EOpPackUint4x16";
-        case EOpUnpackUint4x16: return "EOpUnpackUint4x16";
-        case EOpPack16: return "EOpPack16";
-        case EOpPack32: return "EOpPack32";
-        case EOpPack64: return "EOpPack64";
-        case EOpUnpack32: return "EOpUnpack32";
-        case EOpUnpack16: return "EOpUnpack16";
-        case EOpUnpack8: return "EOpUnpack8";
-        case EOpLength: return "EOpLength";
-        case EOpDistance: return "EOpDistance";
-        case EOpDot: return "EOpDot";
-        case EOpCross: return "EOpCross";
-        case EOpNormalize: return "EOpNormalize";
-        case EOpFaceForward: return "EOpFaceForward";
-        case EOpReflect: return "EOpReflect";
-        case EOpRefract: return "EOpRefract";
-        case EOpMin3: return "EOpMin3";
-        case EOpMax3: return "EOpMax3";
-        case EOpMid3: return "EOpMid3";
-        case EOpDPdx: return "EOpDPdx";
-        case EOpDPdy: return "EOpDPdy";
-        case EOpFwidth: return "EOpFwidth";
-        case EOpDPdxFine: return "EOpDPdxFine";
-        case EOpDPdyFine: return "EOpDPdyFine";
-        case EOpFwidthFine: return "EOpFwidthFine";
-        case EOpDPdxCoarse: return "EOpDPdxCoarse";
-        case EOpDPdyCoarse: return "EOpDPdyCoarse";
-        case EOpFwidthCoarse: return "EOpFwidthCoarse";
-        case EOpInterpolateAtCentroid: return "EOpInterpolateAtCentroid";
-        case EOpInterpolateAtSample: return "EOpInterpolateAtSample";
-        case EOpInterpolateAtOffset: return "EOpInterpolateAtOffset";
-        case EOpInterpolateAtVertex: return "EOpInterpolateAtVertex";
-        case EOpMatrixTimesMatrix: return "EOpMatrixTimesMatrix";
-        case EOpOuterProduct: return "EOpOuterProduct";
-        case EOpDeterminant: return "EOpDeterminant";
-        case EOpMatrixInverse: return "EOpMatrixInverse";
-        case EOpTranspose: return "EOpTranspose";
-        case EOpFtransform: return "EOpFtransform";
-        case EOpNoise: return "EOpNoise";
-        case EOpEmitVertex: return "EOpEmitVertex";
-        case EOpEndPrimitive: return "EOpEndPrimitive";
-        case EOpEmitStreamVertex: return "EOpEmitStreamVertex";
-        case EOpEndStreamPrimitive: return "EOpEndStreamPrimitive";
-        case EOpBarrier: return "EOpBarrier";
-        case EOpMemoryBarrier: return "EOpMemoryBarrier";
-        case EOpMemoryBarrierAtomicCounter: return "EOpMemoryBarrierAtomicCounter";
-        case EOpMemoryBarrierBuffer: return "EOpMemoryBarrierBuffer";
-        case EOpMemoryBarrierImage: return "EOpMemoryBarrierImage";
-        case EOpMemoryBarrierShared: return "EOpMemoryBarrierShared";
-        case EOpGroupMemoryBarrier: return "EOpGroupMemoryBarrier";
-        case EOpBallot: return "EOpBallot";
-        case EOpReadInvocation: return "EOpReadInvocation";
-        case EOpReadFirstInvocation: return "EOpReadFirstInvocation";
-        case EOpAnyInvocation: return "EOpAnyInvocation";
-        case EOpAllInvocations: return "EOpAllInvocations";
-        case EOpAllInvocationsEqual: return "EOpAllInvocationsEqual";
-        case EOpSubgroupGuardStart: return "EOpSubgroupGuardStart";
-        case EOpSubgroupBarrier: return "EOpSubgroupBarrier";
-        case EOpSubgroupMemoryBarrier: return "EOpSubgroupMemoryBarrier";
-        case EOpSubgroupMemoryBarrierBuffer: return "EOpSubgroupMemoryBarrierBuffer";
-        case EOpSubgroupMemoryBarrierImage: return "EOpSubgroupMemoryBarrierImage";
-        case EOpSubgroupMemoryBarrierShared: return "EOpSubgroupMemoryBarrierShared";
-        case EOpSubgroupElect: return "EOpSubgroupElect";
-        case EOpSubgroupAll: return "EOpSubgroupAll";
-        case EOpSubgroupAny: return "EOpSubgroupAny";
-        case EOpSubgroupAllEqual: return "EOpSubgroupAllEqual";
-        case EOpSubgroupBroadcast: return "EOpSubgroupBroadcast";
-        case EOpSubgroupBroadcastFirst: return "EOpSubgroupBroadcastFirst";
-        case EOpSubgroupBallot: return "EOpSubgroupBallot";
-        case EOpSubgroupInverseBallot: return "EOpSubgroupInverseBallot";
-        case EOpSubgroupBallotBitExtract: return "EOpSubgroupBallotBitExtract";
-        case EOpSubgroupBallotBitCount: return "EOpSubgroupBallotBitCount";
-        case EOpSubgroupBallotInclusiveBitCount: return "EOpSubgroupBallotInclusiveBitCount";
-        case EOpSubgroupBallotExclusiveBitCount: return "EOpSubgroupBallotExclusiveBitCount";
-        case EOpSubgroupBallotFindLSB: return "EOpSubgroupBallotFindLSB";
-        case EOpSubgroupBallotFindMSB: return "EOpSubgroupBallotFindMSB";
-        case EOpSubgroupShuffle: return "EOpSubgroupShuffle";
-        case EOpSubgroupShuffleXor: return "EOpSubgroupShuffleXor";
-        case EOpSubgroupShuffleUp: return "EOpSubgroupShuffleUp";
-        case EOpSubgroupShuffleDown: return "EOpSubgroupShuffleDown";
-        case EOpSubgroupAdd: return "EOpSubgroupAdd";
-        case EOpSubgroupMul: return "EOpSubgroupMul";
-        case EOpSubgroupMin: return "EOpSubgroupMin";
-        case EOpSubgroupMax: return "EOpSubgroupMax";
-        case EOpSubgroupAnd: return "EOpSubgroupAnd";
-        case EOpSubgroupOr: return "EOpSubgroupOr";
-        case EOpSubgroupXor: return "EOpSubgroupXor";
-        case EOpSubgroupInclusiveAdd: return "EOpSubgroupInclusiveAdd";
-        case EOpSubgroupInclusiveMul: return "EOpSubgroupInclusiveMul";
-        case EOpSubgroupInclusiveMin: return "EOpSubgroupInclusiveMin";
-        case EOpSubgroupInclusiveMax: return "EOpSubgroupInclusiveMax";
-        case EOpSubgroupInclusiveAnd: return "EOpSubgroupInclusiveAnd";
-        case EOpSubgroupInclusiveOr: return "EOpSubgroupInclusiveOr";
-        case EOpSubgroupInclusiveXor: return "EOpSubgroupInclusiveXor";
-        case EOpSubgroupExclusiveAdd: return "EOpSubgroupExclusiveAdd";
-        case EOpSubgroupExclusiveMul: return "EOpSubgroupExclusiveMul";
-        case EOpSubgroupExclusiveMin: return "EOpSubgroupExclusiveMin";
-        case EOpSubgroupExclusiveMax: return "EOpSubgroupExclusiveMax";
-        case EOpSubgroupExclusiveAnd: return "EOpSubgroupExclusiveAnd";
-        case EOpSubgroupExclusiveOr: return "EOpSubgroupExclusiveOr";
-        case EOpSubgroupExclusiveXor: return "EOpSubgroupExclusiveXor";
-        case EOpSubgroupClusteredAdd: return "EOpSubgroupClusteredAdd";
-        case EOpSubgroupClusteredMul: return "EOpSubgroupClusteredMul";
-        case EOpSubgroupClusteredMin: return "EOpSubgroupClusteredMin";
-        case EOpSubgroupClusteredMax: return "EOpSubgroupClusteredMax";
-        case EOpSubgroupClusteredAnd: return "EOpSubgroupClusteredAnd";
-        case EOpSubgroupClusteredOr: return "EOpSubgroupClusteredOr";
-        case EOpSubgroupClusteredXor: return "EOpSubgroupClusteredXor";
-        case EOpSubgroupQuadBroadcast: return "EOpSubgroupQuadBroadcast";
-        case EOpSubgroupQuadSwapHorizontal: return "EOpSubgroupQuadSwapHorizontal";
-        case EOpSubgroupQuadSwapVertical: return "EOpSubgroupQuadSwapVertical";
-        case EOpSubgroupQuadSwapDiagonal: return "EOpSubgroupQuadSwapDiagonal";
-        case EOpSubgroupPartition: return "EOpSubgroupPartition";
-        case EOpSubgroupPartitionedAdd: return "EOpSubgroupPartitionedAdd";
-        case EOpSubgroupPartitionedMul: return "EOpSubgroupPartitionedMul";
-        case EOpSubgroupPartitionedMin: return "EOpSubgroupPartitionedMin";
-        case EOpSubgroupPartitionedMax: return "EOpSubgroupPartitionedMax";
-        case EOpSubgroupPartitionedAnd: return "EOpSubgroupPartitionedAnd";
-        case EOpSubgroupPartitionedOr: return "EOpSubgroupPartitionedOr";
-        case EOpSubgroupPartitionedXor: return "EOpSubgroupPartitionedXor";
-        case EOpSubgroupPartitionedInclusiveAdd: return "EOpSubgroupPartitionedInclusiveAdd";
-        case EOpSubgroupPartitionedInclusiveMul: return "EOpSubgroupPartitionedInclusiveMul";
-        case EOpSubgroupPartitionedInclusiveMin: return "EOpSubgroupPartitionedInclusiveMin";
-        case EOpSubgroupPartitionedInclusiveMax: return "EOpSubgroupPartitionedInclusiveMax";
-        case EOpSubgroupPartitionedInclusiveAnd: return "EOpSubgroupPartitionedInclusiveAnd";
-        case EOpSubgroupPartitionedInclusiveOr: return "EOpSubgroupPartitionedInclusiveOr";
-        case EOpSubgroupPartitionedInclusiveXor: return "EOpSubgroupPartitionedInclusiveXor";
-        case EOpSubgroupPartitionedExclusiveAdd: return "EOpSubgroupPartitionedExclusiveAdd";
-        case EOpSubgroupPartitionedExclusiveMul: return "EOpSubgroupPartitionedExclusiveMul";
-        case EOpSubgroupPartitionedExclusiveMin: return "EOpSubgroupPartitionedExclusiveMin";
-        case EOpSubgroupPartitionedExclusiveMax: return "EOpSubgroupPartitionedExclusiveMax";
-        case EOpSubgroupPartitionedExclusiveAnd: return "EOpSubgroupPartitionedExclusiveAnd";
-        case EOpSubgroupPartitionedExclusiveOr: return "EOpSubgroupPartitionedExclusiveOr";
-        case EOpSubgroupPartitionedExclusiveXor: return "EOpSubgroupPartitionedExclusiveXor";
-        case EOpSubgroupGuardStop: return "EOpSubgroupGuardStop";
-        case EOpMinInvocations: return "EOpMinInvocations";
-        case EOpMaxInvocations: return "EOpMaxInvocations";
-        case EOpAddInvocations: return "EOpAddInvocations";
-        case EOpMinInvocationsNonUniform: return "EOpMinInvocationsNonUniform";
-        case EOpMaxInvocationsNonUniform: return "EOpMaxInvocationsNonUniform";
-        case EOpAddInvocationsNonUniform: return "EOpAddInvocationsNonUniform";
-        case EOpMinInvocationsInclusiveScan: return "EOpMinInvocationsInclusiveScan";
-        case EOpMaxInvocationsInclusiveScan: return "EOpMaxInvocationsInclusiveScan";
-        case EOpAddInvocationsInclusiveScan: return "EOpAddInvocationsInclusiveScan";
-        case EOpMinInvocationsInclusiveScanNonUniform: return "EOpMinInvocationsInclusiveScanNonUniform";
-        case EOpMaxInvocationsInclusiveScanNonUniform: return "EOpMaxInvocationsInclusiveScanNonUniform";
-        case EOpAddInvocationsInclusiveScanNonUniform: return "EOpAddInvocationsInclusiveScanNonUniform";
-        case EOpMinInvocationsExclusiveScan: return "EOpMinInvocationsExclusiveScan";
-        case EOpMaxInvocationsExclusiveScan: return "EOpMaxInvocationsExclusiveScan";
-        case EOpAddInvocationsExclusiveScan: return "EOpAddInvocationsExclusiveScan";
-        case EOpMinInvocationsExclusiveScanNonUniform: return "EOpMinInvocationsExclusiveScanNonUniform";
-        case EOpMaxInvocationsExclusiveScanNonUniform: return "EOpMaxInvocationsExclusiveScanNonUniform";
-        case EOpAddInvocationsExclusiveScanNonUniform: return "EOpAddInvocationsExclusiveScanNonUniform";
-        case EOpSwizzleInvocations: return "EOpSwizzleInvocations";
-        case EOpSwizzleInvocationsMasked: return "EOpSwizzleInvocationsMasked";
-        case EOpWriteInvocation: return "EOpWriteInvocation";
-        case EOpMbcnt: return "EOpMbcnt";
-        case EOpCubeFaceIndex: return "EOpCubeFaceIndex";
-        case EOpCubeFaceCoord: return "EOpCubeFaceCoord";
-        case EOpTime: return "EOpTime";
-        case EOpAtomicAdd: return "EOpAtomicAdd";
-        case EOpAtomicSubtract: return "EOpAtomicSubtract";
-        case EOpAtomicMin: return "EOpAtomicMin";
-        case EOpAtomicMax: return "EOpAtomicMax";
-        case EOpAtomicAnd: return "EOpAtomicAnd";
-        case EOpAtomicOr: return "EOpAtomicOr";
-        case EOpAtomicXor: return "EOpAtomicXor";
-        case EOpAtomicExchange: return "EOpAtomicExchange";
-        case EOpAtomicCompSwap: return "EOpAtomicCompSwap";
-        case EOpAtomicLoad: return "EOpAtomicLoad";
-        case EOpAtomicStore: return "EOpAtomicStore";
-        case EOpAtomicCounterIncrement: return "EOpAtomicCounterIncrement";
-        case EOpAtomicCounterDecrement: return "EOpAtomicCounterDecrement";
-        case EOpAtomicCounter: return "EOpAtomicCounter";
-        case EOpAtomicCounterAdd: return "EOpAtomicCounterAdd";
-        case EOpAtomicCounterSubtract: return "EOpAtomicCounterSubtract";
-        case EOpAtomicCounterMin: return "EOpAtomicCounterMin";
-        case EOpAtomicCounterMax: return "EOpAtomicCounterMax";
-        case EOpAtomicCounterAnd: return "EOpAtomicCounterAnd";
-        case EOpAtomicCounterOr: return "EOpAtomicCounterOr";
-        case EOpAtomicCounterXor: return "EOpAtomicCounterXor";
-        case EOpAtomicCounterExchange: return "EOpAtomicCounterExchange";
-        case EOpAtomicCounterCompSwap: return "EOpAtomicCounterCompSwap";
-        case EOpAny: return "EOpAny";
-        case EOpAll: return "EOpAll";
-        case EOpCooperativeMatrixLoad: return "EOpCooperativeMatrixLoad";
-        case EOpCooperativeMatrixStore: return "EOpCooperativeMatrixStore";
-        case EOpCooperativeMatrixMulAdd: return "EOpCooperativeMatrixMulAdd";
-        case EOpCooperativeMatrixLoadNV: return "EOpCooperativeMatrixLoadNV";
-        case EOpCooperativeMatrixStoreNV: return "EOpCooperativeMatrixStoreNV";
-        case EOpCooperativeMatrixMulAddNV: return "EOpCooperativeMatrixMulAddNV";
-        case EOpBeginInvocationInterlock: return "EOpBeginInvocationInterlock";
-        case EOpEndInvocationInterlock: return "EOpEndInvocationInterlock";
-        case EOpIsHelperInvocation: return "EOpIsHelperInvocation";
-        case EOpDebugPrintf: return "EOpDebugPrintf";
-        case EOpKill: return "EOpKill";
-        case EOpTerminateInvocation: return "EOpTerminateInvocation";
-        case EOpDemote: return "EOpDemote";
-        case EOpTerminateRayKHR: return "EOpTerminateRayKHR";
-        case EOpIgnoreIntersectionKHR: return "EOpIgnoreIntersectionKHR";
-        case EOpReturn: return "EOpReturn";
-        case EOpBreak: return "EOpBreak";
-        case EOpContinue: return "EOpContinue";
-        case EOpCase: return "EOpCase";
-        case EOpDefault: return "EOpDefault";
-        case EOpConstructGuardStart: return "EOpConstructGuardStart";
-        case EOpConstructInt: return "EOpConstructInt";
-        case EOpConstructUint: return "EOpConstructUint";
-        case EOpConstructInt8: return "EOpConstructInt8";
-        case EOpConstructUint8: return "EOpConstructUint8";
-        case EOpConstructInt16: return "EOpConstructInt16";
-        case EOpConstructUint16: return "EOpConstructUint16";
-        case EOpConstructInt64: return "EOpConstructInt64";
-        case EOpConstructUint64: return "EOpConstructUint64";
-        case EOpConstructBool: return "EOpConstructBool";
-        case EOpConstructFloat: return "EOpConstructFloat";
-        case EOpConstructDouble: return "EOpConstructDouble";
-        case EOpConstructVec2: return "EOpConstructVec2";
-        case EOpConstructVec3: return "EOpConstructVec3";
-        case EOpConstructVec4: return "EOpConstructVec4";
-        case EOpConstructMat2x2: return "EOpConstructMat2x2";
-        case EOpConstructMat2x3: return "EOpConstructMat2x3";
-        case EOpConstructMat2x4: return "EOpConstructMat2x4";
-        case EOpConstructMat3x2: return "EOpConstructMat3x2";
-        case EOpConstructMat3x3: return "EOpConstructMat3x3";
-        case EOpConstructMat3x4: return "EOpConstructMat3x4";
-        case EOpConstructMat4x2: return "EOpConstructMat4x2";
-        case EOpConstructMat4x3: return "EOpConstructMat4x3";
-        case EOpConstructMat4x4: return "EOpConstructMat4x4";
-        case EOpConstructDVec2: return "EOpConstructDVec2";
-        case EOpConstructDVec3: return "EOpConstructDVec3";
-        case EOpConstructDVec4: return "EOpConstructDVec4";
-        case EOpConstructBVec2: return "EOpConstructBVec2";
-        case EOpConstructBVec3: return "EOpConstructBVec3";
-        case EOpConstructBVec4: return "EOpConstructBVec4";
-        case EOpConstructI8Vec2: return "EOpConstructI8Vec2";
-        case EOpConstructI8Vec3: return "EOpConstructI8Vec3";
-        case EOpConstructI8Vec4: return "EOpConstructI8Vec4";
-        case EOpConstructU8Vec2: return "EOpConstructU8Vec2";
-        case EOpConstructU8Vec3: return "EOpConstructU8Vec3";
-        case EOpConstructU8Vec4: return "EOpConstructU8Vec4";
-        case EOpConstructI16Vec2: return "EOpConstructI16Vec2";
-        case EOpConstructI16Vec3: return "EOpConstructI16Vec3";
-        case EOpConstructI16Vec4: return "EOpConstructI16Vec4";
-        case EOpConstructU16Vec2: return "EOpConstructU16Vec2";
-        case EOpConstructU16Vec3: return "EOpConstructU16Vec3";
-        case EOpConstructU16Vec4: return "EOpConstructU16Vec4";
-        case EOpConstructIVec2: return "EOpConstructIVec2";
-        case EOpConstructIVec3: return "EOpConstructIVec3";
-        case EOpConstructIVec4: return "EOpConstructIVec4";
-        case EOpConstructUVec2: return "EOpConstructUVec2";
-        case EOpConstructUVec3: return "EOpConstructUVec3";
-        case EOpConstructUVec4: return "EOpConstructUVec4";
-        case EOpConstructI64Vec2: return "EOpConstructI64Vec2";
-        case EOpConstructI64Vec3: return "EOpConstructI64Vec3";
-        case EOpConstructI64Vec4: return "EOpConstructI64Vec4";
-        case EOpConstructU64Vec2: return "EOpConstructU64Vec2";
-        case EOpConstructU64Vec3: return "EOpConstructU64Vec3";
-        case EOpConstructU64Vec4: return "EOpConstructU64Vec4";
-        case EOpConstructDMat2x2: return "EOpConstructDMat2x2";
-        case EOpConstructDMat2x3: return "EOpConstructDMat2x3";
-        case EOpConstructDMat2x4: return "EOpConstructDMat2x4";
-        case EOpConstructDMat3x2: return "EOpConstructDMat3x2";
-        case EOpConstructDMat3x3: return "EOpConstructDMat3x3";
-        case EOpConstructDMat3x4: return "EOpConstructDMat3x4";
-        case EOpConstructDMat4x2: return "EOpConstructDMat4x2";
-        case EOpConstructDMat4x3: return "EOpConstructDMat4x3";
-        case EOpConstructDMat4x4: return "EOpConstructDMat4x4";
-        case EOpConstructIMat2x2: return "EOpConstructIMat2x2";
-        case EOpConstructIMat2x3: return "EOpConstructIMat2x3";
-        case EOpConstructIMat2x4: return "EOpConstructIMat2x4";
-        case EOpConstructIMat3x2: return "EOpConstructIMat3x2";
-        case EOpConstructIMat3x3: return "EOpConstructIMat3x3";
-        case EOpConstructIMat3x4: return "EOpConstructIMat3x4";
-        case EOpConstructIMat4x2: return "EOpConstructIMat4x2";
-        case EOpConstructIMat4x3: return "EOpConstructIMat4x3";
-        case EOpConstructIMat4x4: return "EOpConstructIMat4x4";
-        case EOpConstructUMat2x2: return "EOpConstructUMat2x2";
-        case EOpConstructUMat2x3: return "EOpConstructUMat2x3";
-        case EOpConstructUMat2x4: return "EOpConstructUMat2x4";
-        case EOpConstructUMat3x2: return "EOpConstructUMat3x2";
-        case EOpConstructUMat3x3: return "EOpConstructUMat3x3";
-        case EOpConstructUMat3x4: return "EOpConstructUMat3x4";
-        case EOpConstructUMat4x2: return "EOpConstructUMat4x2";
-        case EOpConstructUMat4x3: return "EOpConstructUMat4x3";
-        case EOpConstructUMat4x4: return "EOpConstructUMat4x4";
-        case EOpConstructBMat2x2: return "EOpConstructBMat2x2";
-        case EOpConstructBMat2x3: return "EOpConstructBMat2x3";
-        case EOpConstructBMat2x4: return "EOpConstructBMat2x4";
-        case EOpConstructBMat3x2: return "EOpConstructBMat3x2";
-        case EOpConstructBMat3x3: return "EOpConstructBMat3x3";
-        case EOpConstructBMat3x4: return "EOpConstructBMat3x4";
-        case EOpConstructBMat4x2: return "EOpConstructBMat4x2";
-        case EOpConstructBMat4x3: return "EOpConstructBMat4x3";
-        case EOpConstructBMat4x4: return "EOpConstructBMat4x4";
-        case EOpConstructFloat16: return "EOpConstructFloat16";
-        case EOpConstructF16Vec2: return "EOpConstructF16Vec2";
-        case EOpConstructF16Vec3: return "EOpConstructF16Vec3";
-        case EOpConstructF16Vec4: return "EOpConstructF16Vec4";
-        case EOpConstructF16Mat2x2: return "EOpConstructF16Mat2x2";
-        case EOpConstructF16Mat2x3: return "EOpConstructF16Mat2x3";
-        case EOpConstructF16Mat2x4: return "EOpConstructF16Mat2x4";
-        case EOpConstructF16Mat3x2: return "EOpConstructF16Mat3x2";
-        case EOpConstructF16Mat3x3: return "EOpConstructF16Mat3x3";
-        case EOpConstructF16Mat3x4: return "EOpConstructF16Mat3x4";
-        case EOpConstructF16Mat4x2: return "EOpConstructF16Mat4x2";
-        case EOpConstructF16Mat4x3: return "EOpConstructF16Mat4x3";
-        case EOpConstructF16Mat4x4: return "EOpConstructF16Mat4x4";
-        case EOpConstructStruct: return "EOpConstructStruct";
-        case EOpConstructTextureSampler: return "EOpConstructTextureSampler";
-        case EOpConstructNonuniform: return "EOpConstructNonuniform";
-        case EOpConstructReference: return "EOpConstructReference";
-        case EOpConstructCooperativeMatrixNV: return "EOpConstructCooperativeMatrixNV";
-        case EOpConstructCooperativeMatrixKHR: return "EOpConstructCooperativeMatrixKHR";
-        case EOpConstructAccStruct: return "EOpConstructAccStruct";
-        case EOpConstructGuardEnd: return "EOpConstructGuardEnd";
-        case EOpAssign: return "EOpAssign";
-        case EOpAddAssign: return "EOpAddAssign";
-        case EOpSubAssign: return "EOpSubAssign";
-        case EOpMulAssign: return "EOpMulAssign";
-        case EOpVectorTimesMatrixAssign: return "EOpVectorTimesMatrixAssign";
-        case EOpVectorTimesScalarAssign: return "EOpVectorTimesScalarAssign";
-        case EOpMatrixTimesScalarAssign: return "EOpMatrixTimesScalarAssign";
-        case EOpMatrixTimesMatrixAssign: return "EOpMatrixTimesMatrixAssign";
-        case EOpDivAssign: return "EOpDivAssign";
-        case EOpModAssign: return "EOpModAssign";
-        case EOpAndAssign: return "EOpAndAssign";
-        case EOpInclusiveOrAssign: return "EOpInclusiveOrAssign";
-        case EOpExclusiveOrAssign: return "EOpExclusiveOrAssign";
-        case EOpLeftShiftAssign: return "EOpLeftShiftAssign";
-        case EOpRightShiftAssign: return "EOpRightShiftAssign";
-        case EOpArrayLength: return "EOpArrayLength";
-        case EOpImageGuardBegin: return "EOpImageGuardBegin";
-        case EOpImageQuerySize: return "EOpImageQuerySize";
-        case EOpImageQuerySamples: return "EOpImageQuerySamples";
-        case EOpImageLoad: return "EOpImageLoad";
-        case EOpImageStore: return "EOpImageStore";
-        case EOpImageLoadLod: return "EOpImageLoadLod";
-        case EOpImageStoreLod: return "EOpImageStoreLod";
-        case EOpImageAtomicAdd: return "EOpImageAtomicAdd";
-        case EOpImageAtomicMin: return "EOpImageAtomicMin";
-        case EOpImageAtomicMax: return "EOpImageAtomicMax";
-        case EOpImageAtomicAnd: return "EOpImageAtomicAnd";
-        case EOpImageAtomicOr: return "EOpImageAtomicOr";
-        case EOpImageAtomicXor: return "EOpImageAtomicXor";
-        case EOpImageAtomicExchange: return "EOpImageAtomicExchange";
-        case EOpImageAtomicCompSwap: return "EOpImageAtomicCompSwap";
-        case EOpImageAtomicLoad: return "EOpImageAtomicLoad";
-        case EOpImageAtomicStore: return "EOpImageAtomicStore";
-        case EOpSubpassLoad: return "EOpSubpassLoad";
-        case EOpSubpassLoadMS: return "EOpSubpassLoadMS";
-        case EOpSparseImageLoad: return "EOpSparseImageLoad";
-        case EOpSparseImageLoadLod: return "EOpSparseImageLoadLod";
-        case EOpColorAttachmentReadEXT: return "EOpColorAttachmentReadEXT";
-        case EOpImageGuardEnd: return "EOpImageGuardEnd";
-        case EOpTextureGuardBegin: return "EOpTextureGuardBegin";
-        case EOpTextureQuerySize: return "EOpTextureQuerySize";
-        case EOpTextureQueryLod: return "EOpTextureQueryLod";
-        case EOpTextureQueryLevels: return "EOpTextureQueryLevels";
-        case EOpTextureQuerySamples: return "EOpTextureQuerySamples";
-        case EOpSamplingGuardBegin: return "EOpSamplingGuardBegin";
-        case EOpTexture: return "EOpTexture";
-        case EOpTextureProj: return "EOpTextureProj";
-        case EOpTextureLod: return "EOpTextureLod";
-        case EOpTextureOffset: return "EOpTextureOffset";
-        case EOpTextureFetch: return "EOpTextureFetch";
-        case EOpTextureFetchOffset: return "EOpTextureFetchOffset";
-        case EOpTextureProjOffset: return "EOpTextureProjOffset";
-        case EOpTextureLodOffset: return "EOpTextureLodOffset";
-        case EOpTextureProjLod: return "EOpTextureProjLod";
-        case EOpTextureProjLodOffset: return "EOpTextureProjLodOffset";
-        case EOpTextureGrad: return "EOpTextureGrad";
-        case EOpTextureGradOffset: return "EOpTextureGradOffset";
-        case EOpTextureProjGrad: return "EOpTextureProjGrad";
-        case EOpTextureProjGradOffset: return "EOpTextureProjGradOffset";
-        case EOpTextureGather: return "EOpTextureGather";
-        case EOpTextureGatherOffset: return "EOpTextureGatherOffset";
-        case EOpTextureGatherOffsets: return "EOpTextureGatherOffsets";
-        case EOpTextureClamp: return "EOpTextureClamp";
-        case EOpTextureOffsetClamp: return "EOpTextureOffsetClamp";
-        case EOpTextureGradClamp: return "EOpTextureGradClamp";
-        case EOpTextureGradOffsetClamp: return "EOpTextureGradOffsetClamp";
-        case EOpTextureGatherLod: return "EOpTextureGatherLod";
-        case EOpTextureGatherLodOffset: return "EOpTextureGatherLodOffset";
-        case EOpTextureGatherLodOffsets: return "EOpTextureGatherLodOffsets";
-        case EOpFragmentMaskFetch: return "EOpFragmentMaskFetch";
-        case EOpFragmentFetch: return "EOpFragmentFetch";
-        case EOpSparseTextureGuardBegin: return "EOpSparseTextureGuardBegin";
-        case EOpSparseTexture: return "EOpSparseTexture";
-        case EOpSparseTextureLod: return "EOpSparseTextureLod";
-        case EOpSparseTextureOffset: return "EOpSparseTextureOffset";
-        case EOpSparseTextureFetch: return "EOpSparseTextureFetch";
-        case EOpSparseTextureFetchOffset: return "EOpSparseTextureFetchOffset";
-        case EOpSparseTextureLodOffset: return "EOpSparseTextureLodOffset";
-        case EOpSparseTextureGrad: return "EOpSparseTextureGrad";
-        case EOpSparseTextureGradOffset: return "EOpSparseTextureGradOffset";
-        case EOpSparseTextureGather: return "EOpSparseTextureGather";
-        case EOpSparseTextureGatherOffset: return "EOpSparseTextureGatherOffset";
-        case EOpSparseTextureGatherOffsets: return "EOpSparseTextureGatherOffsets";
-        case EOpSparseTexelsResident: return "EOpSparseTexelsResident";
-        case EOpSparseTextureClamp: return "EOpSparseTextureClamp";
-        case EOpSparseTextureOffsetClamp: return "EOpSparseTextureOffsetClamp";
-        case EOpSparseTextureGradClamp: return "EOpSparseTextureGradClamp";
-        case EOpSparseTextureGradOffsetClamp: return "EOpSparseTextureGradOffsetClamp";
-        case EOpSparseTextureGatherLod: return "EOpSparseTextureGatherLod";
-        case EOpSparseTextureGatherLodOffset: return "EOpSparseTextureGatherLodOffset";
-        case EOpSparseTextureGatherLodOffsets: return "EOpSparseTextureGatherLodOffsets";
-        case EOpSparseTextureGuardEnd: return "EOpSparseTextureGuardEnd";
-        case EOpImageFootprintGuardBegin: return "EOpImageFootprintGuardBegin";
-        case EOpImageSampleFootprintNV: return "EOpImageSampleFootprintNV";
-        case EOpImageSampleFootprintClampNV: return "EOpImageSampleFootprintClampNV";
-        case EOpImageSampleFootprintLodNV: return "EOpImageSampleFootprintLodNV";
-        case EOpImageSampleFootprintGradNV: return "EOpImageSampleFootprintGradNV";
-        case EOpImageSampleFootprintGradClampNV: return "EOpImageSampleFootprintGradClampNV";
-        case EOpImageFootprintGuardEnd: return "EOpImageFootprintGuardEnd";
-        case EOpSamplingGuardEnd: return "EOpSamplingGuardEnd";
-        case EOpTextureGuardEnd: return "EOpTextureGuardEnd";
-        case EOpAddCarry: return "EOpAddCarry";
-        case EOpSubBorrow: return "EOpSubBorrow";
-        case EOpUMulExtended: return "EOpUMulExtended";
-        case EOpIMulExtended: return "EOpIMulExtended";
-        case EOpBitfieldExtract: return "EOpBitfieldExtract";
-        case EOpBitfieldInsert: return "EOpBitfieldInsert";
-        case EOpBitFieldReverse: return "EOpBitFieldReverse";
-        case EOpBitCount: return "EOpBitCount";
-        case EOpFindLSB: return "EOpFindLSB";
-        case EOpFindMSB: return "EOpFindMSB";
-        case EOpCountLeadingZeros: return "EOpCountLeadingZeros";
-        case EOpCountTrailingZeros: return "EOpCountTrailingZeros";
-        case EOpAbsDifference: return "EOpAbsDifference";
-        case EOpAddSaturate: return "EOpAddSaturate";
-        case EOpSubSaturate: return "EOpSubSaturate";
-        case EOpAverage: return "EOpAverage";
-        case EOpAverageRounded: return "EOpAverageRounded";
-        case EOpMul32x16: return "EOpMul32x16";
-        case EOpTraceNV: return "EOpTraceNV";
-        case EOpTraceRayMotionNV: return "EOpTraceRayMotionNV";
-        case EOpTraceKHR: return "EOpTraceKHR";
-        case EOpReportIntersection: return "EOpReportIntersection";
-        case EOpIgnoreIntersectionNV: return "EOpIgnoreIntersectionNV";
-        case EOpTerminateRayNV: return "EOpTerminateRayNV";
-        case EOpExecuteCallableNV: return "EOpExecuteCallableNV";
-        case EOpExecuteCallableKHR: return "EOpExecuteCallableKHR";
-        case EOpWritePackedPrimitiveIndices4x8NV: return "EOpWritePackedPrimitiveIndices4x8NV";
-        case EOpEmitMeshTasksEXT: return "EOpEmitMeshTasksEXT";
-        case EOpSetMeshOutputsEXT: return "EOpSetMeshOutputsEXT";
-        case EOpRayQueryInitialize: return "EOpRayQueryInitialize";
-        case EOpRayQueryTerminate: return "EOpRayQueryTerminate";
-        case EOpRayQueryGenerateIntersection: return "EOpRayQueryGenerateIntersection";
-        case EOpRayQueryConfirmIntersection: return "EOpRayQueryConfirmIntersection";
-        case EOpRayQueryProceed: return "EOpRayQueryProceed";
-        case EOpRayQueryGetIntersectionType: return "EOpRayQueryGetIntersectionType";
-        case EOpRayQueryGetRayTMin: return "EOpRayQueryGetRayTMin";
-        case EOpRayQueryGetRayFlags: return "EOpRayQueryGetRayFlags";
-        case EOpRayQueryGetIntersectionT: return "EOpRayQueryGetIntersectionT";
-        case EOpRayQueryGetIntersectionInstanceCustomIndex: return "EOpRayQueryGetIntersectionInstanceCustomIndex";
-        case EOpRayQueryGetIntersectionInstanceId: return "EOpRayQueryGetIntersectionInstanceId";
-        case EOpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffset: return "EOpRayQueryGetIntersectionInstanceShaderBindingTableRecordOffset";
-        case EOpRayQueryGetIntersectionGeometryIndex: return "EOpRayQueryGetIntersectionGeometryIndex";
-        case EOpRayQueryGetIntersectionPrimitiveIndex: return "EOpRayQueryGetIntersectionPrimitiveIndex";
-        case EOpRayQueryGetIntersectionBarycentrics: return "EOpRayQueryGetIntersectionBarycentrics";
-        case EOpRayQueryGetIntersectionFrontFace: return "EOpRayQueryGetIntersectionFrontFace";
-        case EOpRayQueryGetIntersectionCandidateAABBOpaque: return "EOpRayQueryGetIntersectionCandidateAABBOpaque";
-        case EOpRayQueryGetIntersectionObjectRayDirection: return "EOpRayQueryGetIntersectionObjectRayDirection";
-        case EOpRayQueryGetIntersectionObjectRayOrigin: return "EOpRayQueryGetIntersectionObjectRayOrigin";
-        case EOpRayQueryGetWorldRayDirection: return "EOpRayQueryGetWorldRayDirection";
-        case EOpRayQueryGetWorldRayOrigin: return "EOpRayQueryGetWorldRayOrigin";
-        case EOpRayQueryGetIntersectionObjectToWorld: return "EOpRayQueryGetIntersectionObjectToWorld";
-        case EOpRayQueryGetIntersectionWorldToObject: return "EOpRayQueryGetIntersectionWorldToObject";
-        case EOpHitObjectTraceRayNV: return "EOpHitObjectTraceRayNV";
-        case EOpHitObjectTraceRayMotionNV: return "EOpHitObjectTraceRayMotionNV";
-        case EOpHitObjectRecordHitNV: return "EOpHitObjectRecordHitNV";
-        case EOpHitObjectRecordHitMotionNV: return "EOpHitObjectRecordHitMotionNV";
-        case EOpHitObjectRecordHitWithIndexNV: return "EOpHitObjectRecordHitWithIndexNV";
-        case EOpHitObjectRecordHitWithIndexMotionNV: return "EOpHitObjectRecordHitWithIndexMotionNV";
-        case EOpHitObjectRecordMissNV: return "EOpHitObjectRecordMissNV";
-        case EOpHitObjectRecordMissMotionNV: return "EOpHitObjectRecordMissMotionNV";
-        case EOpHitObjectRecordEmptyNV: return "EOpHitObjectRecordEmptyNV";
-        case EOpHitObjectExecuteShaderNV: return "EOpHitObjectExecuteShaderNV";
-        case EOpHitObjectIsEmptyNV: return "EOpHitObjectIsEmptyNV";
-        case EOpHitObjectIsMissNV: return "EOpHitObjectIsMissNV";
-        case EOpHitObjectIsHitNV: return "EOpHitObjectIsHitNV";
-        case EOpHitObjectGetRayTMinNV: return "EOpHitObjectGetRayTMinNV";
-        case EOpHitObjectGetRayTMaxNV: return "EOpHitObjectGetRayTMaxNV";
-        case EOpHitObjectGetObjectRayOriginNV: return "EOpHitObjectGetObjectRayOriginNV";
-        case EOpHitObjectGetObjectRayDirectionNV: return "EOpHitObjectGetObjectRayDirectionNV";
-        case EOpHitObjectGetWorldRayOriginNV: return "EOpHitObjectGetWorldRayOriginNV";
-        case EOpHitObjectGetWorldRayDirectionNV: return "EOpHitObjectGetWorldRayDirectionNV";
-        case EOpHitObjectGetWorldToObjectNV: return "EOpHitObjectGetWorldToObjectNV";
-        case EOpHitObjectGetObjectToWorldNV: return "EOpHitObjectGetObjectToWorldNV";
-        case EOpHitObjectGetInstanceCustomIndexNV: return "EOpHitObjectGetInstanceCustomIndexNV";
-        case EOpHitObjectGetInstanceIdNV: return "EOpHitObjectGetInstanceIdNV";
-        case EOpHitObjectGetGeometryIndexNV: return "EOpHitObjectGetGeometryIndexNV";
-        case EOpHitObjectGetPrimitiveIndexNV: return "EOpHitObjectGetPrimitiveIndexNV";
-        case EOpHitObjectGetHitKindNV: return "EOpHitObjectGetHitKindNV";
-        case EOpHitObjectGetShaderBindingTableRecordIndexNV: return "EOpHitObjectGetShaderBindingTableRecordIndexNV";
-        case EOpHitObjectGetShaderRecordBufferHandleNV: return "EOpHitObjectGetShaderRecordBufferHandleNV";
-        case EOpHitObjectGetAttributesNV: return "EOpHitObjectGetAttributesNV";
-        case EOpHitObjectGetCurrentTimeNV: return "EOpHitObjectGetCurrentTimeNV";
-        case EOpReorderThreadNV: return "EOpReorderThreadNV";
-        case EOpFetchMicroTriangleVertexPositionNV: return "EOpFetchMicroTriangleVertexPositionNV";
-        case EOpFetchMicroTriangleVertexBarycentricNV: return "EOpFetchMicroTriangleVertexBarycentricNV";
-        case EOpClip: return "EOpClip";
-        case EOpIsFinite: return "EOpIsFinite";
-        case EOpLog10: return "EOpLog10";
-        case EOpRcp: return "EOpRcp";
-        case EOpSaturate: return "EOpSaturate";
-        case EOpSinCos: return "EOpSinCos";
-        case EOpGenMul: return "EOpGenMul";
-        case EOpDst: return "EOpDst";
-        case EOpInterlockedAdd: return "EOpInterlockedAdd";
-        case EOpInterlockedAnd: return "EOpInterlockedAnd";
-        case EOpInterlockedCompareExchange: return "EOpInterlockedCompareExchange";
-        case EOpInterlockedCompareStore: return "EOpInterlockedCompareStore";
-        case EOpInterlockedExchange: return "EOpInterlockedExchange";
-        case EOpInterlockedMax: return "EOpInterlockedMax";
-        case EOpInterlockedMin: return "EOpInterlockedMin";
-        case EOpInterlockedOr: return "EOpInterlockedOr";
-        case EOpInterlockedXor: return "EOpInterlockedXor";
-        case EOpAllMemoryBarrierWithGroupSync: return "EOpAllMemoryBarrierWithGroupSync";
-        case EOpDeviceMemoryBarrier: return "EOpDeviceMemoryBarrier";
-        case EOpDeviceMemoryBarrierWithGroupSync: return "EOpDeviceMemoryBarrierWithGroupSync";
-        case EOpWorkgroupMemoryBarrier: return "EOpWorkgroupMemoryBarrier";
-        case EOpWorkgroupMemoryBarrierWithGroupSync: return "EOpWorkgroupMemoryBarrierWithGroupSync";
-        case EOpEvaluateAttributeSnapped: return "EOpEvaluateAttributeSnapped";
-        case EOpF32tof16: return "EOpF32tof16";
-        case EOpF16tof32: return "EOpF16tof32";
-        case EOpLit: return "EOpLit";
-        case EOpTextureBias: return "EOpTextureBias";
-        case EOpAsDouble: return "EOpAsDouble";
-        case EOpD3DCOLORtoUBYTE4: return "EOpD3DCOLORtoUBYTE4";
-        case EOpMethodSample: return "EOpMethodSample";
-        case EOpMethodSampleBias: return "EOpMethodSampleBias";
-        case EOpMethodSampleCmp: return "EOpMethodSampleCmp";
-        case EOpMethodSampleCmpLevelZero: return "EOpMethodSampleCmpLevelZero";
-        case EOpMethodSampleGrad: return "EOpMethodSampleGrad";
-        case EOpMethodSampleLevel: return "EOpMethodSampleLevel";
-        case EOpMethodLoad: return "EOpMethodLoad";
-        case EOpMethodGetDimensions: return "EOpMethodGetDimensions";
-        case EOpMethodGetSamplePosition: return "EOpMethodGetSamplePosition";
-        case EOpMethodGather: return "EOpMethodGather";
-        case EOpMethodCalculateLevelOfDetail: return "EOpMethodCalculateLevelOfDetail";
-        case EOpMethodCalculateLevelOfDetailUnclamped: return "EOpMethodCalculateLevelOfDetailUnclamped";
-        case EOpMethodLoad2: return "EOpMethodLoad2";
-        case EOpMethodLoad3: return "EOpMethodLoad3";
-        case EOpMethodLoad4: return "EOpMethodLoad4";
-        case EOpMethodStore: return "EOpMethodStore";
-        case EOpMethodStore2: return "EOpMethodStore2";
-        case EOpMethodStore3: return "EOpMethodStore3";
-        case EOpMethodStore4: return "EOpMethodStore4";
-        case EOpMethodIncrementCounter: return "EOpMethodIncrementCounter";
-        case EOpMethodDecrementCounter: return "EOpMethodDecrementCounter";
-        case EOpMethodConsume: return "EOpMethodConsume";
-        case EOpMethodGatherRed: return "EOpMethodGatherRed";
-        case EOpMethodGatherGreen: return "EOpMethodGatherGreen";
-        case EOpMethodGatherBlue: return "EOpMethodGatherBlue";
-        case EOpMethodGatherAlpha: return "EOpMethodGatherAlpha";
-        case EOpMethodGatherCmp: return "EOpMethodGatherCmp";
-        case EOpMethodGatherCmpRed: return "EOpMethodGatherCmpRed";
-        case EOpMethodGatherCmpGreen: return "EOpMethodGatherCmpGreen";
-        case EOpMethodGatherCmpBlue: return "EOpMethodGatherCmpBlue";
-        case EOpMethodGatherCmpAlpha: return "EOpMethodGatherCmpAlpha";
-        case EOpMethodAppend: return "EOpMethodAppend";
-        case EOpMethodRestartStrip: return "EOpMethodRestartStrip";
-        case EOpMatrixSwizzle: return "EOpMatrixSwizzle";
-        case EOpWaveGetLaneCount: return "EOpWaveGetLaneCount";
-        case EOpWaveGetLaneIndex: return "EOpWaveGetLaneIndex";
-        case EOpWaveActiveCountBits: return "EOpWaveActiveCountBits";
-        case EOpWavePrefixCountBits: return "EOpWavePrefixCountBits";
-        case EOpReadClockSubgroupKHR: return "EOpReadClockSubgroupKHR";
-        case EOpReadClockDeviceKHR: return "EOpReadClockDeviceKHR";
-        case EOpRayQueryGetIntersectionTriangleVertexPositionsEXT: return "EOpRayQueryGetIntersectionTriangleVertexPositionsEXT";
-        case EOpStencilAttachmentReadEXT: return "EOpStencilAttachmentReadEXT";
-        case EOpDepthAttachmentReadEXT: return "EOpDepthAttachmentReadEXT";
-        case EOpImageSampleWeightedQCOM: return "EOpImageSampleWeightedQCOM";
-        case EOpImageBoxFilterQCOM: return "EOpImageBoxFilterQCOM";
-        case EOpImageBlockMatchSADQCOM: return "EOpImageBlockMatchSADQCOM";
-        case EOpImageBlockMatchSSDQCOM: return "EOpImageBlockMatchSSDQCOM";
-    }
-}
-
-std::string glslangNodeToString(const TIntermNode* node) {
-    if (auto nodeAsOperator = node->getAsOperator()) {
-        std::string result;
-        if (node->getAsAggregate()) {
-            result = "Aggregate(";
-        } else if (node->getAsUnaryNode()) {
-            result = "Unary(";
-        } else if (node->getAsBinaryNode()) {
-            result = "Binary(";
-        } else {
-            result = "Operator(";
-        }
-        result += glslangOperatorToString(nodeAsOperator->getOp());
-        result += ')';
-        return result;
-    }
-    if (node->getAsLoopNode()) {
-        return "Loop";
-    }
-    if (auto nodeAsBranch = node->getAsBranchNode()) {
-        return std::string("Branch(") + glslangOperatorToString(nodeAsBranch->getFlowOp()) + ")";
-    }
-    if (auto nodeAsSymbol = node->getAsSymbolNode()) {
-        return std::string("Symbol(") + std::string(nodeAsSymbol->getAccessName()) + ")";
-    }
-    if (node->getAsMethodNode()) {
-        return "Method";
-    }
-    if (node->getAsSwitchNode()) {
-        return "Switch";
-    }
-    if (node->getAsSelectionNode()) {
-        return "Selection";
-    }
-    if (auto nodeAsConstantUnion = node->getAsConstantUnion()) {
-        return "ConstantUnion(size = "
-                + std::to_string(nodeAsConstantUnion->getConstArray().size())
-                + ", type = "
-                + std::string(nodeAsConstantUnion->getType().getCompleteString())
-                + ")";
-    }
-    if (node->getAsTyped()) {
-        return "Typed";
-    }
-    return "Node";
-}
-
-std::string glslangLocToString(const glslang::TSourceLoc& loc) {
-    return loc.getStringNameOrNum() + ":" + std::to_string(loc.line) + ":" + std::to_string(loc.column);
-}
-
-std::string glslangNodeToStringWithLoc(const TIntermNode* node) {
-    return glslangLocToString(node->getLoc()) + ":" + glslangNodeToString(node);
-}
-
-} // namespace astrict

libs/astrict/src/ToGlsl.cpp

@@ -1,768 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#include <astrict/ToGlsl.h>
-
-#include <astrict/CommonTypes.h>
-#include <astrict/DebugCommon.h>
-#include <astrict/GlslTypes.h>
-#include <sstream>
-#include <unordered_set>
-#include <utils/Panic.h>
-
-namespace astrict {
-
-constexpr auto kIndentAmount = "  ";
-constexpr auto kSpace = " ";
-constexpr auto kNewline = "\n";
-
-template<typename T>
-void dumpVariableOrExpression(
-        const PackFromGlsl& pack, const Function& function,
-        T valueId, bool parenthesize, std::ostringstream& out);
-void dumpAnyVariableOrExpression(
-        const PackFromGlsl& pack, const Function& function,
-        VariableOrExpressionId valueId, bool parenthesize, std::ostringstream& out);
-
-template<typename T>
-void dumpExpression(
-        const PackFromGlsl& pack, const Function& function,
-        const T& value, bool parenthesize, std::ostringstream& out);
-
-template<typename T>
-void dumpExpressionOperandExpression(
-        const PackFromGlsl& pack, const Function& function,
-        const T& op, const std::vector<VariableOrExpressionId>& args,
-        bool parenthesize, std::ostringstream& out);
-
-template<typename T>
-void dumpStatement(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        const T& statement, int depth,
-        std::ostringstream& out);
-
-void dumpBlock(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        int depth, std::ostringstream& out);
-
-void indent(int depth, std::ostringstream& out) {
-    for (int i = 0; i < depth; ++i) {
-        out << kIndentAmount;
-    }
-}
-
-void dumpString(const PackFromGlsl& pack, StringId stringId,
-        std::ostringstream& out) {
-    ASSERT_PRECONDITION(pack.strings.find(stringId) != pack.strings.end(),
-            "Missing string");
-    const auto& string = pack.strings.at(stringId);
-    out << string;
-}
-
-void dumpFunctionName(const PackFromGlsl& pack, FunctionId functionId,
-        std::ostringstream& out) {
-    auto name = pack.functionNames.at(functionId);
-    auto indexParenthesis = name.find('(');
-    out << name.substr(0, indexParenthesis);
-}
-
-void dumpType(const PackFromGlsl& pack, TypeId typeId, std::ostringstream& out) {
-    ASSERT_PRECONDITION(pack.types.find(typeId) != pack.types.end(),
-            "Missing type definition");
-    auto& type = pack.types.at(typeId);
-    if (type.qualifiers) {
-        dumpString(pack, type.qualifiers.value(), out);
-    }
-    std::visit([&](auto&& name) {
-        using T = std::decay_t<decltype(name)>;
-        if constexpr (std::is_same_v<T, StringId>) {
-            dumpString(pack, name, out);
-        } else if constexpr (std::is_same_v<T, StructId>) {
-            ASSERT_PRECONDITION(pack.structs.find(name) != pack.structs.end(),
-                    "Missing struct definition");
-            auto& strukt = pack.structs.at(name);
-            dumpString(pack, strukt.name, out);
-        } else {
-            static_assert(always_false_v<T>, "unreachable");
-        }
-    }, type.name);
-    for (const auto& arraySize : type.arraySizes) {
-        out << "[" << arraySize << "]";
-    }
-}
-
-void dumpBinaryExpressionOperator(
-        const PackFromGlsl& pack, const Function& function,
-        ExpressionOperator op, const std::vector<VariableOrExpressionId>& args,
-        const char* opString,
-        std::ostringstream& out) {
-    ASSERT_PRECONDITION(args.size() == 2,
-            "%s must be a binary operator", rValueOperatorToString(op));
-    dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-    out << kSpace << opString << kSpace;
-    dumpAnyVariableOrExpression(pack, function, args[1], /*parenthesize=*/true, out);
-}
-
-template<>
-void dumpExpressionOperandExpression<ExpressionOperator>(
-        const PackFromGlsl& pack, const Function& function,
-        const ExpressionOperator& op, const std::vector<VariableOrExpressionId>& args,
-        bool parenthesize, std::ostringstream& out) {
-    const char* lParen = parenthesize ? "(" : "";
-    const char* rParen = parenthesize ? ")" : "";
-    switch (op) {
-        // Unary
-        case ExpressionOperator::Negative:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "Negative must be a unary operator");
-            out << "-";
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            break;
-        case ExpressionOperator::LogicalNot:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "LogicalNot must be a unary operator");
-            out << "!";
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            break;
-        case ExpressionOperator::BitwiseNot:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "BitwiseNot must be a unary operator");
-            out << "~";
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            break;
-        case ExpressionOperator::PostIncrement:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "PostIncrement must be a unary operator");
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            out << "++";
-            break;
-        case ExpressionOperator::PostDecrement:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "PostDecrement must be a unary operator");
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            out << "--";
-            break;
-        case ExpressionOperator::PreIncrement:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "PreIncrement must be a unary operator");
-            out << "++";
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            break;
-        case ExpressionOperator::PreDecrement:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "PreDecrement must be a unary operator");
-            out << "--";
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            break;
-        case ExpressionOperator::ArrayLength:
-            ASSERT_PRECONDITION(args.size() == 1,
-                    "ArrayLength must be a unary operator");
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            out << ".length";
-            break;
-
-            // Binary
-        case ExpressionOperator::Add:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "+", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::Sub:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "-", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::Mul:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "*", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::Div:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "/", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::Mod:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "%", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::RightShift:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, ">>", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LeftShift:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "<<", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::And:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "&", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::InclusiveOr:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "|", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::ExclusiveOr:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "^", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::Equal:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "==", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::NotEqual:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "!=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LessThan:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "<", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::GreaterThan:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, ">", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LessThanEqual:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "<=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::GreaterThanEqual:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, ">=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LogicalOr:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "||", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LogicalXor:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "^^", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LogicalAnd:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "&&", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::Index:
-            ASSERT_PRECONDITION(args.size() == 2,
-                    "%s must be a binary operator", rValueOperatorToString(op));
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            out << "[";
-            dumpAnyVariableOrExpression(pack, function, args[1], /*parenthesize=*/true, out);
-            out << "]";
-            break;
-        case ExpressionOperator::Assign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::AddAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "+=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::SubAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "-=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::MulAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "*=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::DivAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "/=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::ModAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "%=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::AndAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "&=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::InclusiveOrAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "|=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::ExclusiveOrAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "^=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::LeftShiftAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, "<<=", out);
-            out << rParen;
-            break;
-        case ExpressionOperator::RightShiftAssign:
-            out << lParen;
-            dumpBinaryExpressionOperator(pack, function, op, args, ">>=", out);
-            out << rParen;
-            break;
-
-            // Ternary
-        case ExpressionOperator::Ternary:
-            ASSERT_PRECONDITION(args.size() == 3,
-                    "Ternary must be a ternary operator");
-            out << lParen << "(";
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/true, out);
-            out << ")" << kSpace << "?" << kSpace << "(";
-            dumpAnyVariableOrExpression(pack, function, args[1], /*parenthesize=*/true, out);
-            out << ")" << kSpace << ":" << kSpace << "(";
-            dumpAnyVariableOrExpression(pack, function, args[2], /*parenthesize=*/true, out);
-            out << ")" << rParen;
-            break;
-
-            // Variadic
-        case ExpressionOperator::Comma:
-            ASSERT_PRECONDITION(args.size() >= 2,
-                    "Comma operator must have at least two arguments");
-            out << lParen;
-            dumpAnyVariableOrExpression(pack, function, args[0], /*parenthesize=*/false, out);
-            for (int i = 1; i < args.size(); i++) {
-                out << "," << kSpace;
-                dumpAnyVariableOrExpression(pack, function, args[i], /*parenthesize=*/false, out);
-            }
-            out << rParen;
-            break;
-    }
-}
-
-template <>
-void dumpExpressionOperandExpression<FunctionId>(
-        const PackFromGlsl& pack, const Function& function,
-        const FunctionId& op, const std::vector<VariableOrExpressionId>& args,
-        bool parenthesize, std::ostringstream& out) {
-    dumpFunctionName(pack, op, out);
-    out << "(";
-    bool firstArg = true;
-    for (auto& arg : args) {
-        if (firstArg) {
-            firstArg = false;
-        } else {
-            out << "," << kSpace;
-        }
-        dumpAnyVariableOrExpression(pack, function, arg, /*parenthesize=*/false, out);
-    }
-    out << ")";
-}
-
-template <>
-void dumpExpressionOperandExpression<StructId>(
-        const PackFromGlsl& pack, const Function& function,
-        const StructId& op, const std::vector<VariableOrExpressionId>& args,
-        bool parenthesize, std::ostringstream& out) {
-    ASSERT_PRECONDITION(pack.structs.find(op) != pack.structs.end(),
-            "Missing struct definition");
-    auto& strukt = pack.structs.at(op);
-    out << "(";
-    bool firstArg = true;
-    for (auto& arg : args) {
-        if (firstArg) {
-            firstArg = false;
-        } else {
-            out << "," << kSpace;
-        }
-        dumpAnyVariableOrExpression(pack, function, arg, /*parenthesize=*/false, out);
-    }
-    out << ")";
-}
-
-template<>
-void dumpExpression<ExpressionOperandExpression>(
-        const PackFromGlsl& pack, const Function& function,
-        const ExpressionOperandExpression& value, bool parenthesize,
-        std::ostringstream& out) {
-    std::visit([&](auto&& op) {
-        dumpExpressionOperandExpression(pack, function, op, value.args, parenthesize, out);
-    }, value.op);
-}
-
-template<>
-void dumpExpression<IndexStructExpression>(
-        const PackFromGlsl& pack, const Function& function,
-        const IndexStructExpression& value, bool parenthesize,
-        std::ostringstream& out) {
-    dumpAnyVariableOrExpression(pack, function, value.operand, /*parenthesize=*/true, out);
-    out << ".";
-    ASSERT_PRECONDITION(pack.structs.find(value.strukt) != pack.structs.end(),
-            "Missing struct definition");
-    auto& strukt = pack.structs.at(value.strukt);
-    ASSERT_PRECONDITION(value.index < strukt.members.size(),
-            "Struct member index out of bounds");
-    dumpString(pack, strukt.members[value.index].name, out);
-}
-
-template<>
-void dumpExpression<VectorSwizzleExpression>(
-        const PackFromGlsl& pack, const Function& function,
-        const VectorSwizzleExpression& value, bool parenthesize,
-        std::ostringstream& out) {
-    static const char COMPONENTS[] = {'x', 'y', 'z', 'w'};
-    dumpAnyVariableOrExpression(pack, function, value.operand, /*parenthesize=*/true, out);
-    out << ".";
-    for (int i = 0; i < 4; i++) {
-        int component = (value.swizzle >> (i * 3)) & 0x7;
-        if (component == 0) {
-            break;
-        }
-        out << COMPONENTS[component - 1];
-    }
-}
-
-template<>
-void dumpExpression<LiteralExpression>(
-        const PackFromGlsl& pack, const Function& function,
-        const LiteralExpression& value, bool parenthesize,
-        std::ostringstream& out) {
-    std::visit([&](auto&& value) {
-        out << value;
-    }, value.value);
-}
-
-template<>
-void dumpVariableOrExpression<ExpressionId>(
-        const PackFromGlsl& pack, const Function& function, ExpressionId valueId,
-        bool parenthesize, std::ostringstream& out) {
-    if (*valueId == 0) {
-        out << "INVALID_EXPRESSION";
-        return;
-    }
-    ASSERT_PRECONDITION(pack.expressions.find(valueId) != pack.expressions.end(),
-            "Missing Expression");
-    std::visit([&](auto&& value) {
-        dumpExpression(pack, function, value, parenthesize, out);
-    }, pack.expressions.at(valueId));
-}
-
-template<>
-void dumpVariableOrExpression<GlobalVariableId>(
-        const PackFromGlsl& pack, const Function& function, GlobalVariableId valueId,
-        bool parenthesize, std::ostringstream& out) {
-    if (*valueId == 0) {
-        out << "INVALID_GLOBAL_SYMBOL";
-        return;
-    }
-    ASSERT_PRECONDITION(pack.globalVariables.find(valueId) != pack.globalVariables.end(),
-            "Missing global symbol");
-
-    auto globalSymbol = pack.globalVariables.at(valueId);
-    dumpString(pack, globalSymbol.name, out);
-}
-
-template<>
-void dumpVariableOrExpression<LocalVariableId>(
-        const PackFromGlsl& pack, const Function& function, LocalVariableId valueId,
-        bool parenthesize, std::ostringstream& out) {
-    if (*valueId == 0) {
-        out << "INVALID_LOCAL_SYMBOL";
-        return;
-    }
-    ASSERT_PRECONDITION(function.localVariables.find(valueId) != function.localVariables.end(),
-            "Missing local symbol");
-
-    auto& localSymbol = function.localVariables.at(valueId);
-    dumpString(pack, localSymbol.name, out);
-}
-
-template<>
-void dumpStatement<ExpressionId>(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        const ExpressionId& statement, int depth,
-        std::ostringstream& out) {
-    indent(depth, out);
-    dumpAnyVariableOrExpression(pack, function, statement, /*parenthesize=*/false, out);
-    out << ";" << kNewline;
-}
-
-template<>
-void dumpStatement<IfStatement>(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        const IfStatement& statement, int depth,
-        std::ostringstream& out) {
-    indent(depth, out);
-    out << "if" << kSpace << "(";
-    dumpAnyVariableOrExpression(pack, function, statement.condition, /*parenthesize=*/false, out);
-    out << ")" << kSpace << "{" << kNewline;
-    dumpBlock(pack, function, statement.thenBlock, depth + 1, out);
-    if (statement.elseBlock) {
-        indent(depth, out);
-        out << "}" << kSpace << "else" << kSpace << "{" << kNewline;
-        dumpBlock(pack, function, statement.elseBlock.value(), depth + 1, out);
-    }
-    indent(depth, out);
-    out << "}" << kNewline;
-}
-
-template<>
-void dumpStatement<SwitchStatement>(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        const SwitchStatement& statement, int depth,
-        std::ostringstream& out) {
-    indent(depth, out);
-    out << "switch" << kSpace << "(";
-    dumpAnyVariableOrExpression(pack, function, statement.condition, /*parenthesize=*/false, out);
-    out << ")" << kSpace << "{" << kNewline;
-    dumpBlock(pack, function, statement.body, depth + 1, out);
-    indent(depth, out);
-    out << "}" << kNewline;
-}
-
-template<>
-void dumpStatement<BranchStatement>(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        const BranchStatement& statement, int depth,
-        std::ostringstream& out) {
-    switch (statement.op) {
-        case BranchOperator::Discard:
-            indent(depth, out);
-            out << "discard";
-            break;
-        case BranchOperator::TerminateInvocation:
-            indent(depth, out);
-            out << "terminateInvocation";
-            break;
-        case BranchOperator::Demote:
-            indent(depth, out);
-            out << "demote";
-            break;
-        case BranchOperator::TerminateRayEXT:
-            indent(depth, out);
-            out << "terminateRayEXT";
-            break;
-        case BranchOperator::IgnoreIntersectionEXT:
-            indent(depth, out);
-            out << "terminateIntersectionEXT";
-            break;
-        case BranchOperator::Return:
-            indent(depth, out);
-            out << "return";
-            break;
-        case BranchOperator::Break:
-            indent(depth, out);
-            out << "break";
-            break;
-        case BranchOperator::Continue:
-            indent(depth, out);
-            out << "continue";
-            break;
-        case BranchOperator::Case:
-            indent(depth - 1, out);
-            out << "case";
-            break;
-        case BranchOperator::Default:
-            indent(depth - 1, out);
-            out << "default";
-            break;
-    }
-    if (statement.operand) {
-        out << " ";
-        dumpAnyVariableOrExpression(pack, function, statement.operand.value(),
-                /*parenthesize=*/false, out);
-    }
-    switch (statement.op) {
-        case BranchOperator::Case:
-        case BranchOperator::Default:
-            out << ":" << kNewline;
-            break;
-        default:
-            out << ";" << kNewline;
-            break;
-    }
-}
-
-template<>
-void dumpStatement<LoopStatement>(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        const LoopStatement& statement, int depth,
-        std::ostringstream& out) {
-    if (statement.testFirst) {
-        if (statement.terminal) {
-            indent(depth, out);
-            out << "for" << kSpace << "(;" << kSpace;
-            dumpAnyVariableOrExpression(pack, function, statement.condition,
-                    /*parenthesize=*/false, out);
-            out << ";" << kSpace;
-            dumpAnyVariableOrExpression(pack, function, statement.terminal.value(),
-                    /*parenthesize=*/false, out);
-        } else {
-            indent(depth, out);
-            out << "while" << kSpace << "(";
-            dumpAnyVariableOrExpression(pack, function, statement.condition,
-                    /*parenthesize=*/false, out);
-        }
-        out << ")" << kSpace << "{" << kNewline;
-        dumpBlock(pack, function, statement.body, depth + 1, out);
-        indent(depth, out);
-        out << "}" << kNewline;
-    } else {
-        indent(depth, out);
-        out << "do" << kSpace << "{" << kNewline;
-        dumpBlock(pack, function, statement.body, depth + 1, out);
-        indent(depth, out);
-        out << "}" << kSpace << "while" << kSpace << "(";
-        dumpAnyVariableOrExpression(pack, function, statement.condition, /*parenthesize=*/false, out);
-        out << ");" << kNewline;
-    }
-}
-
-void dumpAnyVariableOrExpression(
-        const PackFromGlsl& pack, const Function& function, VariableOrExpressionId valueId,
-        bool parenthesize, std::ostringstream& out) {
-    std::visit([&](auto&& variantValueId){
-        dumpVariableOrExpression(pack, function, variantValueId, parenthesize, out);
-    }, valueId);
-}
-
-void dumpBlock(
-        const PackFromGlsl& pack, const Function& function, StatementBlockId blockId,
-        int depth, std::ostringstream& out) {
-    ASSERT_PRECONDITION(pack.statementBlocks.find(blockId) != pack.statementBlocks.end(),
-            "Missing block definition");
-    for (auto statement : pack.statementBlocks.at(blockId)) {
-        std::visit([&](auto&& variantStatement){
-            dumpStatement(pack, function, blockId, variantStatement, depth, out);
-        }, statement);
-    }
-}
-
-void dumpSymbolDefinition(
-        const PackFromGlsl& pack, const Variable& symbol,
-        std::ostringstream& out) {
-    ASSERT_PRECONDITION(symbol.type.has_value(),
-            "Symbol definition must have type");
-    dumpType(pack, symbol.type.value(), out);
-    out << " "; // required space
-    dumpString(pack, symbol.name, out);
-}
-
-void dumpFunction(
-        const PackFromGlsl& pack, const FunctionId& functionId, bool dumpBody,
-        std::ostringstream& out) {
-    if (!dumpBody && pack.functions.find(functionId) == pack.functions.end()) {
-        // TODO: prune function prototypes with no actual definition.
-        return;
-    }
-    ASSERT_PRECONDITION(pack.functions.find(functionId) != pack.functions.end(),
-            "Missing function definition");
-    auto& function = pack.functions.at(functionId);
-    dumpType(pack, function.returnType, out);
-    out << " ";
-    dumpFunctionName(pack, function.name, out);
-    out << "(";
-    std::unordered_set<LocalVariableId> parameterSymbolIds;
-    bool firstParameter = true;
-    for (const auto& parameterId : function.parameters) {
-        if (firstParameter) {
-            firstParameter = false;
-        } else {
-            out << "," << kSpace;
-        }
-        parameterSymbolIds.insert(parameterId);
-        const auto& parameter = function.localVariables.at(parameterId);
-        dumpSymbolDefinition(pack, parameter, out);
-    }
-    out << ")";
-    if (dumpBody) {
-        out << kSpace << "{" << kNewline;
-        for (const auto& localSymbol : function.localVariables) {
-            if (parameterSymbolIds.find(localSymbol.first) == parameterSymbolIds.end()) {
-                out << kIndentAmount;
-                dumpSymbolDefinition(pack, localSymbol.second, out);
-                out << ";" << kNewline;
-            }
-        }
-        dumpBlock(pack, function, function.body, 1, out);
-        out << "}" << kNewline;
-    } else {
-        out << ";" << kNewline;
-    }
-}
-
-void dumpStruct(const PackFromGlsl& pack, StructId structId, std::ostringstream& out) {
-    ASSERT_PRECONDITION(pack.structs.find(structId) != pack.structs.end(),
-            "Missing struct definition");
-    auto& strukt = pack.structs.at(structId);
-    out << "struct ";
-    dumpString(pack, strukt.name, out);
-    out << kSpace << "{" << kNewline;
-    for (const auto& member : strukt.members) {
-        indent(1, out);
-        dumpType(pack, member.type, out);
-        out << " "; // non-optional
-        dumpString(pack, member.name, out);
-        out << ";" << kNewline;
-    }
-    out << "};" << kNewline;
-}
-
-void toGlsl(const PackFromGlsl& pack, std::ostringstream& out) {
-    const Function emptyFunction{};
-    for (auto structId : pack.structsInOrder) {
-        dumpStruct(pack, structId, out);
-    }
-    std::unordered_set<GlobalVariableId> globalSymbolIdsWithValues;
-    for (auto globalSymbolPair : pack.globalSymbolsInOrder) {
-        globalSymbolIdsWithValues.insert(globalSymbolPair.first);
-    }
-    for (auto globalSymbolPair : pack.globalVariables) {
-        if (globalSymbolIdsWithValues.find(globalSymbolPair.first)
-                == globalSymbolIdsWithValues.end()) {
-            const auto& globalSymbol = pack.globalVariables.at(globalSymbolPair.first);
-            if (globalSymbol.type) {
-                dumpSymbolDefinition(pack, globalSymbol, out);
-                out << ";" << kNewline;
-            }
-        }
-    }
-    for (auto globalSymbolPair : pack.globalSymbolsInOrder) {
-        const auto& globalSymbol = pack.globalVariables.at(globalSymbolPair.first);
-        dumpSymbolDefinition(pack, globalSymbol, out);
-        out << kSpace << "=" << kSpace;
-        dumpAnyVariableOrExpression(pack, emptyFunction, globalSymbolPair.second,
-                /*parenthesize=*/false, out);
-        out << ";" << kNewline;
-    }
-    for (auto functionId : pack.functionPrototypes) {
-        dumpFunction(pack, functionId, /*dumpBody=*/false, out);
-    }
-    for (auto functionId : pack.functionsInOrder) {
-        dumpFunction(pack, functionId, /*dumpBody=*/true, out);
-    }
-}
-
-} // namespace astrict

libs/astrict/tests/test_FromGlsl.cpp

@@ -1,35 +0,0 @@
-/*
- * Copyright (C) 2024 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.
- */
-
-#include <astrict/FromGlsl.h>
-#include <gtest/gtest.h>
-
-using namespace astrict;
-
-TEST(Pack, Pack) {
-  std::string shaderCode(R"(
-        void material(inout MaterialInputs material) {
-            prepareMaterial(material);
-            material.baseColor = texture(materialParams_sampler, vec3(0.0, 0.0));
-        }
-    )");
-  // auto result = std::get<std::vector<uint8_t>>(compress(shaderCode));
-}
-
-int main(int argc, char** argv) {
-    ::testing::InitGoogleTest(&argc, argv);
-    return RUN_ALL_TESTS();
-}

libs/filamat/CMakeLists.txt

@@ -81,7 +81,7 @@ include_directories(${CMAKE_BINARY_DIR})
 add_library(${TARGET} STATIC ${HDRS} ${PRIVATE_HDRS} ${SRCS})
 target_include_directories(${TARGET} PUBLIC ${PUBLIC_HDR_DIR})
 set_target_properties(${TARGET} PROPERTIES FOLDER Libs)
-target_link_libraries(${TARGET} shaders filabridge utils smol-v astrict)
+target_link_libraries(${TARGET} shaders filabridge utils smol-v)
 
 # We are being naughty and accessing private headers here
 # For spirv-tools, we're just following glslang's example
@@ -157,3 +157,4 @@ target_include_directories(${TARGET} PRIVATE src)
 target_link_libraries(${TARGET} filamat gtest)
 
 set_target_properties(${TARGET} PROPERTIES FOLDER Tests)
+

libs/filamat/src/GLSLPostProcessor.cpp

@@ -43,9 +43,6 @@
 #include <unordered_map>
 #include <vector>
 
-#include <astrict/FromGlsl.h>
-#include <astrict/ToGlsl.h>
-
 using namespace glslang;
 using namespace spirv_cross;
 using namespace spvtools;
@@ -375,11 +372,6 @@ bool GLSLPostProcessor::process(const std::string& inputShader, Config const& co
         return false;
     }
 
-    auto pack = astrict::fromGlsl(*tShader.getIntermediate());
-    std::ostringstream dump;
-    astrict::toGlsl(pack, dump);
-    slog.i << dump.str() << io::endl;
-
     switch (mOptimization) {
         case MaterialBuilder::Optimization::NONE:
             if (internalConfig.spirvOutput) {

libs/utils/include/utils/Allocator.h

@@ -30,6 +30,7 @@
 #include <assert.h>
 #include <stdlib.h>
 #include <stdint.h>
+#include <vector>
 
 namespace utils {
 
@@ -43,14 +44,14 @@ static inline P* add(P* a, T b) noexcept {
 template <typename P>
 static inline P* align(P* p, size_t alignment) noexcept {
     // alignment must be a power-of-two
-    assert(alignment && !(alignment & alignment-1));
+    assert_invariant(alignment && !(alignment & alignment-1));
     return (P*)((uintptr_t(p) + alignment - 1) & ~(alignment - 1));
 }
 
 template <typename P>
 static inline P* align(P* p, size_t alignment, size_t offset) noexcept {
     P* const r = align(add(p, offset), alignment);
-    assert(r >= add(p, offset));
+    assert_invariant(r >= add(p, offset));
     return r;
 }
 
@@ -89,20 +90,19 @@ public:
         // branch-less allocation
         void* const p = pointermath::align(current(), alignment, extra);
         void* const c = pointermath::add(p, size);
-        bool success = c <= end();
+        bool const success = c <= end();
         set_current(success ? c : current());
         return success ? p : nullptr;
     }
 
     // API specific to this allocator
-
     void *getCurrent() UTILS_RESTRICT noexcept {
         return current();
     }
 
     // free memory back to the specified point
     void rewind(void* p) UTILS_RESTRICT noexcept {
-        assert(p>=mBegin && p<end());
+        assert_invariant(p >= mBegin && p < end());
         set_current(p);
     }
 
@@ -122,16 +122,21 @@ public:
     void swap(LinearAllocator& rhs) noexcept;
 
     void *base() noexcept { return mBegin; }
+    void const *base() const noexcept { return mBegin; }
 
     void free(void*, size_t) UTILS_RESTRICT noexcept { }
 
-private:
+protected:
     void* end() UTILS_RESTRICT noexcept { return pointermath::add(mBegin, mSize); }
+    void const* end() const UTILS_RESTRICT noexcept { return pointermath::add(mBegin, mSize); }
+
     void* current() UTILS_RESTRICT noexcept { return pointermath::add(mBegin, mCur); }
+    void const* current() const UTILS_RESTRICT noexcept { return pointermath::add(mBegin, mCur); }
+
+private:
     void set_current(void* p) UTILS_RESTRICT noexcept {
         mCur = uint32_t(uintptr_t(p) - uintptr_t(mBegin));
     }
-
     void* mBegin = nullptr;
     uint32_t mSize = 0;
     uint32_t mCur = 0;
@@ -152,9 +157,7 @@ public:
     explicit HeapAllocator(const AREA&) { }
 
     // our allocator concept
-    void* alloc(size_t size, size_t alignment = alignof(std::max_align_t), size_t extra = 0) {
-        // this allocator doesn't support 'extra'
-        assert(extra == 0);
+    void* alloc(size_t size, size_t alignment = alignof(std::max_align_t)) {
         return aligned_alloc(size, alignment);
     }
 
@@ -171,6 +174,50 @@ public:
     void swap(HeapAllocator&) noexcept { }
 };
 
+/* ------------------------------------------------------------------------------------------------
+ * LinearAllocatorWithFallback
+ *
+ * This is a LinearAllocator that falls back to a HeapAllocator when allocation fail. The Heap
+ * allocator memory is freed only when the LinearAllocator is reset or destroyed.
+ * ------------------------------------------------------------------------------------------------
+ */
+class LinearAllocatorWithFallback : private LinearAllocator, private HeapAllocator {
+    std::vector<void*> mHeapAllocations;
+public:
+    LinearAllocatorWithFallback(void* begin, void* end) noexcept
+        : LinearAllocator(begin, end) {
+    }
+
+    template <typename AREA>
+    explicit LinearAllocatorWithFallback(const AREA& area)
+        : LinearAllocatorWithFallback(area.begin(), area.end()) {
+    }
+
+    ~LinearAllocatorWithFallback() noexcept {
+        LinearAllocatorWithFallback::reset();
+    }
+
+    void* alloc(size_t size, size_t alignment = alignof(std::max_align_t));
+
+    void *getCurrent() noexcept {
+        return LinearAllocator::getCurrent();
+    }
+
+    void rewind(void* p) noexcept {
+        if (p >= LinearAllocator::base() && p < LinearAllocator::end()) {
+            LinearAllocator::rewind(p);
+        }
+    }
+
+    void reset() noexcept;
+
+    void free(void*, size_t) noexcept { }
+
+    bool isHeapAllocation(void* p) const noexcept {
+        return p < LinearAllocator::base() || p >= LinearAllocator::end();
+    }
+};
+
 // ------------------------------------------------------------------------------------------------
 
 class FreeList {
@@ -186,13 +233,13 @@ public:
         Node* const head = mHead;
         mHead = head ? head->next : nullptr;
         // this could indicate a use after free
-        assert(!mHead || mHead >= mBegin && mHead < mEnd);
+        assert_invariant(!mHead || mHead >= mBegin && mHead < mEnd);
         return head;
     }
 
     void push(void* p) noexcept {
-        assert(p);
-        assert(p >= mBegin && p < mEnd);
+        assert_invariant(p);
+        assert_invariant(p >= mBegin && p < mEnd);
         // TODO: assert this is one of our pointer (i.e.: it's address match one of ours)
         Node* const head = static_cast<Node*>(p);
         head->next = mHead;
@@ -229,7 +276,7 @@ public:
     AtomicFreeList& operator=(const FreeList& rhs) = delete;
 
     void* pop() noexcept {
-        Node* const storage = mStorage;
+        Node* const pStorage = mStorage;
 
         HeadPtr currentHead = mHead.load();
         while (currentHead.offset >= 0) {
@@ -237,8 +284,8 @@ public:
             // thread raced ahead of us. But in that case, the computed "newHead" will be discarded
             // since compare_exchange_weak fails. Then this thread will loop with the updated
             // value of currentHead, and try again.
-            Node* const next = storage[currentHead.offset].next.load(std::memory_order_relaxed);
-            const HeadPtr newHead{ next ? int32_t(next - storage) : -1, currentHead.tag + 1 };
+            Node* const pNext = pStorage[currentHead.offset].next.load(std::memory_order_relaxed);
+            const HeadPtr newHead{ pNext ? int32_t(pNext - pStorage) : -1, currentHead.tag + 1 };
             // In the rare case that the other thread that raced ahead of us already returned the 
             // same mHead we just loaded, but it now has a different "next" value, the tag field will not 
             // match, and compare_exchange_weak will fail and prevent that particular race condition.
@@ -246,18 +293,18 @@ public:
                 // This assert needs to occur after we have validated that there was no race condition
                 // Otherwise, next might already contain application data, if another thread
                 // raced ahead of us after we loaded mHead, but before we loaded mHead->next.
-                assert(!next || next >= storage);
+                assert_invariant(!pNext || pNext >= pStorage);
                 break;
             }
         }
-        void* p = (currentHead.offset >= 0) ? (storage + currentHead.offset) : nullptr;
-        assert(!p || p >= storage);
+        void* p = (currentHead.offset >= 0) ? (pStorage + currentHead.offset) : nullptr;
+        assert_invariant(!p || p >= pStorage);
         return p;
     }
 
     void push(void* p) noexcept {
         Node* const storage = mStorage;
-        assert(p && p >= storage);
+        assert_invariant(p && p >= storage);
         Node* const node = static_cast<Node*>(p);
         HeadPtr currentHead = mHead.load();
         HeadPtr newHead = { int32_t(node - storage), currentHead.tag + 1 };
@@ -330,9 +377,9 @@ public:
     // our allocator concept
     void* alloc(size_t size = ELEMENT_SIZE,
                 size_t alignment = ALIGNMENT, size_t offset = OFFSET) noexcept {
-        assert(size <= ELEMENT_SIZE);
-        assert(alignment <= ALIGNMENT);
-        assert(offset == OFFSET);
+        assert_invariant(size <= ELEMENT_SIZE);
+        assert_invariant(alignment <= ALIGNMENT);
+        assert_invariant(offset == OFFSET);
         return mFreeList.pop();
     }
 
@@ -587,23 +634,36 @@ public:
 
     // allocate memory from arena with given size and alignment
     // (acceptable size/alignment may depend on the allocator provided)
-    void* alloc(size_t size, size_t alignment = alignof(std::max_align_t), size_t extra = 0) noexcept {
+    void* alloc(size_t size, size_t alignment, size_t extra) noexcept {
         std::lock_guard<LockingPolicy> guard(mLock);
         void* p = mAllocator.alloc(size, alignment, extra);
         mListener.onAlloc(p, size, alignment, extra);
         return p;
     }
 
+    void* alloc(size_t size, size_t alignment = alignof(std::max_align_t)) noexcept {
+        std::lock_guard<LockingPolicy> guard(mLock);
+        void* p = mAllocator.alloc(size, alignment);
+        mListener.onAlloc(p, size, alignment, 0);
+        return p;
+    }
+
     // Allocate an array of trivially destructible objects
     // for safety, we disable the object-based alloc method if the object type is not
     // trivially destructible, since free() won't call the destructor and this is allocating
     // an array.
     template <typename T,
             typename = typename std::enable_if<std::is_trivially_destructible<T>::value>::type>
-    T* alloc(size_t count, size_t alignment = alignof(T), size_t extra = 0) noexcept {
+    T* alloc(size_t count, size_t alignment, size_t extra) noexcept {
         return (T*)alloc(count * sizeof(T), alignment, extra);
     }
 
+    template <typename T,
+            typename = typename std::enable_if<std::is_trivially_destructible<T>::value>::type>
+    T* alloc(size_t count, size_t alignment = alignof(T)) noexcept {
+        return (T*)alloc(count * sizeof(T), alignment);
+    }
+
     // return memory pointed by p to the arena
     // (actual behaviour may depend on allocator provided)
     void free(void* p) noexcept {
@@ -720,6 +780,8 @@ class ArenaScope {
     }
 
 public:
+    using Arena = ARENA;
+
     explicit ArenaScope(ARENA& allocator)
             : mArena(allocator), mRewind(allocator.getCurrent()) {
     }
@@ -771,7 +833,7 @@ public:
     }
 
     // use with caution
-    ARENA& getAllocator() noexcept { return mArena; }
+    ARENA& getArena() noexcept { return mArena; }
 
 private:
     ARENA& mArena;

libs/utils/include/utils/compiler.h

@@ -179,6 +179,14 @@
 #   define UTILS_HAS_FEATURE_CXX_THREAD_LOCAL 0
 #endif
 
+#if defined(__clang__)
+#define UTILS_NONNULL _Nonnull
+#define UTILS_NULLABLE _Nullable
+#else
+#define UTILS_NONNULL
+#define UTILS_NULLABLE
+#endif
+
 #if defined(_MSC_VER)
 // MSVC does not support loop unrolling hints
 #   define UTILS_UNROLL

libs/utils/src/Allocator.cpp

@@ -16,6 +16,8 @@
 
 #include <utils/Allocator.h>
 
+#include <utils/compiler.h>
+#include <utils/debug.h>
 #include <utils/Log.h>
 
 #include <algorithm>
@@ -52,6 +54,29 @@ void LinearAllocator::swap(LinearAllocator& rhs) noexcept {
     std::swap(mCur, rhs.mCur);
 }
 
+
+// ------------------------------------------------------------------------------------------------
+// LinearAllocatorWithFallback
+// ------------------------------------------------------------------------------------------------
+
+void* LinearAllocatorWithFallback::alloc(size_t size, size_t alignment) {
+    void* p = LinearAllocator::alloc(size, alignment);
+    if (UTILS_UNLIKELY(!p)) {
+        p = HeapAllocator::alloc(size, alignment);
+        mHeapAllocations.push_back(p);
+    }
+    assert_invariant(p);
+    return p;
+}
+
+void LinearAllocatorWithFallback::reset() noexcept {
+    LinearAllocator::reset();
+    for (auto* p : mHeapAllocations) {
+        HeapAllocator::free(p);
+    }
+    mHeapAllocations.clear();
+}
+
 // ------------------------------------------------------------------------------------------------
 // FreeList
 // ------------------------------------------------------------------------------------------------
@@ -61,8 +86,8 @@ FreeList::Node* FreeList::init(void* begin, void* end,
 {
     void* const p = pointermath::align(begin, alignment, extra);
     void* const n = pointermath::align(pointermath::add(p, elementSize), alignment, extra);
-    assert(p >= begin && p < end);
-    assert(n >= begin && n < end && n > p);
+    assert_invariant(p >= begin && p < end);
+    assert_invariant(n >= begin && n < end && n > p);
 
     const size_t d = uintptr_t(n) - uintptr_t(p);
     const size_t num = (uintptr_t(end) - uintptr_t(p)) / d;
@@ -77,8 +102,8 @@ FreeList::Node* FreeList::init(void* begin, void* end,
         cur->next = next;
         cur = next;
     }
-    assert(cur < end);
-    assert(pointermath::add(cur, d) <= end);
+    assert_invariant(cur < end);
+    assert_invariant(pointermath::add(cur, d) <= end);
     cur->next = nullptr;
     return head;
 }
@@ -97,13 +122,13 @@ AtomicFreeList::AtomicFreeList(void* begin, void* end,
 {
 #ifdef __ANDROID__
     // on some platform (e.g. web) this returns false. we really only care about mobile though.
-    assert(mHead.is_lock_free());
+    assert_invariant(mHead.is_lock_free());
 #endif
 
     void* const p = pointermath::align(begin, alignment, extra);
     void* const n = pointermath::align(pointermath::add(p, elementSize), alignment, extra);
-    assert(p >= begin && p < end);
-    assert(n >= begin && n < end && n > p);
+    assert_invariant(p >= begin && p < end);
+    assert_invariant(n >= begin && n < end && n > p);
 
     const size_t d = uintptr_t(n) - uintptr_t(p);
     const size_t num = (uintptr_t(end) - uintptr_t(p)) / d;
@@ -119,8 +144,8 @@ AtomicFreeList::AtomicFreeList(void* begin, void* end,
         cur->next = next;
         cur = next;
     }
-    assert(cur < end);
-    assert(pointermath::add(cur, d) <= end);
+    assert_invariant(cur < end);
+    assert_invariant(pointermath::add(cur, d) <= end);
     cur->next = nullptr;
 
     mHead.store({ int32_t(head - mStorage), 0 });
@@ -148,22 +173,25 @@ TrackingPolicy::HighWatermark::~HighWatermark() noexcept {
 }
 
 void TrackingPolicy::HighWatermark::onFree(void* p, size_t size) noexcept {
-    assert(mCurrent >= size);
+    // FIXME: this code is incorrect with LinearAllocators because free() is a no-op for them
+    assert_invariant(mCurrent >= size);
     mCurrent -= uint32_t(size);
 }
 void TrackingPolicy::HighWatermark::onReset() noexcept {
     // we should never be here if mBase is nullptr because compilation would have failed when
     // Arena::onReset() tries to call the underlying allocator's onReset()
-    assert(mBase);
+    assert_invariant(mBase);
     mCurrent = 0;
 }
 
 void TrackingPolicy::HighWatermark::onRewind(void const* addr) noexcept {
     // we should never be here if mBase is nullptr because compilation would have failed when
     // Arena::onRewind() tries to call the underlying allocator's onReset()
-    assert(mBase);
-    assert(addr >= mBase);
-    mCurrent = uint32_t(uintptr_t(addr) - uintptr_t(mBase));
+    assert_invariant(mBase);
+    // for LinearAllocatorWithFallback we could get pointers outside the range
+    if (addr >= mBase && addr < pointermath::add(mBase, mSize)) {
+        mCurrent = uint32_t(uintptr_t(addr) - uintptr_t(mBase));
+    }
 }
 
 // ------------------------------------------------------------------------------------------------
@@ -183,7 +211,7 @@ void TrackingPolicy::Debug::onFree(void* p, size_t size) noexcept {
 void TrackingPolicy::Debug::onReset() noexcept {
     // we should never be here if mBase is nullptr because compilation would have failed when
     // Arena::onReset() tries to call the underlying allocator's onReset()
-    assert(mBase);
+    assert_invariant(mBase);
     memset(mBase, 0xec, mSize);
 }
 

web/filament-js/package.json

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