Table of Contents

Class PipelineManager

Namespace
MonoGame.Framework.Content.Pipeline.Builder
Assembly
MonoGame.Framework.Content.Pipeline.dll
public class PipelineManager
Inheritance
PipelineManager
Inherited Members

Constructors

PipelineManager(string, string, string) 

public PipelineManager(string projectDir, string outputDir, string intermediateDir)

Parameters

projectDir string
outputDir string
intermediateDir string

Properties

Assemblies 

public List<string> Assemblies { get; }

Property Value

List<string>

CompressContent

Gets or sets if the content is compressed.

public bool CompressContent { get; set; }

Property Value

bool

Config

The build configuration passed thru to content processors.

public string Config { get; set; }

Property Value

string

ContentStats 

public ContentStatsCollection ContentStats { get; }

Property Value

ContentStatsCollection

IntermediateDirectory 

public string IntermediateDirectory { get; }

Property Value

string

Logger 

public ContentBuildLogger Logger { get; set; }

Property Value

ContentBuildLogger

OutputDirectory 

public string OutputDirectory { get; }

Property Value

string

Platform

The current target platform for which all content is built.

public TargetPlatform Platform { get; set; }

Property Value

TargetPlatform

Profile

The current target graphics profile for which all content is built.

public GraphicsProfile Profile { get; set; }

Property Value

GraphicsProfile

ProjectDirectory 

public string ProjectDirectory { get; }

Property Value

string

RethrowExceptions

If true exceptions thrown from within an importer or processor are caught and then thrown from the context. Default value is true.

public bool RethrowExceptions { get; set; }

Property Value

bool

Methods

AddAssembly(string) 

public void AddAssembly(string assemblyFilePath)

Parameters

assemblyFilePath string

AssignTypeConverter<TType, TTypeConverter>() 

public void AssignTypeConverter<TType, TTypeConverter>()

Type Parameters

TType
TTypeConverter

BuildContent(string, string, string, string, OpaqueDataDictionary) 

public PipelineBuildEvent BuildContent(string sourceFilepath, string outputFilepath = null, string importerName = null, string processorName = null, OpaqueDataDictionary processorParameters = null)

Parameters

sourceFilepath string
outputFilepath string
importerName string
processorName string
processorParameters OpaqueDataDictionary

Returns

PipelineBuildEvent

CleanContent(string, string) 

public void CleanContent(string sourceFilepath, string outputFilepath = null)

Parameters

sourceFilepath string
outputFilepath string

CreateImporter(string) 

public IContentImporter CreateImporter(string name)

Parameters

name string

Returns

IContentImporter

CreateProcessor(string, OpaqueDataDictionary) 

public IContentProcessor CreateProcessor(string name, OpaqueDataDictionary processorParameters)

Parameters

name string
processorParameters OpaqueDataDictionary

Returns

IContentProcessor

FindDefaultProcessor(string) 

public string FindDefaultProcessor(string importer)

Parameters

importer string

Returns

string

FindImporterByExtension(string) 

public string FindImporterByExtension(string ext)

Parameters

ext string

Returns

string

GetAssetName(string, string, string, OpaqueDataDictionary)

Gets an automatic asset name, such as "AssetName_0".

public string GetAssetName(string sourceFileName, string importerName, string processorName, OpaqueDataDictionary processorParameters)

Parameters

sourceFileName string

The source file name.

importerName string

The name of the content importer. Can be null.

processorName string

The name of the content processor. Can be null.

processorParameters OpaqueDataDictionary

The processor parameters. Can be null.

Returns

string

The asset name.

GetImporterAssemblyTimestamp(string) 

public DateTime GetImporterAssemblyTimestamp(string name)

Parameters

name string

Returns

DateTime

GetImporterTypes() 

public Type[] GetImporterTypes()

Returns

Type[]

GetProcessorAssemblyTimestamp(string) 

public DateTime GetProcessorAssemblyTimestamp(string name)

Parameters

name string

Returns

DateTime

GetProcessorDefaultValues(string)

Gets the default values for the content processor parameters.

public OpaqueDataDictionary GetProcessorDefaultValues(string processorName)

Parameters

processorName string

The name of the content processor.

Returns

OpaqueDataDictionary

A dictionary containing the default value for each parameter. Returns null if the content processor has not been created yet.

GetProcessorType(string) 

public Type GetProcessorType(string name)

Parameters

name string

Returns

Type

GetProcessorTypes() 

public Type[] GetProcessorTypes()

Returns

Type[]

ProcessContent(PipelineBuildEvent) 

public object ProcessContent(PipelineBuildEvent pipelineEvent)

Parameters

pipelineEvent PipelineBuildEvent

Returns

object

RegisterContent(string, string, string, string, OpaqueDataDictionary) 

public void RegisterContent(string sourceFilepath, string outputFilepath = null, string importerName = null, string processorName = null, OpaqueDataDictionary processorParameters = null)

Parameters

sourceFilepath string
outputFilepath string
importerName string
processorName string
processorParameters OpaqueDataDictionary

ResolveImporterAndProcessor(string, ref string, ref string) 

public void ResolveImporterAndProcessor(string sourceFilepath, ref string importerName, ref string processorName)

Parameters

sourceFilepath string
importerName string
processorName string

ValidateProcessorParameters(string, OpaqueDataDictionary) 

public OpaqueDataDictionary ValidateProcessorParameters(string name, OpaqueDataDictionary processorParameters)

Parameters

name string
processorParameters OpaqueDataDictionary

Returns

OpaqueDataDictionary
Edit this page