Fix culture issues when generating attributes defines in shaders (#40)

julienf-unity · julienf-unity · commit 142d3014c688 · 2020-07-03T19:08:40.000+02:00
diff --git a/com.unity.visualeffectgraph/CHANGELOG.md b/com.unity.visualeffectgraph/CHANGELOG.md
@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - SpawnIndex attribute returns correct value in update and outputs contexts
 - Disable Reset option in context menu for all VFXObject [Case 1251519](https://issuetracker.unity3d.com/product/unity/issues/guid/1251519/) & [Case 1251533](https://issuetracker.unity3d.com/product/unity/issues/guid/1251533/)
 - Avoid other NullReferenceException using property binders
+- Fix culture issues when generating attributes defines in shaders [Case 1222819](https://issuetracker.unity3d.com/product/unity/issues/guid/1222819/)
 
 ## [9.0.0] - 2020-07-09
 
diff --git a/com.unity.visualeffectgraph/Editor/Compiler/VFXCodeGenerator.cs b/com.unity.visualeffectgraph/Editor/Compiler/VFXCodeGenerator.cs
@@ -8,6 +8,7 @@
 
 using Object = UnityEngine.Object;
 using System.Text.RegularExpressions;
+using System.Globalization;
 
 namespace UnityEditor.VFX
 {
@@ -418,9 +419,9 @@ static private StringBuilder Build(VFXContext context, string templatePath, VFXC
             globalIncludeContent.WriteLine("#define VFX_PASSDEPTH_SELECTION (2)");
 
             foreach (var attribute in allCurrentAttributes)
-                globalIncludeContent.WriteLineFormat("#define VFX_USE_{0}_{1} 1", attribute.attrib.name.ToUpper(), "CURRENT");
+                globalIncludeContent.WriteLineFormat("#define VFX_USE_{0}_{1} 1", attribute.attrib.name.ToUpper(CultureInfo.InvariantCulture), "CURRENT");
             foreach (var attribute in allSourceAttributes)
-                globalIncludeContent.WriteLineFormat("#define VFX_USE_{0}_{1} 1", attribute.attrib.name.ToUpper(), "SOURCE");
+                globalIncludeContent.WriteLineFormat("#define VFX_USE_{0}_{1} 1", attribute.attrib.name.ToUpper(CultureInfo.InvariantCulture), "SOURCE");
 
             foreach (var additionnalHeader in context.additionalDataHeaders)
                 globalIncludeContent.WriteLine(additionnalHeader);
diff --git a/com.unity.visualeffectgraph/Editor/Models/Blocks/Implementations/Attribute/AttributeFromCurve.cs b/com.unity.visualeffectgraph/Editor/Models/Blocks/Implementations/Attribute/AttributeFromCurve.cs
@@ -3,6 +3,7 @@
 using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.VFX;
+using System.Globalization;
 
 namespace UnityEditor.VFX.Block
 {
@@ -213,7 +214,7 @@ protected override IEnumerable<string> filteredOutSettings
 
         static private string GenerateLocalAttributeName(string name)
         {
-            return name[0].ToString().ToUpper() + name.Substring(1);
+            return name[0].ToString().ToUpper(CultureInfo.InvariantCulture) + name.Substring(1);
         }
 
         public override string source
diff --git a/com.unity.visualeffectgraph/Editor/Models/Blocks/Implementations/Attribute/SetCustomAttribute.cs b/com.unity.visualeffectgraph/Editor/Models/Blocks/Implementations/Attribute/SetCustomAttribute.cs
@@ -3,6 +3,7 @@
 using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.VFX;
+using System.Globalization;
 
 namespace UnityEditor.VFX.Block
 {
@@ -80,7 +81,7 @@ public override IEnumerable<VFXAttributeInfo> attributes
 
         static private string GenerateLocalAttributeName(string name)
         {
-            return "_" + name[0].ToString().ToUpper() + name.Substring(1);
+            return "_" + name[0].ToString().ToUpper(CultureInfo.InvariantCulture) + name.Substring(1);
         }
 
         public override string source
diff --git a/com.unity.visualeffectgraph/Editor/Models/Blocks/Implementations/SetAttribute.cs b/com.unity.visualeffectgraph/Editor/Models/Blocks/Implementations/SetAttribute.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using UnityEngine;
 using UnityEngine.VFX;
+using System.Globalization;
 
 namespace UnityEditor.VFX.Block
 {
@@ -188,7 +189,7 @@ public override IEnumerable<VFXAttributeInfo> attributes
 
         static private string GenerateLocalAttributeName(string name)
         {
-            return name[0].ToString().ToUpper() + name.Substring(1);
+            return name[0].ToString().ToUpper(CultureInfo.InvariantCulture) + name.Substring(1);
         }
 
         public override string source
@@ -306,7 +307,7 @@ protected override IEnumerable<VFXPropertyWithValue> inputProperties
                         var attrib = currentAttribute;
 
                         VFXPropertyAttributes attr = new VFXPropertyAttributes();
-                        var field = typeof(VFXAttribute).GetField(attrib.name.Substring(0, 1).ToUpper() + attrib.name.Substring(1), System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.Public);
+                        var field = typeof(VFXAttribute).GetField(attrib.name.Substring(0, 1).ToUpper(CultureInfo.InvariantCulture) + attrib.name.Substring(1), System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.Public);
 
                         TooltipAttribute tooltip = null;
 
diff --git a/com.unity.visualeffectgraph/Editor/Models/Parameters/VFXAttributeParameter.cs b/com.unity.visualeffectgraph/Editor/Models/Parameters/VFXAttributeParameter.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using UnityEngine;
 
@@ -91,7 +92,7 @@ protected override IEnumerable<VFXPropertyWithValue> outputProperties
             {
                 var attribute = VFXAttribute.Find(this.attribute);
 
-                var field = typeof(VFXAttribute).GetField(attribute.name.Substring(0, 1).ToUpper() + attribute.name.Substring(1), System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.Public);
+                var field = typeof(VFXAttribute).GetField(attribute.name.Substring(0, 1).ToUpper(CultureInfo.InvariantCulture) + attribute.name.Substring(1), System.Reflection.BindingFlags.Static | System.Reflection.BindingFlags.Public);
 
                 TooltipAttribute tooltip = null;
 
diff --git a/com.unity.visualeffectgraph/Editor/ShaderGraph/VFXShaderGraphParticleOutput.cs b/com.unity.visualeffectgraph/Editor/ShaderGraph/VFXShaderGraphParticleOutput.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Globalization;
 using System.Linq;
 using System.Reflection;
 using UnityEditor.ShaderGraph;
@@ -269,7 +270,7 @@ public override IEnumerable<string> additionalDefines
                     {
                         var portInfo = shaderGraph.GetOutput(port);
                         if (!string.IsNullOrEmpty(portInfo.referenceName))
-                            yield return $"HAS_SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper()}";
+                            yield return $"HAS_SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper(CultureInfo.InvariantCulture)}";
                     }
 
                     bool needsPosWS = false;
@@ -289,10 +290,10 @@ public override IEnumerable<string> additionalDefines
                         bool hasNormalPort = pixelPorts.Any(t => t == ShaderGraphVfxAsset.NormalSlotId) && shaderGraph.HasOutput(ShaderGraphVfxAsset.NormalSlotId);
 
                         if (readsNormal || readsTangent || hasNormalPort) // needs normal
-                            yield return $"SHADERGRAPH_NEEDS_NORMAL_{kvPass.Key.ToUpper()}";
+                            yield return $"SHADERGRAPH_NEEDS_NORMAL_{kvPass.Key.ToUpper(CultureInfo.InvariantCulture)}";
 
                         if (readsTangent || hasNormalPort) // needs tangent
-                            yield return $"SHADERGRAPH_NEEDS_TANGENT_{kvPass.Key.ToUpper()}";
+                            yield return $"SHADERGRAPH_NEEDS_TANGENT_{kvPass.Key.ToUpper(CultureInfo.InvariantCulture)}";
 
                         needsPosWS |= graphCode.requirements.requiresPosition != NeededCoordinateSpace.None ||
                             graphCode.requirements.requiresScreenPosition ||
@@ -429,7 +430,7 @@ public override IEnumerable<KeyValuePair<string, VFXShaderWriter>> additionalRep
                     {
                         var portInfo = shaderGraph.GetOutput(port);
                         if (!string.IsNullOrEmpty(portInfo.referenceName))
-                            yield return new KeyValuePair<string, VFXShaderWriter>($"${{SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper()}}}", new VFXShaderWriter($"{portInfo.referenceName}_{portInfo.id}"));
+                            yield return new KeyValuePair<string, VFXShaderWriter>($"${{SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper(CultureInfo.InvariantCulture)}}}", new VFXShaderWriter($"{portInfo.referenceName}_{portInfo.id}"));
                     }
 
                     foreach (var kvPass in graphCodes)
@@ -442,7 +443,7 @@ public override IEnumerable<KeyValuePair<string, VFXShaderWriter>> additionalRep
                         if (graphCode.requirements.requiresDepthTexture)
                             preProcess.WriteLine("#define REQUIRE_DEPTH_TEXTURE");
                         preProcess.WriteLine("${VFXShaderGraphFunctionsInclude}\n");
-                        yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CODE_" + kvPass.Key.ToUpper() + "}", new VFXShaderWriter(preProcess.ToString() + graphCode.code));
+                        yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CODE_" + kvPass.Key.ToUpper(CultureInfo.InvariantCulture) + "}", new VFXShaderWriter(preProcess.ToString() + graphCode.code));
 
                         var callSG = new VFXShaderWriter("//Call Shader Graph\n");
                         callSG.builder.AppendLine($"{shaderGraph.inputStructName} INSG = ({shaderGraph.inputStructName})0;");
@@ -563,7 +564,7 @@ public override IEnumerable<KeyValuePair<string, VFXShaderWriter>> additionalRep
 #endif");
                         }
 
-                        yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CALL_" + kvPass.Key.ToUpper() + "}", callSG);
+                        yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CALL_" + kvPass.Key.ToUpper(CultureInfo.InvariantCulture) + "}", callSG);
                     }
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using System.Collections.Generic;`
`4`	`4`	`using UnityEngine;`
`5`	`5`	`using UnityEngine.VFX;`
	`6`	`+using System.Globalization;`
`6`	`7`
`7`	`8`	`namespace UnityEditor.VFX.Block`
`8`	`9`	`{`
`@@ -213,7 +214,7 @@ protected override IEnumerable<string> filteredOutSettings`
`213`	`214`
`214`	`215`	`static private string GenerateLocalAttributeName(string name)`
`215`	`216`	`{`
`216`		`- return name[0].ToString().ToUpper() + name.Substring(1);`
	`217`	`+ return name[0].ToString().ToUpper(CultureInfo.InvariantCulture) + name.Substring(1);`
`217`	`218`	`}`
`218`	`219`
`219`	`220`	`public override string source`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`using System.Collections.Generic;`
`5`	`5`	`using UnityEngine;`
`6`	`6`	`using UnityEngine.VFX;`
	`7`	`+using System.Globalization;`
`7`	`8`
`8`	`9`	`namespace UnityEditor.VFX.Block`
`9`	`10`	`{`
`@@ -188,7 +189,7 @@ public override IEnumerable<VFXAttributeInfo> attributes`
`188`	`189`
`189`	`190`	`static private string GenerateLocalAttributeName(string name)`
`190`	`191`	`{`
`191`		`- return name[0].ToString().ToUpper() + name.Substring(1);`
	`192`	`+ return name[0].ToString().ToUpper(CultureInfo.InvariantCulture) + name.Substring(1);`
`192`	`193`	`}`
`193`	`194`
`194`	`195`	`public override string source`
`@@ -306,7 +307,7 @@ protected override IEnumerable<VFXPropertyWithValue> inputProperties`
`306`	`307`	`var attrib = currentAttribute;`
`307`	`308`
`308`	`309`	`VFXPropertyAttributes attr = new VFXPropertyAttributes();`
`309`		`- var field = typeof(VFXAttribute).GetField(attrib.name.Substring(0, 1).ToUpper() + attrib.name.Substring(1), System.Reflection.BindingFlags.Static \| System.Reflection.BindingFlags.Public);`
	`310`	`+ var field = typeof(VFXAttribute).GetField(attrib.name.Substring(0, 1).ToUpper(CultureInfo.InvariantCulture) + attrib.name.Substring(1), System.Reflection.BindingFlags.Static \| System.Reflection.BindingFlags.Public);`
`310`	`311`
`311`	`312`	`TooltipAttribute tooltip = null;`
`312`	`313`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using System.Globalization;`
`3`	`4`	`using System.Linq;`
`4`	`5`	`using System.Reflection;`
`5`	`6`	`using UnityEditor.ShaderGraph;`
`@@ -269,7 +270,7 @@ public override IEnumerable<string> additionalDefines`
`269`	`270`	`{`
`270`	`271`	`var portInfo = shaderGraph.GetOutput(port);`
`271`	`272`	`if (!string.IsNullOrEmpty(portInfo.referenceName))`
`272`		`- yield return $"HAS_SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper()}";`
	`273`	`+ yield return $"HAS_SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper(CultureInfo.InvariantCulture)}";`
`273`	`274`	`}`
`274`	`275`
`275`	`276`	`bool needsPosWS = false;`
`@@ -289,10 +290,10 @@ public override IEnumerable<string> additionalDefines`
`289`	`290`	`bool hasNormalPort = pixelPorts.Any(t => t == ShaderGraphVfxAsset.NormalSlotId) && shaderGraph.HasOutput(ShaderGraphVfxAsset.NormalSlotId);`
`290`	`291`
`291`	`292`	`if (readsNormal \|\| readsTangent \|\| hasNormalPort) // needs normal`
`292`		`- yield return $"SHADERGRAPH_NEEDS_NORMAL_{kvPass.Key.ToUpper()}";`
	`293`	`+ yield return $"SHADERGRAPH_NEEDS_NORMAL_{kvPass.Key.ToUpper(CultureInfo.InvariantCulture)}";`
`293`	`294`
`294`	`295`	`if (readsTangent \|\| hasNormalPort) // needs tangent`
`295`		`- yield return $"SHADERGRAPH_NEEDS_TANGENT_{kvPass.Key.ToUpper()}";`
	`296`	`+ yield return $"SHADERGRAPH_NEEDS_TANGENT_{kvPass.Key.ToUpper(CultureInfo.InvariantCulture)}";`
`296`	`297`
`297`	`298`	`needsPosWS \|= graphCode.requirements.requiresPosition != NeededCoordinateSpace.None \|\|`
`298`	`299`	`graphCode.requirements.requiresScreenPosition \|\|`
`@@ -429,7 +430,7 @@ public override IEnumerable<KeyValuePair<string, VFXShaderWriter>> additionalRep`
`429`	`430`	`{`
`430`	`431`	`var portInfo = shaderGraph.GetOutput(port);`
`431`	`432`	`if (!string.IsNullOrEmpty(portInfo.referenceName))`
`432`		`- yield return new KeyValuePair<string, VFXShaderWriter>($"${{SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper()}}}", new VFXShaderWriter($"{portInfo.referenceName}_{portInfo.id}"));`
	`433`	`+ yield return new KeyValuePair<string, VFXShaderWriter>($"${{SHADERGRAPH_PARAM_{portInfo.referenceName.ToUpper(CultureInfo.InvariantCulture)}}}", new VFXShaderWriter($"{portInfo.referenceName}_{portInfo.id}"));`
`433`	`434`	`}`
`434`	`435`
`435`	`436`	`foreach (var kvPass in graphCodes)`
`@@ -442,7 +443,7 @@ public override IEnumerable<KeyValuePair<string, VFXShaderWriter>> additionalRep`
`442`	`443`	`if (graphCode.requirements.requiresDepthTexture)`
`443`	`444`	`preProcess.WriteLine("#define REQUIRE_DEPTH_TEXTURE");`
`444`	`445`	`preProcess.WriteLine("${VFXShaderGraphFunctionsInclude}\n");`
`445`		`- yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CODE_" + kvPass.Key.ToUpper() + "}", new VFXShaderWriter(preProcess.ToString() + graphCode.code));`
	`446`	`+ yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CODE_" + kvPass.Key.ToUpper(CultureInfo.InvariantCulture) + "}", new VFXShaderWriter(preProcess.ToString() + graphCode.code));`
`446`	`447`
`447`	`448`	`var callSG = new VFXShaderWriter("//Call Shader Graph\n");`
`448`	`449`	`callSG.builder.AppendLine($"{shaderGraph.inputStructName} INSG = ({shaderGraph.inputStructName})0;");`
`@@ -563,7 +564,7 @@ public override IEnumerable<KeyValuePair<string, VFXShaderWriter>> additionalRep`
`563`	`564`	`#endif");`
`564`	`565`	`}`
`565`	`566`
`566`		`- yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CALL_" + kvPass.Key.ToUpper() + "}", callSG);`
	`567`	`+ yield return new KeyValuePair<string, VFXShaderWriter>("${SHADERGRAPH_PIXEL_CALL_" + kvPass.Key.ToUpper(CultureInfo.InvariantCulture) + "}", callSG);`
`567`	`568`	`}`
`568`	`569`	`}`
`569`	`570`	`}`