descriptor layouts distinguish samplers and external samplers

BUGS=[376089915]
google · Oct 30, 2024 · 1cc87aa · 1cc87aa
1 parent eb1b30c
commit 1cc87aa
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 12 deletions.
diff --git a/NEW_RELEASE_NOTES.md b/NEW_RELEASE_NOTES.md
@@ -7,3 +7,5 @@ for next branch cut* header.
 appropriate header in [RELEASE_NOTES.md](./RELEASE_NOTES.md).
 
 ## Release notes for next branch cut
+
+- backend: descriptor layouts distinguish samplers and external samplers (b/376089915) [⚠️ **New Material Version**]
diff --git a/filament/backend/include/backend/DriverEnums.h b/filament/backend/include/backend/DriverEnums.h
@@ -227,6 +227,7 @@ enum class DescriptorType : uint8_t {
     SHADER_STORAGE_BUFFER,
     SAMPLER,
     INPUT_ATTACHMENT,
+    SAMPLER_EXTERNAL
 };
 
 enum class DescriptorFlags : uint8_t {

diff --git a/filament/backend/src/metal/MetalDriver.mm b/filament/backend/src/metal/MetalDriver.mm
@@ -623,6 +623,8 @@
             return "SAMPLER";
         case DescriptorType::INPUT_ATTACHMENT:
             return "INPUT_ATTACHMENT";
+        case DescriptorType::SAMPLER_EXTERNAL:
+            return "SAMPLER_EXTERNAL";
     }
 }
 

diff --git a/filament/backend/src/metal/MetalHandles.mm b/filament/backend/src/metal/MetalHandles.mm
@@ -1290,7 +1290,8 @@ static void func(void* user) {
                 [arguments addObject:bufferArgument];
                 break;
             }
-            case DescriptorType::SAMPLER: {
+            case DescriptorType::SAMPLER:
+            case DescriptorType::SAMPLER_EXTERNAL: {
                 MTLArgumentDescriptor* textureArgument = [MTLArgumentDescriptor argumentDescriptor];
                 textureArgument.index = binding.binding * 2;
                 textureArgument.dataType = MTLDataTypeTexture;
@@ -1405,7 +1406,8 @@ static void func(void* user) {
                            atIndex:binding.binding * 2];
                 break;
             }
-            case DescriptorType::SAMPLER: {
+            case DescriptorType::SAMPLER:
+            case DescriptorType::SAMPLER_EXTERNAL: {
                 auto found = textures.find(binding.binding);
                 if (found == textures.end()) {
                     [encoder setTexture:driver->mContext->emptyTexture atIndex:binding.binding * 2];

diff --git a/filament/backend/src/opengl/BindingMap.h b/filament/backend/src/opengl/BindingMap.h
@@ -69,7 +69,9 @@ class BindingMap {
         assert_invariant(set < MAX_DESCRIPTOR_SET_COUNT);
         assert_invariant(binding < MAX_DESCRIPTOR_COUNT);
         assert_invariant(entry.binding < 128); // we reserve 1 bit for the type right now
-        mStorage[set][binding] = { (uint8_t)entry.binding, entry.type == DescriptorType::SAMPLER };
+        mStorage[set][binding] = { (uint8_t)entry.binding,
+                                   entry.type == DescriptorType::SAMPLER ||
+                                   entry.type == DescriptorType::SAMPLER_EXTERNAL };
         mActiveDescriptors[set].set(binding);
     }
 

diff --git a/filament/backend/src/opengl/GLDescriptorSet.cpp b/filament/backend/src/opengl/GLDescriptorSet.cpp
@@ -96,6 +96,7 @@ GLDescriptorSet::GLDescriptorSet(OpenGLContext& gl, DescriptorSetLayoutHandle ds
                 break;
             }
             case DescriptorType::SAMPLER:
+            case DescriptorType::SAMPLER_EXTERNAL:
                 if (UTILS_UNLIKELY(gl.isES2())) {
                     desc.emplace<SamplerGLES2>();
                 } else {

diff --git a/filament/backend/src/opengl/OpenGLProgram.cpp b/filament/backend/src/opengl/OpenGLProgram.cpp
@@ -174,7 +174,8 @@ void OpenGLProgram::initializeProgramState(OpenGLContext& context, GLuint progra
                     }
                     break;
                 }
-                case DescriptorType::SAMPLER: {
+                case DescriptorType::SAMPLER:
+                case DescriptorType::SAMPLER_EXTERNAL: {
                     if (!entry.name.empty()) {
                         GLint const loc = glGetUniformLocation(program, entry.name.c_str());
                         if (loc >= 0) {

diff --git a/filament/backend/src/vulkan/VulkanHandles.cpp b/filament/backend/src/vulkan/VulkanHandles.cpp
@@ -91,6 +91,10 @@ BitmaskGroup fromBackendLayout(DescriptorSetLayout const& layout) {
                 fromStageFlags(binding.stageFlags, binding.binding, mask.sampler);
                 break;
             }
+            case DescriptorType::SAMPLER_EXTERNAL: {
+                PANIC_POSTCONDITION("DescriptorType::SAMPLER_EXTERNAL is not supported yet");
+                break;
+            }
             case DescriptorType::INPUT_ATTACHMENT: {
                 fromStageFlags(binding.stageFlags, binding.binding, mask.inputAttachment);
                 break;

diff --git a/filament/src/ds/DescriptorSetLayout.cpp b/filament/src/ds/DescriptorSetLayout.cpp
@@ -35,8 +35,11 @@ DescriptorSetLayout::DescriptorSetLayout(
         backend::DescriptorSetLayout descriptorSetLayout) noexcept  {
     for (auto&& desc : descriptorSetLayout.bindings) {
         mMaxDescriptorBinding = std::max(mMaxDescriptorBinding, desc.binding);
-        mSamplers.set(desc.binding, desc.type == backend::DescriptorType::SAMPLER);
-        mUniformBuffers.set(desc.binding, desc.type == backend::DescriptorType::UNIFORM_BUFFER);
+        mSamplers.set(desc.binding,
+                desc.type == backend::DescriptorType::SAMPLER ||
+                desc.type == backend::DescriptorType::SAMPLER_EXTERNAL);
+        mUniformBuffers.set(desc.binding,
+                desc.type == backend::DescriptorType::UNIFORM_BUFFER);
     }
 
     mDescriptorSetLayoutHandle = factory.create(driver,

diff --git a/libs/filamat/src/GLSLPostProcessor.cpp b/libs/filamat/src/GLSLPostProcessor.cpp
@@ -72,6 +72,8 @@ const char* toString(DescriptorType type) {
             return "SAMPLER";
         case DescriptorType::INPUT_ATTACHMENT:
             return "INPUT_ATTACHMENT";
+        case DescriptorType::SAMPLER_EXTERNAL:
+            return "SAMPLER_EXTERNAL";
     }
 }
 
@@ -135,7 +137,9 @@ DescriptorSetLayout getPerMaterialDescriptorSet(SamplerInterfaceBlock const& sib
             +PerMaterialBindingPoints::MATERIAL_PARAMS, DescriptorFlags::NONE, 0 });
 
     for (auto const& sampler : samplers) {
-        layout.bindings.push_back(DescriptorSetLayoutBinding { DescriptorType::SAMPLER,
+        layout.bindings.push_back(DescriptorSetLayoutBinding {
+                (sampler.type == SamplerInterfaceBlock::Type::SAMPLER_EXTERNAL) ?
+                        DescriptorType::SAMPLER_EXTERNAL : DescriptorType::SAMPLER,
                 ShaderStageFlags::VERTEX | ShaderStageFlags::FRAGMENT, sampler.binding,
                 DescriptorFlags::NONE, 0 });
     }
@@ -211,7 +215,8 @@ static void collectDescriptorsForSet(filament::DescriptorSetBindingPoints set,
     for (size_t i = 0; i < info.bindings.size(); i++) {
         backend::descriptor_binding_t binding = info.bindings[i].binding;
         auto name = getDescriptorName(set, binding);
-        if (info.bindings[i].type == DescriptorType::SAMPLER) {
+        if (info.bindings[i].type == DescriptorType::SAMPLER ||
+            info.bindings[i].type == DescriptorType::SAMPLER_EXTERNAL) {
             auto pos = std::find_if(samplerList.begin(), samplerList.end(),
                     [&](const auto& entry) { return entry.binding == binding; });
             assert_invariant(pos != samplerList.end());
@@ -245,7 +250,8 @@ void prettyPrintDescriptorSetInfoVector(DescriptorSets const& sets) {
         printf("[DS] info (%s) = [\n", getName(setIndex));
         for (auto const& descriptor : descriptors) {
             auto const& [name, info, sampler] = descriptor;
-            if (info.type == DescriptorType::SAMPLER) {
+            if (info.type == DescriptorType::SAMPLER ||
+                info.type == DescriptorType::SAMPLER_EXTERNAL) {
                 assert_invariant(sampler.has_value());
                 printf("    {name = %s, binding = %d, type = %s, count = %d, stage = %s, flags = "
                        "%s, samplerType = %s}",
@@ -456,7 +462,8 @@ void GLSLPostProcessor::spirvToMsl(const SpirvBlob* spirv, std::string* outMsl,
                     break;
                 }
 
-                case DescriptorType::SAMPLER: {
+                case DescriptorType::SAMPLER:
+                case DescriptorType::SAMPLER_EXTERNAL: {
                     assert_invariant(sampler.has_value());
                     const std::string samplerName = std::string(name.c_str()) + "Smplr";
                     argBufferBuilder

diff --git a/libs/filamat/src/eiff/MaterialInterfaceBlockChunk.cpp b/libs/filamat/src/eiff/MaterialInterfaceBlockChunk.cpp
@@ -202,7 +202,11 @@ void MaterialDescriptorBindingsChuck::flatten(Flattener& f) {
     // all the material's sampler descriptors
     for (auto const& entry: mSamplerInterfaceBlock.getSamplerInfoList()) {
         f.writeString({ entry.uniformName.data(), entry.uniformName.size() });
-        f.writeUint8(uint8_t(DescriptorType::SAMPLER));
+        if (entry.type == SamplerInterfaceBlock::Type::SAMPLER_EXTERNAL) {
+            f.writeUint8(uint8_t(DescriptorType::SAMPLER_EXTERNAL));
+        } else {
+            f.writeUint8(uint8_t(DescriptorType::SAMPLER));
+        }
         f.writeUint8(entry.binding);
     }
 
@@ -256,7 +260,11 @@ void MaterialDescriptorSetLayoutChunk::flatten(Flattener& f) {
 
     // all the material's sampler descriptors
     for (auto const& entry: mSamplerInterfaceBlock.getSamplerInfoList()) {
-        f.writeUint8(uint8_t(DescriptorType::SAMPLER));
+        if (entry.type == SamplerInterfaceBlock::Type::SAMPLER_EXTERNAL) {
+            f.writeUint8(uint8_t(DescriptorType::SAMPLER_EXTERNAL));
+        } else {
+            f.writeUint8(uint8_t(DescriptorType::SAMPLER));
+        }
         f.writeUint8(uint8_t(ShaderStageFlags::VERTEX | ShaderStageFlags::FRAGMENT));
         f.writeUint8(entry.binding);
         f.writeUint8(uint8_t(DescriptorFlags::NONE));
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,5 @@ for next branch cut* header.
		appropriate header in [RELEASE_NOTES.md](./RELEASE_NOTES.md).

		## Release notes for next branch cut

		- backend: descriptor layouts distinguish samplers and external samplers (b/376089915) [⚠️ New Material Version]