Class PipelineComponentScanner

Namespace

Microsoft.Xna.Framework.Content.Pipeline

Assembly

MonoGame.Framework.Content.Pipeline.dll

Implements a scanner object containing the available importers and processors for an application. Designed for internal use only.

public sealed class PipelineComponentScanner

Inheritance

object

PipelineComponentScanner

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PipelineComponentScanner()

Initializes a new instance of PipelineComponentScanner.

public PipelineComponentScanner()

Properties

Errors

Gets the list of error messages produced by the last call to Update.

public IList<string> Errors { get; }

Property Value

IList<string>

ImporterAttributes

Gets a dictionary that maps importer names to their associated metadata attributes.

public IDictionary<string, ContentImporterAttribute> ImporterAttributes { get; }

Property Value

IDictionary<string, ContentImporterAttribute>

ImporterNames

Gets the names of all available importers.

public IEnumerable<string> ImporterNames { get; }

Property Value

IEnumerable<string>

ImporterOutputTypes

Gets a dictionary that maps importer names to the fully qualified name of their return types.

public IDictionary<string, string> ImporterOutputTypes { get; }

Property Value

IDictionary<string, string>

ProcessorAttributes

Gets a dictionary that maps processor names to their associated metadata attributes.

public IDictionary<string, ContentProcessorAttribute> ProcessorAttributes { get; }

Property Value

IDictionary<string, ContentProcessorAttribute>

ProcessorInputTypes

Gets a dictionary that maps processor names to the fully qualified name of supported input types.

public IDictionary<string, string> ProcessorInputTypes { get; }

Property Value

IDictionary<string, string>

ProcessorNames

Gets the names of all available processors.

public IEnumerable<string> ProcessorNames { get; }

Property Value

IEnumerable<string>

ProcessorOutputTypes

Gets a dictionary that maps processor names to the fully qualified name of their output types.

public IDictionary<string, string> ProcessorOutputTypes { get; }

Property Value

IDictionary<string, string>

ProcessorParameters

A collection of supported processor parameters.

public IDictionary<string, ProcessorParameterCollection> ProcessorParameters { get; }

Property Value

IDictionary<string, ProcessorParameterCollection>

Methods

Update(IEnumerable<string>)

Updates the scanner object with the latest available assembly states.

public bool Update(IEnumerable<string> pipelineAssemblies)

Parameters

pipelineAssemblies IEnumerable<string>

Enumerated list of available assemblies.

Returns

bool

true if an actual scan was required, indicating the collection contents may have changed. false if no assembly changes were detected since the previous call.

Update(IEnumerable<string>, IEnumerable<string>)

Updates the scanner object with the latest available assembly states.

public bool Update(IEnumerable<string> pipelineAssemblies, IEnumerable<string> pipelineAssemblyDependencies)

Parameters

pipelineAssemblies IEnumerable<string>

Enumerated list of available assemblies.

pipelineAssemblyDependencies IEnumerable<string>

Enumerated list of dependent assemblies.

Returns

bool

true if an actual scan was required, indicating the collection contents may have changed. false if no assembly changes were detected since the previous call.