[msbuild] Add support for Metal in the simulator. Fixes #7392. (#7983) (

#7991) * [msbuild] Provide the correct value for the operating system for tvOS and watchOS to a few tasks. Fixes #6200. (#7226) The problem with #6200 was that we'd pass -mios-version-min=x.y to the metal tool even for tvOS apps. This fixes it so that now pass -mtvos-version-min. Fixes #6200. * [msbuild] Add support for Metal in the simulator. Fixes #7392. (#7983)
xamarin · Feb 28, 2020 · ad15106 · ad15106 · xamarin-release-manager · Feb 29, 2020
1 parent fe45149
commit ad15106
Show file tree

Hide file tree

Showing 46 changed files with 1,390 additions and 39 deletions.
diff --git a/msbuild/Xamarin.Mac.Tasks/Tasks/CompileSceneKitAssets.cs b/msbuild/Xamarin.Mac.Tasks/Tasks/CompileSceneKitAssets.cs
@@ -4,8 +4,5 @@ namespace Xamarin.Mac.Tasks
 {
 	public class CompileSceneKitAssets : CompileSceneKitAssetsTaskBase
 	{
-		protected override string OperatingSystem {
-			get { return "osx"; }
-		}
 	}
 }
diff --git a/msbuild/Xamarin.Mac.Tasks/Tasks/Metal.cs b/msbuild/Xamarin.Mac.Tasks/Tasks/Metal.cs
@@ -6,10 +6,6 @@ namespace Xamarin.Mac.Tasks
 {
 	public class Metal : MetalTaskBase
 	{
-		protected override string OperatingSystem {
-			get { return "macosx"; }
-		}
-
 #if !MTOUCH_TESTS
 		protected override string MinimumDeploymentTargetKey {
 			get { return ManifestKeys.LSMinimumSystemVersion; }

diff --git a/msbuild/Xamarin.Mac.Tasks/Tasks/ScnTool.cs b/msbuild/Xamarin.Mac.Tasks/Tasks/ScnTool.cs
@@ -4,8 +4,5 @@ namespace Xamarin.Mac.Tasks
 {
 	public class ScnTool : ScnToolTaskBase
 	{
-		protected override string OperatingSystem {
-			get { return "osx"; }
-		}
 	}
 }
diff --git a/msbuild/Xamarin.Mac.Tasks/Xamarin.Mac.Common.targets b/msbuild/Xamarin.Mac.Tasks/Xamarin.Mac.Common.targets
@@ -340,8 +340,10 @@ Copyright (C) 2014 Xamarin. All rights reserved.
 			IntermediateOutputPath="$(IntermediateOutputPath)"
 			AppManifest="$(_AppManifest)"
 			ProjectDir="$(MSBuildProjectDirectory)"
+			TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
 			ResourcePrefix="$(XamMacResourcePrefix)"
 			SdkDevPath="$(_SdkDevPath)"
+			SdkIsSimulator="false"
 			SdkRoot="$(_SdkRoot)"
 			SdkVersion="$(MacOSXSdkVersion)"
 			SourceFile="@(Metal)">
@@ -588,6 +590,7 @@ Copyright (C) 2014 Xamarin. All rights reserved.
 			SdkRoot="$(_SdkRoot)"
 			SdkDevPath="$(_SdkDevPath)"
 			SdkVersion="$(MacOSXSdkVersion)"
+			TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
 			IntermediateOutputPath="$(IntermediateOutputPath)"
 			InputScene="%(_ColladaAssetWithLogicalName.Identity)"
 			OutputScene="$(IntermediateOutputPath)%(_ColladaAssetWithLogicalName.LogicalName)">
@@ -675,6 +678,7 @@ Copyright (C) 2014 Xamarin. All rights reserved.
 			ToolPath="$(CopySceneKitAssetsPath)"
 			SceneKitAssets="@(SceneKitAsset)"
 			IntermediateOutputPath="$(IntermediateOutputPath)"
+			TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
 			ProjectDir="$(MSBuildProjectDirectory)"
 			ResourcePrefix="$(XamMacResourcePrefix)"
 			SdkPlatform="MacOSX"

diff --git a/msbuild/Xamarin.MacDev.Tasks.Core/PlatformFramework.cs b/msbuild/Xamarin.MacDev.Tasks.Core/PlatformFramework.cs
@@ -54,5 +54,22 @@ public static PlatformFramework GetFramework (string targetFrameworkIdentifier)
 				throw new InvalidOperationException ("Unknown TargetFrameworkIdentifier: " + targetFrameworkIdentifier);
 			}
 		}
+
+		public static string GetOperatingSystem (string targetFrameworkIdentifier)
+		{
+			var framework = PlatformFrameworkHelper.GetFramework (targetFrameworkIdentifier);
+			switch (framework) {
+			case PlatformFramework.WatchOS:
+				return "watchos";
+			case PlatformFramework.TVOS:
+				return "tvos";
+			case PlatformFramework.MacOS:
+				return "osx";
+			case PlatformFramework.iOS:
+				return "ios";
+			default:
+				throw new InvalidOperationException (string.Format ("Unknown target framework {0} for target framework identifier {2}.", framework, targetFrameworkIdentifier));
+			}
+		}
 	}
 }
diff --git a/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/CompileSceneKitAssetsTaskBase.cs b/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/CompileSceneKitAssetsTaskBase.cs
@@ -47,6 +47,9 @@ public abstract class CompileSceneKitAssetsTaskBase : Task
 		[Required]
 		public string SdkVersion { get; set; }
 
+		[Required]
+		public string TargetFrameworkIdentifier { get; set; }
+
 		public string ToolExe {
 			get { return toolExe ?? ToolName; }
 			set { toolExe = value; }
@@ -67,8 +70,10 @@ static string ToolName {
 			get { return "copySceneKitAssets"; }
 		}
 
-		protected abstract string OperatingSystem {
-			get;
+		protected virtual string OperatingSystem {
+			get {
+				return PlatformFrameworkHelper.GetOperatingSystem (TargetFrameworkIdentifier);
+			}
 		}
 
 		string DeveloperRootBinDir {

diff --git a/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/MetalTaskBase.cs b/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/MetalTaskBase.cs
@@ -33,12 +33,18 @@ public abstract class MetalTaskBase : ToolTask
 		[Required]
 		public string SdkVersion { get; set; }
 
+		[Required]
+		public bool SdkIsSimulator { get; set; }
+
 		[Required]
 		public string SdkRoot { get; set; }
 
 		[Required]
 		public ITaskItem SourceFile { get; set; }
 
+		[Required]
+		public string TargetFrameworkIdentifier { get; set; }
+
 		#endregion
 
 		[Output]
@@ -48,8 +54,22 @@ protected abstract string MinimumDeploymentTargetKey {
 			get;
 		}
 
-		protected abstract string OperatingSystem {
-			get;
+		protected virtual string OperatingSystem {
+			get {
+				switch (PlatformFrameworkHelper.GetFramework (TargetFrameworkIdentifier)) {
+				case PlatformFramework.WatchOS:
+					return SdkIsSimulator ? "watchos-simulator" : "watchos";
+				case PlatformFramework.TVOS:
+					return SdkIsSimulator ? "tvos-simulator" : "tvos";
+				case PlatformFramework.MacOS:
+					return "macosx";
+				case PlatformFramework.iOS:
+					return SdkIsSimulator ? "iphonesimulator" : "ios";
+				default:
+					Log.LogError ($"Unknown target framework identifier: {TargetFrameworkIdentifier}.");
+					return string.Empty;
+				}
+			}
 		}
 
 		protected abstract string DevicePlatformBinDir {

diff --git a/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/ScnToolTaskBase.cs b/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/ScnToolTaskBase.cs
@@ -39,14 +39,19 @@ public string SdkDevPath {
 			}
 		}
 
+		[Required]
+		public string TargetFrameworkIdentifier { get; set; }
+
 		#endregion
 
 		string DevicePlatformBinDir {
 			get { return Path.Combine (SdkDevPath, "usr", "bin"); }
 		}
 
-		protected abstract string OperatingSystem {
-			get;
+		protected virtual string OperatingSystem {
+			get {
+				return PlatformFrameworkHelper.GetOperatingSystem (TargetFrameworkIdentifier);
+			}
 		}
 
 		protected override string ToolName {

diff --git a/msbuild/Xamarin.iOS.Tasks.Core/Tasks/CompileSceneKitAssetsTaskBase.cs b/msbuild/Xamarin.iOS.Tasks.Core/Tasks/CompileSceneKitAssetsTaskBase.cs
@@ -2,8 +2,5 @@
 {
 	public abstract class CompileSceneKitAssetsTaskBase : Xamarin.MacDev.Tasks.CompileSceneKitAssetsTaskBase
 	{
-		protected override string OperatingSystem {
-			get { return "ios"; }
-		}
 	}
 }
diff --git a/msbuild/Xamarin.iOS.Tasks.Core/Tasks/MetalTaskBase.cs b/msbuild/Xamarin.iOS.Tasks.Core/Tasks/MetalTaskBase.cs
@@ -6,10 +6,6 @@ namespace Xamarin.iOS.Tasks
 {
 	public abstract class MetalTaskBase : Xamarin.MacDev.Tasks.MetalTaskBase
 	{
-		protected override string OperatingSystem {
-			get { return "ios"; }
-		}
-
 		protected override string MinimumDeploymentTargetKey {
 			get { return ManifestKeys.MinimumOSVersion; }
 		}

diff --git a/msbuild/Xamarin.iOS.Tasks.Core/Tasks/ScnToolTaskBase.cs b/msbuild/Xamarin.iOS.Tasks.Core/Tasks/ScnToolTaskBase.cs
@@ -2,8 +2,5 @@
 {
 	public abstract class ScnToolTaskBase : Xamarin.MacDev.Tasks.ScnToolTaskBase
 	{
-		protected override string OperatingSystem {
-			get { return "ios"; }
-		}
 	}
 }
diff --git a/msbuild/Xamarin.iOS.Tasks.Core/Xamarin.iOS.Common.targets b/msbuild/Xamarin.iOS.Tasks.Core/Xamarin.iOS.Common.targets
@@ -595,16 +595,16 @@ Copyright (C) 2013-2016 Xamarin. All rights reserved.
 	</Target>
 
 	<Target Name="_SmeltMetal" Condition="'$(_CanOutputAppBundle)' == 'true' And '@(Metal)' != ''" DependsOnTargets="_DetectSdkLocations">
-		<Error Condition="'$(ComputedPlatform)' == 'iPhoneSimulator'" Text="The iOS Simulator does not support metal. Build for a device instead."/>
-
 		<Metal
 			SessionId="$(BuildSessionId)"
 			Condition="'$(IsMacEnabled)' == 'true' and '%(Metal.Identity)' != ''"
 			IntermediateOutputPath="$(DeviceSpecificIntermediateOutputPath)"
 			AppManifest="$(_AppManifest)"
 			ProjectDir="$(MSBuildProjectDirectory)"
+			TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
 			ResourcePrefix="$(IPhoneResourcePrefix)"
 			SdkDevPath="$(_SdkDevPath)"
+			SdkIsSimulator="$(_SdkIsSimulator)"
 			SdkRoot="$(_SdkRoot)"
 			SdkVersion="$(MtouchSdkVersion)"
 			SourceFile="@(Metal)">
@@ -1220,6 +1220,7 @@ Copyright (C) 2013-2016 Xamarin. All rights reserved.
 			SdkRoot="$(_SdkRoot)"
 			SdkDevPath="$(_SdkDevPath)"
 			SdkVersion="$(MtouchSdkVersion)"
+			TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
 			IntermediateOutputPath="$(DeviceSpecificIntermediateOutputPath)"
 			InputScene="%(_ColladaAssetWithLogicalName.Identity)"
 			OutputScene="$(DeviceSpecificIntermediateOutputPath)%(_ColladaAssetWithLogicalName.LogicalName)">
@@ -1333,6 +1334,7 @@ Copyright (C) 2013-2016 Xamarin. All rights reserved.
 			ToolPath="$(CopySceneKitAssetsPath)"
 			SceneKitAssets="@(SceneKitAsset)"
 			IntermediateOutputPath="$(DeviceSpecificIntermediateOutputPath)"
+			TargetFrameworkIdentifier="$(TargetFrameworkIdentifier)"
 			ProjectDir="$(MSBuildProjectDirectory)"
 			ResourcePrefix="$(IPhoneResourcePrefix)"
 			IsWatchApp="$(IsWatchApp)"

diff --git a/msbuild/tests/MyMetalGame/GameViewController.cs b/msbuild/tests/MyMetalGame/GameViewController.cs
@@ -208,6 +208,8 @@ void SetupRenderPassDescriptorForTexture (IMTLTexture texture)
 				//  If we need a depth texture and don't have one, or if the depth texture we have is the wrong size
 				//  Then allocate one of the proper size
 				MTLTextureDescriptor desc = MTLTextureDescriptor.CreateTexture2DDescriptor (MTLPixelFormat.Depth32Float, texture.Width, texture.Height, false);
+				if (ObjCRuntime.Runtime.Arch == ObjCRuntime.Arch.SIMULATOR)
+					desc.StorageMode = MTLStorageMode.Private;
 				depthTex = device.CreateTexture (desc);
 				depthTex.Label = "Depth";
 

diff --git a/msbuild/tests/MyMetalGame/MyMetalGame.sln b/msbuild/tests/MyMetalGame/MyMetalGame.sln
@@ -0,0 +1,23 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio 15
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MyMetalGame", "MyMetalGame.csproj", "{4598E620-3F15-4F66-B01A-B7F9E45CE659}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|iPhoneSimulator = Debug|iPhoneSimulator
+		Release|iPhoneSimulator = Release|iPhoneSimulator
+		Debug|iPhone = Debug|iPhone
+		Release|iPhone = Release|iPhone
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Debug|iPhoneSimulator.ActiveCfg = Debug|iPhoneSimulator
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Debug|iPhoneSimulator.Build.0 = Debug|iPhoneSimulator
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Release|iPhoneSimulator.ActiveCfg = Release|iPhoneSimulator
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Release|iPhoneSimulator.Build.0 = Release|iPhoneSimulator
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Debug|iPhone.ActiveCfg = Debug|iPhone
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Debug|iPhone.Build.0 = Debug|iPhone
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Release|iPhone.ActiveCfg = Release|iPhone
+		{4598E620-3F15-4F66-B01A-B7F9E45CE659}.Release|iPhone.Build.0 = Release|iPhone
+	EndGlobalSection
+EndGlobal
diff --git a/msbuild/tests/MyTVMetalGame/AppDelegate.cs b/msbuild/tests/MyTVMetalGame/AppDelegate.cs
@@ -0,0 +1,56 @@
+using Foundation;
+using UIKit;
+
+namespace MyTVMetalGame {
+	// The UIApplicationDelegate for the application. This class is responsible for launching the
+	// User Interface of the application, as well as listening (and optionally responding) to application events from iOS.
+	[Register ("AppDelegate")]
+	public class AppDelegate : UIApplicationDelegate {
+		// class-level declarations
+
+		public override UIWindow Window {
+			get;
+			set;
+		}
+
+		public override bool FinishedLaunching (UIApplication application, NSDictionary launchOptions)
+		{
+			// Override point for customization after application launch.
+			// If not required for your application you can safely delete this method
+
+			return true;
+		}
+
+		public override void OnResignActivation (UIApplication application)
+		{
+			// Invoked when the application is about to move from active to inactive state.
+			// This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) 
+			// or when the user quits the application and it begins the transition to the background state.
+			// Games should use this method to pause the game.
+		}
+
+		public override void DidEnterBackground (UIApplication application)
+		{
+			// Use this method to release shared resources, save user data, invalidate timers and store the application state.
+			// If your application supports background exection this method is called instead of WillTerminate when the user quits.
+		}
+
+		public override void WillEnterForeground (UIApplication application)
+		{
+			// Called as part of the transiton from background to active state.
+			// Here you can undo many of the changes made on entering the background.
+		}
+
+		public override void OnActivated (UIApplication application)
+		{
+			// Restart any tasks that were paused (or not yet started) while the application was inactive. 
+			// If the application was previously in the background, optionally refresh the user interface.
+		}
+
+		public override void WillTerminate (UIApplication application)
+		{
+			// Called when the application is about to terminate. Save data, if needed. See also DidEnterBackground.
+		}
+	}
+}
+
diff --git a/...andassets/App Icon - Large.imagestack/Back.imagestacklayer/Content.imageset/Contents.json b/...andassets/App Icon - Large.imagestack/Back.imagestacklayer/Content.imageset/Contents.json
@@ -0,0 +1,54 @@
+{
+  "images": [
+    {
+      "idiom": "universal"
+    },
+    {
+      "scale": "1x",
+      "idiom": "universal"
+    },
+    {
+      "scale": "2x",
+      "idiom": "universal"
+    },
+    {
+      "scale": "3x",
+      "idiom": "universal"
+    },
+    {
+      "idiom": "iphone"
+    },
+    {
+      "scale": "1x",
+      "idiom": "iphone"
+    },
+    {
+      "scale": "2x",
+      "idiom": "iphone"
+    },
+    {
+      "subtype": "retina4",
+      "scale": "2x",
+      "idiom": "iphone"
+    },
+    {
+      "scale": "3x",
+      "idiom": "iphone"
+    },
+    {
+      "idiom": "ipad"
+    },
+    {
+      "scale": "1x",
+      "idiom": "ipad"
+    },
+    {
+      "scale": "2x",
+      "idiom": "ipad"
+    }
+  ],
+  "info": {
+    "version": 1,
+    "author": "xcode"
+  }
+}
diff --git a/...op Shelf Image.brandassets/App Icon - Large.imagestack/Back.imagestacklayer/Contents.json b/...op Shelf Image.brandassets/App Icon - Large.imagestack/Back.imagestacklayer/Contents.json
@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "version" : 1,
+    "author" : "xcode"
+  }
+}