[OGSMOD-2694] cherry-pick 71e55a12 from adsk/feature/text. [OGSMOD-25…

…74] Add the support for input/output qualifiers (PixarAnimationStudios#208) ### Description of Change(s) Add the support for input/output qualifiers. Currently only "flat" qualifier is supported. ### Fixes Issue(s) OGSMOD-2574: Input/output layout doesn't support qualifiers For example, you can not add "flat", "smooth" or "noperspective" to an input. (cherry picked from commit 6bcb00af841f3abfc8353c32338e54c44a71a2f0) Co-authored-by: Pierre Wang <[email protected]>
autodesk-forks · Jan 4, 2023 · f32338c · f32338c
1 parent 925d419
commit f32338c
Show file tree

Hide file tree

Showing 7 changed files with 60 additions and 7 deletions.
diff --git a/pxr/imaging/hdSt/codeGen.cpp b/pxr/imaging/hdSt/codeGen.cpp
@@ -724,6 +724,7 @@ _ResourceGenerator::_GenerateHgiResources(
                 HgiShaderFunctionParamBlockDesc::Member paramMember;
                 paramMember.name = member.name;
                 paramMember.type = _ConvertBoolType(member.dataType);
+                paramMember.qualifiers = member.qualifiers;
                 paramBlock.members.push_back(paramMember);
             }
             if (element.inOut == InOut::STAGE_IN) {
@@ -925,8 +926,12 @@ _ResourceGenerator::_GenerateGLSLResources(
                 }
                 str << element.aggregateName << " {\n";
                 for (auto const & member : element.members) {
-                    str << "    " << member.dataType << " "
-                                        << member.name;
+                    str << "    ";
+                    // Only check flat qualifier, because the Element class also only check flat.
+                    if (member.qualifiers == _tokens->flat) {
+                        str << "flat ";
+                    }
+                    str << member.dataType << " " << member.name;
                     if (member.arraySize.IsEmpty()) {
                         str << ";\n";
                     } else {

diff --git a/pxr/imaging/hdSt/resourceLayout.cpp b/pxr/imaging/hdSt/resourceLayout.cpp
@@ -72,11 +72,15 @@ _ParseMembers(InputValueVector const & input, int fromElement)
     MemberVector result;
     for (auto const & inputValue : input) {
         InputValueVector memberInput = _GetInputValueVector(inputValue);
-        if (memberInput.size() != 2 && memberInput.size() != 3) continue;
+        if (memberInput.size() != 2 && memberInput.size() != 3 && memberInput.size() != 4) continue;
         result.emplace_back(/*dataType=*/_Token(memberInput[0]),
                             /*name=*/_Token(memberInput[1]));
-        if (input.size() == 3) {
-            result.back().arraySize = _Token(input[2]);
+        if (memberInput.size() == 3) {
+            result.back().arraySize = _Token(memberInput[2]);
+        }
+        // The support for member qualifiers.
+        if (memberInput.size() == 4) {
+            result.back().qualifiers = _Token(memberInput[3]);
         }
     }
     return result;

diff --git a/pxr/imaging/hdSt/resourceLayout.h b/pxr/imaging/hdSt/resourceLayout.h
@@ -107,14 +107,16 @@ class HdSt_ResourceLayout
     struct Member {
         Member(TfToken const & dataType,
                TfToken const & name,
-               TfToken const & arraySize = TfToken())
+               TfToken const & arraySize = TfToken(),
+               TfToken qualifiers = TfToken())
             : dataType(dataType)
             , name(name)
             , arraySize(arraySize)
             { }
         TfToken dataType;
         TfToken name;
         TfToken arraySize;
+        TfToken qualifiers;
     };
     using MemberVector = std::vector<Member>;
 

diff --git a/pxr/imaging/hgi/shaderFunctionDesc.h b/pxr/imaging/hgi/shaderFunctionDesc.h
@@ -209,6 +209,7 @@ struct HgiShaderFunctionParamBlockDesc
     struct Member {
         std::string name;
         std::string type;
+        std::string qualifiers;
     };
     using MemberVector = std::vector<Member>;
 

diff --git a/pxr/imaging/hgiMetal/shaderGenerator.mm b/pxr/imaging/hgiMetal/shaderGenerator.mm
@@ -37,6 +37,21 @@
     (textureBindings)
 );
 
+
+// Convert the qualifiers to the interpolation string in MSL.
+std::string _GetInterpolationString(std::string const & qualifiers)
+{
+    if (qualifiers == "flat") {
+        return qualifiers;
+    }
+    else if(qualifiers == "noperspective") {
+        return "center_no_perspective";
+    }
+    else {
+        return "";
+    }
+}
+
 template<typename SectionType, typename ...T>
 SectionType *
 HgiMetalShaderGenerator::CreateShaderSection(T && ...t)
@@ -644,6 +659,8 @@ void _Init(
     HgiShaderStage stage,
     bool iterateAttrs)
 {
+    // Currently we don't add qualifiers for function parameters.
+    const static std::string emptyQualifiers("");
     HgiMetalShaderSectionPtrVector stageShaderSections;
     //only some roles have an index
     if(!iterateAttrs) {
@@ -695,6 +712,7 @@ void _Init(
                     HgiMetalMemberShaderSection>(
                         p.nameInShader,
                         p.type,
+                        emptyQualifiers,
                         attributes,
                         p.arraySize);
             stageShaderSections.push_back(section);
@@ -719,6 +737,7 @@ void _Init(
                     HgiMetalMemberShaderSection>(
                         p.nameInShader,
                         p.type,
+                        emptyQualifiers,
                         attributes,
                         p.arraySize);
             stageShaderSections.push_back(section);
@@ -750,6 +769,7 @@ void _Init(
                         HgiMetalMemberShaderSection>(
                             m.name,
                             m.type,
+                            _GetInterpolationString(m.qualifiers),
                             attributes,
                             std::string(),
                             p.instanceName);
@@ -1340,12 +1360,15 @@ void _Init(
   : HgiShaderGenerator(descriptor)
   , _generatorShaderSections(_BuildShaderStageEntryPoints(descriptor))
 {
+    // Currently we don't add qualifiers for global uniforms.
+    const static std::string emptyQualifiers("");
     for (const auto &member: descriptor.stageGlobalMembers) {
         HgiShaderSectionAttributeVector attrs;
         CreateShaderSection<
             HgiMetalMemberShaderSection>(
                 member.nameInShader,
                 member.type,
+                emptyQualifiers,
                 attrs,
                 member.arraySize);
     }

diff --git a/pxr/imaging/hgiMetal/shaderSection.h b/pxr/imaging/hgiMetal/shaderSection.h
@@ -121,6 +121,7 @@ class HgiMetalMemberShaderSection final : public HgiMetalShaderSection
     HgiMetalMemberShaderSection(
         const std::string &identifier,
         const std::string &type,
+        const std::string &qualifiers,
         const HgiShaderSectionAttributeVector &attributes = {},
         const std::string arraySize = std::string(),
         const std::string &blockInstanceIdentifier = std::string());
@@ -130,12 +131,15 @@ class HgiMetalMemberShaderSection final : public HgiMetalShaderSection
 
     HGIMETAL_API
     void WriteType(std::ostream &ss) const override;
+    HGIMETAL_API
+    void WriteParameter(std::ostream& ss) const override;
 
     HGIMETAL_API
     bool VisitScopeMemberDeclarations(std::ostream &ss) override;
 
 private:
     const std::string _type;
+    const std::string _qualifiers;
 };
 
 /// \class HgiMetalSamplerShaderSection

diff --git a/pxr/imaging/hgiMetal/shaderSection.mm b/pxr/imaging/hgiMetal/shaderSection.mm
@@ -104,13 +104,14 @@
 HgiMetalMemberShaderSection::HgiMetalMemberShaderSection(
     const std::string &identifier,
     const std::string &type,
+    const std::string &qualifiers,
     const HgiShaderSectionAttributeVector &attributes,
     const std::string arraySize,
     const std::string &blockInstanceIdentifier)
   : HgiMetalShaderSection(identifier, attributes,
                           std::string(), arraySize,
                           blockInstanceIdentifier)
-  , _type{type}
+    , _type{ type }, _qualifiers{qualifiers}
 {
 }
 
@@ -122,6 +123,19 @@
     ss << _type;
 }
 
+void
+HgiMetalMemberShaderSection::WriteParameter(std::ostream& ss) const
+{
+    WriteType(ss);
+    ss << " ";
+    WriteIdentifier(ss);
+    // Write the qualifiers, such as "flat" and "center_no_perspective".
+    if (!_qualifiers.empty())
+    {
+        ss << " [[" << _qualifiers << "]]";
+    }
+}
+
 bool
 HgiMetalMemberShaderSection::VisitScopeMemberDeclarations(std::ostream &ss)
 {