Skip to content
ConsoleMonster

API Reference

Class

BrailleCanvas

Edit on GitHub
Namespace ConsoleMonster.Canvas
Assembly ConsoleMonster
Source BrailleCanvas.cs:22
Base PixelCanvas
Modifiers sealed

A canvas with 2x4 pixels per cell drawn with braille patterns (U+2800-U+28FF). Needs a Full-tier font.

Inheritance

Constructors

public BrailleCanvas(Int32 columns, Int32 rows) #
BrailleCanvas.cs:22

Creates a braille canvas.

Parameters

columns System.Int32 requiredposition: 0
Width in cells.
rows System.Int32 requiredposition: 1
Height in cells.

Methods

public override Void Clear() #
BrailleCanvas.cs:39
Returns: Void

Clears all pixels.

public override Void Render(Region region, Int32 x, Int32 y, RenderContext context) #
BrailleCanvas.cs:45
Returns: Void

Renders the canvas into a region at a local position.

Parameters

region ConsoleMonster.Canvas.Region requiredposition: 0
The region.
x System.Int32 requiredposition: 1
Local column.
y System.Int32 requiredposition: 2
Local row.
context ConsoleMonster.Canvas.RenderContext requiredposition: 3
The render context.
public override Void Set(Int32 x, Int32 y, Color color) #
BrailleCanvas.cs:29
Returns: Void

Sets a pixel. Out-of-range pixels are ignored.

Parameters

x System.Int32 requiredposition: 0
Pixel column (0 = left).
y System.Int32 requiredposition: 1
Pixel row (0 = top).
color ConsoleMonster.Styling.Color requiredposition: 2
The colour; a cell shows the colour of the last pixel set in it.