Class EffectProcessor

Namespace

Microsoft.Xna.Framework.Content.Pipeline.Processors

Assembly

MonoGame.Framework.Content.Pipeline.dll

Processes a string representation to a platform-specific compiled effect.

[ContentProcessor(DisplayName = "Effect - MonoGame")]
public class EffectProcessor : ContentProcessor<EffectContent, CompiledEffectContent>, IContentProcessor

Inheritance

object

ContentProcessor<EffectContent, CompiledEffectContent>

EffectProcessor

Implements

IContentProcessor

Inherited Members

ContentProcessor<EffectContent, CompiledEffectContent>.Process(EffectContent, ContentProcessorContext)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EffectProcessor()

Initializes a new instance of EffectProcessor.

public EffectProcessor()

Properties

DebugMode

The debug mode for compiling effects.

public virtual EffectProcessorDebugMode DebugMode { get; set; }

Property Value

EffectProcessorDebugMode

The debug mode to use when compiling effects.

Defines

Define assignments for the effect.

public virtual string Defines { get; set; }

Property Value

string

A list of define assignments delimited by semicolons.

Methods

Process(EffectContent, ContentProcessorContext)

Processes the string representation of the specified effect into a platform-specific binary format using the specified context.

public override CompiledEffectContent Process(EffectContent input, ContentProcessorContext context)

Parameters

input EffectContent

The effect string to be processed.

context ContentProcessorContext

Context for the specified processor.

Returns

CompiledEffectContent

A platform-specific compiled binary effect.

Remarks

If you get an error during processing, compilation stops immediately. The effect processor displays an error message. Once you fix the current error, it is possible you may get more errors on subsequent compilation attempts.