Class DeclaringPass

Namespace

nadena.dev.ndmf.fluent

Fluent context type used to declare constraints on the execution order of passes.

sequence.Run(typeof(MyPass))      // returns DeclaringPass
  .BeforePass(typeof(OtherPass)); // valid only on DeclaringPass
  .Then.Run(typeof(OtherPass));

public sealed class DeclaringPass

Inheritance

object

DeclaringPass

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Then

Returns the original sequence that returned this DeclaringPass. This is useful for chaining multiple pass declarations, like so:

InPhase(Generating)
  .Run(typeof(PassOne))
  .Then.Run(typeof(PassTwo));

public Sequence Then { get; }

Property Value

Sequence

Methods

BeforePass(string, string, int)

Declares that the pass you just declared must run after a particular other pass.

It's recommended to avoid using this to refer to passes in other plugins, as the internal class names of those plugins may not be a stable API.

public DeclaringPass BeforePass(string qualifiedName, string sourceFile = "", int sourceLine = 0)

Parameters

qualifiedName string

sourceFile string

sourceLine int

Returns

DeclaringPass

BeforePass<T>(T, string, int)

Declares that the pass you just declared must run before a particular other pass.

public DeclaringPass BeforePass<T>(T pass, string sourceFile = "", int sourceLine = 0) where T : Pass<T>, new()

Parameters

pass T

sourceFile string

sourceLine int

Returns

DeclaringPass

This DeclaringPass context

Type Parameters

T

BeforePlugin(string, string, int)

Declares that the pass you just declared must run before a particular other plugin.

It's recommended to avoid using this to refer to passes in other plugins, as the internal class names of those plugins may not be a stable API.

public DeclaringPass BeforePlugin(string QualifiedName, string sourceFile = "", int sourceLine = 0)

Parameters

QualifiedName string

The qualified name of the other plugin

sourceFile string

sourceLine int

Returns

DeclaringPass

This DeclaringPass context

BeforePlugin<T>(T, string, int)

Declares that the pass you just declared must run before a particular other plugin.

public DeclaringPass BeforePlugin<T>(T plugin, string sourceFile = "", int sourceLine = 0) where T : Plugin<T>, new()

Parameters

plugin T

sourceFile string

sourceLine int

Returns

DeclaringPass

This DeclaringPass context

Type Parameters

T

PreviewingWith(params IRenderFilter[])

public DeclaringPass PreviewingWith(params IRenderFilter[] filters)

Parameters

filters IRenderFilter[]

Returns

DeclaringPass