mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0releases/2.3.0releases/2.4.0releases/2.5.0releases/2.5.1releases/2.5.2releases/2.5.3
  • Features and Architecture
  • API Documentation

We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

  • API Documentation
Search Results for

    Show / Hide Table of Contents

    Class ReferenceItemInfo

    A common base class for reference items such as C# Projects and DLLs to be added to MSBuild.

    Inheritance
    Object
    ReferenceItemInfo
    CSProjectInfo
    PluginAssemblyInfo
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.MSBuild
    Assembly: cs.temp.dll.dll
    Syntax
    public class ReferenceItemInfo

    Constructors

    ReferenceItemInfo(UnityProjectInfo, Guid, Uri, String)

    Creates a new instance.

    Declaration
    protected ReferenceItemInfo(UnityProjectInfo unityProjectInfo, Guid guid, Uri referencePath, string name)
    Parameters
    Type Name Description
    UnityProjectInfo unityProjectInfo

    Instance of parsed unity project info.

    Guid guid

    The unique Guid of this reference item.

    Uri referencePath

    The output path to the reference item.

    String name

    The name of the reference.

    Properties

    Guid

    Gets the Guid associated with the reference.

    Declaration
    public Guid Guid { get; }
    Property Value
    Type Description
    Guid

    InEditorPlatforms

    Gets a set of platforms supported for the InEditor configuration.

    Declaration
    public IReadOnlyDictionary<BuildTarget, CompilationPlatformInfo> InEditorPlatforms { get; protected set; }
    Property Value
    Type Description
    IReadOnlyDictionary<BuildTarget, CompilationPlatformInfo>
    Remarks

    In the editor, we can support all platforms if it's a pre-defined assembly, or an asmdef with Editor platform checked. Otherwise we fallback to just the platforms specified in the editor.

    Name

    Gets name of the reference item.

    Declaration
    public string Name { get; }
    Property Value
    Type Description
    String

    PlayerPlatforms

    Gets a set of platforms supported for the Player configuration.

    Declaration
    public IReadOnlyDictionary<BuildTarget, CompilationPlatformInfo> PlayerPlatforms { get; protected set; }
    Property Value
    Type Description
    IReadOnlyDictionary<BuildTarget, CompilationPlatformInfo>
    Remarks

    In the player, we support any platform if pre-defined assembly, or the ones explicitly specified in the AsmDef player.

    ReferencePath

    Gets the output path to the reference.

    Declaration
    public Uri ReferencePath { get; }
    Property Value
    Type Description
    Uri

    UnityProjectInfo

    Gets the instance of the parsed project information.

    Declaration
    protected UnityProjectInfo UnityProjectInfo { get; }
    Property Value
    Type Description
    UnityProjectInfo

    Methods

    ToString()

    A much more readable string representation of this reference item info.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    Object.ToString()
    In This Article
    • Constructors
      • ReferenceItemInfo(UnityProjectInfo, Guid, Uri, String)
    • Properties
      • Guid
      • InEditorPlatforms
      • Name
      • PlayerPlatforms
      • ReferencePath
      • UnityProjectInfo
    • Methods
      • ToString()
    Back to top Generated by DocFX