Class ParseCommandGradient

Recolors a glyph.

Inheritance
object
ParseCommandBase
ParseCommandGradient
Inherited Members
Namespace: SadConsole.StringParser
Assembly: SadConsole.dll
Syntax
public sealed class ParseCommandGradient : ParseCommandBase

Constructors

ParseCommandGradient(string)

Creates a new instance of this command.

Declaration
public ParseCommandGradient(string parameters)
Parameters
Type Name Description
string parameters

The string to parse for parameters.

Fields

GradientString

The string to apply to the characters.

Declaration
public ColoredString GradientString
Field Value
Type Description
ColoredString

Length

The length to apply.

Declaration
public int Length
Field Value
Type Description
int

Methods

Build(ref ColoredGlyphAndEffect, ColoredGlyphAndEffect[], int, ICellSurface?, ref int, ReadOnlySpan<char>, ParseCommandStacks)

Builds a glyph.

Declaration
public override void Build(ref ColoredGlyphAndEffect glyphState, ColoredGlyphAndEffect[] glyphString, int surfaceIndex, ICellSurface? surface, ref int stringIndex, ReadOnlySpan<char> processedString, ParseCommandStacks commandStack)
Parameters
Type Name Description
ColoredGlyphAndEffect glyphState

The current glyph being built.
ColoredGlyphAndEffect[] glyphString

The current string of glyphs that has been processed until now.
int surfaceIndex

Where on the surface this glyph will appear.
ICellSurface surface

The surface associated with the glyph.
int stringIndex

Where in the original string this glyph is from.
ReadOnlySpan<char> processedString

The entire string being processed.
ParseCommandStacks commandStack

The state of commands.
Overrides

Extension Methods