Class UwpAppxBuildTools

Inheritance

Object

UwpAppxBuildTools

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Microsoft.MixedReality.Toolkit.Build.Editor

Assembly: cs.temp.dll.dll

Syntax

public static class UwpAppxBuildTools

Properties

IsBuilding

Query the build process to see if we're already building.

Declaration

public static bool IsBuilding { get; }

Property Value

Type	Description
Boolean

IsBuilding

Query the build process to see if we're already building.

Declaration

public static bool IsBuilding { get; }

Property Value

Type	Description
Boolean

Methods

AddCapabilities(IBuildInfo, XElement)

Adds capabilities according to the values in the buildInfo to the manifest file.

Declaration

public static void AddCapabilities(IBuildInfo buildInfo, XElement rootElement = null)

Parameters

Type	Name	Description
IBuildInfo	buildInfo	An IBuildInfo containing a valid OutputDirectory and all capabilities
XElement	rootElement

AddCapabilities(IBuildInfo, XElement)

Adds capabilities according to the values in the buildInfo to the manifest file.

Declaration

public static void AddCapabilities(IBuildInfo buildInfo, XElement rootElement = null)

Parameters

Type	Name	Description
IBuildInfo	buildInfo	An IBuildInfo containing a valid OutputDirectory and all capabilities
XElement	rootElement

AddCapabilities(XElement, List<String>)

Adds the given capabilities to the manifest.

Declaration

public static void AddCapabilities(XElement rootNode, List<string> capabilities)

Parameters

Type	Name	Description
XElement	rootNode
List<String>	capabilities

AddCapability(XElement, XName, String)

Adds a capability to the given rootNode, which must be the read AppX manifest from the build output.

Declaration

public static void AddCapability(XElement rootNode, XName capability, string value)

Parameters

Type	Name	Description
XElement	rootNode	An XElement containing the AppX manifest from the build output
XName	capability	The added capabilities tag as XName
String	value	Value of the Name-XAttribute of the added capability

AddCapability(XElement, XName, String)

Adds a capability to the given rootNode, which must be the read AppX manifest from the build output.

Declaration

public static void AddCapability(XElement rootNode, XName capability, string value)

Parameters

Type	Name	Description
XElement	rootNode	An XElement containing the AppX manifest from the build output
XName	capability	The added capabilities tag as XName
String	value	Value of the Name-XAttribute of the added capability

AddGazeInputCapability(XElement)

Adds the 'Gaze Input' capability to the manifest.

Declaration

public static void AddGazeInputCapability(XElement rootNode)

Parameters

Type	Name	Description
XElement	rootNode

Remarks

This is a workaround for versions of Unity which don't have native support for the 'Gaze Input' capability in its Player Settings preference location. Note that this function is only public to poke a hole for testing - do not take a dependency on this function.

AddGazeInputCapability(XElement)

Adds the 'Gaze Input' capability to the manifest.

Declaration

public static void AddGazeInputCapability(XElement rootNode)

Parameters

Type	Name	Description
XElement	rootNode

Remarks

This is a workaround for versions of Unity which don't have native support for the 'Gaze Input' capability in its Player Settings preference location. Note that this function is only public to poke a hole for testing - do not take a dependency on this function.

AddResearchModeCapability(XElement)

Adds the 'Research Mode' capability to the manifest.

Declaration

public static void AddResearchModeCapability(XElement rootNode)

Parameters

Type	Name	Description
XElement	rootNode

Remarks

This is only for research projects and should not be used in production. For further information take a look at https://docs.microsoft.com/windows/mixed-reality/research-mode. Note that this function is only public to poke a hole for testing - do not take a dependency on this function.

AddResearchModeCapability(XElement)

Adds the 'Research Mode' capability to the manifest.

Declaration

public static void AddResearchModeCapability(XElement rootNode)

Parameters

Type	Name	Description
XElement	rootNode

Remarks

This is only for research projects and should not be used in production. For further information take a look at https://docs.microsoft.com/windows/mixed-reality/research-mode. Note that this function is only public to poke a hole for testing - do not take a dependency on this function.

AllowUnsafeCode(XElement)

Enables unsafe code in the generated Assembly-CSharp project.

Declaration

public static void AllowUnsafeCode(XElement rootNode)

Parameters

Type	Name	Description
XElement	rootNode

Remarks

This is not required by the research mode, but not using unsafe code with direct memory access results in poor performance. So its kinda recommended to use unsafe code. For further information take a look at https://docs.microsoft.com/windows/mixed-reality/research-mode. Note that this function is only public to poke a hole for testing - do not take a dependency on this function.

AllowUnsafeCode(XElement)

Enables unsafe code in the generated Assembly-CSharp project.

Declaration

public static void AllowUnsafeCode(XElement rootNode)

Parameters

Type	Name	Description
XElement	rootNode

Remarks

This is not required by the research mode, but not using unsafe code with direct memory access results in poor performance. So its kinda recommended to use unsafe code. For further information take a look at https://docs.microsoft.com/windows/mixed-reality/research-mode. Note that this function is only public to poke a hole for testing - do not take a dependency on this function.

BuildAppxAsync(UwpBuildInfo, CancellationToken)

Build the UWP appx bundle for this project. Requires that BuildPlayer(String, Boolean, CancellationToken) has already be run or a user has previously built the Unity Player with the WSA Player as the Build Target.

Declaration

public static Task<bool> BuildAppxAsync(UwpBuildInfo buildInfo, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
UwpBuildInfo	buildInfo
CancellationToken	cancellationToken

Returns

Type	Description
Task<Boolean>	True, if the appx build was successful.

BuildAppxAsync(UwpBuildInfo, CancellationToken)

Build the UWP appx bundle for this project. Requires that BuildPlayer(String, Boolean, CancellationToken) has already be run or a user has previously built the Unity Player with the WSA Player as the Build Target.

Declaration

public static Task<bool> BuildAppxAsync(UwpBuildInfo buildInfo, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
UwpBuildInfo	buildInfo
CancellationToken	cancellationToken

Returns

Type	Description
Task<Boolean>	True, if the appx build was successful.

UpdateAssemblyCSharpProject(IBuildInfo)

Updates 'Assembly-CSharp.csproj' file according to the values set in buildInfo.

Declaration

public static void UpdateAssemblyCSharpProject(IBuildInfo buildInfo)

Parameters

Type	Name	Description
IBuildInfo	buildInfo	An IBuildInfo containing a valid OutputDirectory

Remarks

Only used with the .NET backend in Unity 2018 or older, with Unity C# Projects enabled.

UpdateAssemblyCSharpProject(IBuildInfo)

Updates 'Assembly-CSharp.csproj' file according to the values set in buildInfo.

Declaration

public static void UpdateAssemblyCSharpProject(IBuildInfo buildInfo)

Parameters

Type	Name	Description
IBuildInfo	buildInfo	An IBuildInfo containing a valid OutputDirectory

Remarks

Only used with the .NET backend in Unity 2018 or older, with Unity C# Projects enabled.