TermColor.AnsiTermBuffer< TColor > Class Template Reference

Inheritance diagram for TermColor.AnsiTermBuffer< TColor >:

Collaboration diagram for TermColor.AnsiTermBuffer< TColor >:

Public Member Functions
	AnsiTermBuffer (int width, int height)
void	Clear ()
void	Clear< TColorValue > (char ch, in TColorValue foreground, in TColorValue background)
void	SetChar (int x, int y, char ch)
void	SetForeground< TColorValue > (int x, int y, in TColorValue color)
void	SetBackground< TColorValue > (int x, int y, in TColorValue color)
void	Flush (TextWriter output)
void	Flush (TextWriter output, int offsetX, int offsetY)
Public Member Functions inherited from TermColor.ITerminalBuffer
void	SetPoint< TColorValue > (int x, int y, char ch, in TColorValue foreground, in TColorValue background)

Properties
int	Width [get]
int	Height [get]
Properties inherited from TermColor.ITerminalBuffer
int	Width [get]
int	Height [get]

Detailed Description

Text buffer capable of storing color data. Outputs text formatted with ANSI escape codes.

Template Parameters

TColor

Internal representation of color.

Type Constraints

TColor	:	struct
TColor	:	ANSIColor

Constructor & Destructor Documentation

AnsiTermBuffer()

TermColor.AnsiTermBuffer< TColor >.AnsiTermBuffer ( int  width, int  height  )

inline

Create a new buffer with the given dimensions.

Parameters

width	Number of columns of the buffer.
height	Number of rows of the buffer.

Member Function Documentation

Clear()

void TermColor.AnsiTermBuffer< TColor >.Clear

(

)

Fill the buffer with empty characters and default colors.

Implements TermColor.ITerminalBuffer.

Clear< TColorValue >()

void TermColor.AnsiTermBuffer< TColor >.Clear< TColorValue > ( char  ch, in TColorValue  foreground, in TColorValue  background  )

inline

Fill the buffer with given (char, IColor, IColor) tuple.

Template Parameters

TColorValue

Type of the color.

Parameters

c	The character to clear with.
foreground	Foreground color.
background	Background color.

Implements TermColor.ITerminalBuffer.

Type Constraints

TColorValue

:

IColor

Flush() [1/2]

void TermColor.AnsiTermBuffer< TColor >.Flush ( TextWriter  output )

inline

Forward the contents of the buffer to an output device.

Parameters

output

The output device.

Implements TermColor.ITerminalBuffer.

Flush() [2/2]

void TermColor.AnsiTermBuffer< TColor >.Flush ( TextWriter  output, int  offsetLeft, int  offsetTop  )

inline

Forward the contents of the buffer to an output device at a specific offset.

Parameters

output

The output device.

Implements TermColor.ITerminalBuffer.

SetBackground< TColorValue >()

void TermColor.AnsiTermBuffer< TColor >.SetBackground< TColorValue > ( int  x, int  y, in TColorValue  color  )

inline

Write background color to one point in the buffer. Rows and columns are numbered from the top left starting at zero.

Parameters

x	Column number.
y	Row number.
background	Background color of the character.

Implements TermColor.ITerminalBuffer.

Type Constraints

TColorValue

:

IColor

SetChar()

void TermColor.AnsiTermBuffer< TColor >.SetChar ( int  x, int  y, char  ch  )

inline

Write a character to one point in the buffer. Rows and columns are numbered from the top left starting at zero.

Parameters

x	Column number.
y	Row number.
ch	The character to write.

Implements TermColor.ITerminalBuffer.

SetForeground< TColorValue >()

void TermColor.AnsiTermBuffer< TColor >.SetForeground< TColorValue > ( int  x, int  y, in TColorValue  color  )

inline

Write foreground color to one point in the buffer. Rows and columns are numbered from the top left starting at zero.

Parameters

x	Column number.
y	Row number.
foreground	Foreground color of the character.

Implements TermColor.ITerminalBuffer.

Type Constraints

TColorValue

:

IColor

---

The documentation for this class was generated from the following file:

• AnsiTermBuffer.cs