Class ContentBuilderParams

Namespace

MonoGame.Framework.Content.Pipeline.Builder

Assembly

MonoGame.Framework.Content.Pipeline.dll

A list of arguments used by ContentBuilder.

Use Parse(params string[]) to acquire the arguments from the passed cli args.

public record ContentBuilderParams : IEquatable<ContentBuilderParams>

Inheritance

object

ContentBuilderParams

Implements

IEquatable<ContentBuilderParams>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ContentBuilderParams()

public ContentBuilderParams()

ContentBuilderParams(ContentBuilderParams)

protected ContentBuilderParams(ContentBuilderParams original)

Parameters

original ContentBuilderParams

Properties

CompressContent

Gets or sets if ContentBuilder should compress each built content file.

public bool CompressContent { get; init; }

Property Value

bool

false by default.

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

GraphicsProfile

Gets or sets the desired graphics profile for ContentBuilder to build the content for.

public GraphicsProfile GraphicsProfile { get; init; }

Property Value

GraphicsProfile

HiDef by default.

IntermediateDirectory

Gets or sets the location for the intermediate files for content build relative to the WorkingDirectory.

public string IntermediateDirectory { get; init; }

Property Value

string

obj/Content by default.

LogLevel

Gets or sets the logging level of information that ContentBuilder will display to console.

public LogLevel LogLevel { get; init; }

Property Value

LogLevel

Info by default.

Mode

Set the mode in which the content builder is run in. See ContentBuilderMode for available modes.

public ContentBuilderMode Mode { get; init; }

Property Value

ContentBuilderMode

None by default.

OutputDirectory

Gets or sets the location for the content output relative to the WorkingDirectory.

public string OutputDirectory { get; init; }

Property Value

string

bin/Content by default.

Platform

Gets or sets the desired platform for ContentBuilder to build the content for.

public TargetPlatform Platform { get; init; }

Property Value

TargetPlatform

DesktopGL by default.

RootedIntermediateDirectory

Gets the rooted location of IntermediateDirectory.

public string RootedIntermediateDirectory { get; }

Property Value

string

RootedOutputDirectory

Gets the rooted location of OutputDirectory.

public string RootedOutputDirectory { get; }

Property Value

string

RootedSourceDirectory

Gets the rooted location of SourceDirectory.

public string RootedSourceDirectory { get; }

Property Value

string

Servers

A list of servers to start up when the Mode is set to Server.

public List<ContentServer> Servers { get; init; }

Property Value

List<ContentServer>

A collection of ContentServer classes found by scaning all referenced assemblies.

SkipClean

Should the content builder skip cleaning up old content cache data after the build is finished in Builder mode.

public bool SkipClean { get; init; }

Property Value

bool

false by default.

SourceDirectory

Gets or sets the location of the content relative to the WorkingDirectory.

public string SourceDirectory { get; init; }

Property Value

string

Content by default.

WorkingDirectory

Gets or sets the working directory of the ContentBuilder.

public string WorkingDirectory { get; init; }

Property Value

string

GetCurrentDirectory() by default.

Methods

Equals(ContentBuilderParams?)

public virtual bool Equals(ContentBuilderParams? other)

Parameters

other ContentBuilderParams

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Parse(params string[])

Parses out the main entry point args into a ContentBuilderParams to be used by ContentBuilder.

public static ContentBuilderParams Parse(params string[] args)

Parameters

args string[]

Arguments passed to the main entry point of the app.

Returns

ContentBuilderParams

ContentBuilderParams containing the parsed arguments, or an empty ContentBuilderParams if no arguments were passed.

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

<Clone>$()

public virtual ContentBuilderParams <Clone>$()

Returns

ContentBuilderParams

Operators

operator ==(ContentBuilderParams?, ContentBuilderParams?)

public static bool operator ==(ContentBuilderParams? left, ContentBuilderParams? right)

Parameters

left ContentBuilderParams

right ContentBuilderParams

Returns

bool

operator !=(ContentBuilderParams?, ContentBuilderParams?)

public static bool operator !=(ContentBuilderParams? left, ContentBuilderParams? right)

Parameters

left ContentBuilderParams

right ContentBuilderParams

Returns

bool