Class CanvasColor

Canvas writer with color support

Inheritance

object

CanvasColor

Namespace: Terminaux.Writer.FancyWriters

Assembly: Terminaux.dll

Syntax

[Obsolete("This is considered a legacy method of writing this fancy text and will be removed in a future version of Terminaux. Please use its cyclic writer equivalent.")]
public static class CanvasColor

Methods

RenderCanvas(CellOptions[], int, int, int, int, bool, bool)

Renders the canvas

Declaration

public static string RenderCanvas(CellOptions[] pixels, int Left, int Top, int InteriorWidth, int InteriorHeight, bool doubleWidth = true, bool transparent = false)

Parameters

Type	Name	Description
CellOptions[]	pixels	Individual pixels to render
int	Left	Where to place the canvas horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the canvas vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
bool	doubleWidth	Whether this canvas is a double width or a single width canvas
bool	transparent	Whether this canvas is transparent

Returns

Type	Description
string	The rendered canvas

RenderCanvas(CellOptions[], int, int, int, int, Color, bool, bool)

Renders the canvas

Declaration

public static string RenderCanvas(CellOptions[] pixels, int Left, int Top, int InteriorWidth, int InteriorHeight, Color CanvasColor, bool doubleWidth = true, bool transparent = false)

Parameters

Type	Name	Description
CellOptions[]	pixels	Individual pixels to render
int	Left	Where to place the canvas horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the canvas vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
Color	CanvasColor	Canvas color
bool	doubleWidth	Whether this canvas is a double width or a single width canvas
bool	transparent	Whether this canvas is transparent

Returns

Type	Description
string	The rendered canvas

WriteCanvas(CellOptions[], int, int, int, int, bool, bool)

Writes the canvas plainly

Declaration

public static void WriteCanvas(CellOptions[] pixels, int Left, int Top, int InteriorWidth, int InteriorHeight, bool doubleWidth = true, bool transparent = false)

Parameters

Type	Name	Description
CellOptions[]	pixels	Individual pixels to render
int	Left	Where to place the canvas horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the canvas vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
bool	doubleWidth	Whether this canvas is a double width or a single width canvas
bool	transparent	Whether this canvas is transparent

WriteCanvas(CellOptions[], int, int, int, int, Color, bool, bool)

Writes the canvas plainly

Declaration

public static void WriteCanvas(CellOptions[] pixels, int Left, int Top, int InteriorWidth, int InteriorHeight, Color CanvasColor, bool doubleWidth = true, bool transparent = false)

Parameters

Type	Name	Description
CellOptions[]	pixels	Individual pixels to render
int	Left	Where to place the canvas horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the canvas vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
Color	CanvasColor	Canvas color
bool	doubleWidth	Whether this canvas is a double width or a single width canvas
bool	transparent	Whether this canvas is transparent

WriteCanvasPlain(CellOptions[], int, int, int, int, bool, bool)

Writes the canvas plainly

Declaration

public static void WriteCanvasPlain(CellOptions[] pixels, int Left, int Top, int InteriorWidth, int InteriorHeight, bool doubleWidth = true, bool transparent = false)

Parameters

Type	Name	Description
CellOptions[]	pixels	Individual pixels to render
int	Left	Where to place the canvas horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the canvas vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
bool	doubleWidth	Whether this canvas is a double width or a single width canvas
bool	transparent	Whether this canvas is transparent