Skip to content
ConsoleMonster
Class

ConsoleGraphicsExtensions

ConsoleMonster.Graphics

Edit on GitHub
Namespace
ConsoleMonster.Graphics
Assembly
ConsoleMonster.Graphics
Source
ConsoleGraphicsExtensions.cs:17
Modifiers
static

Image and animation extensions alongside ConsoleExporter. External engines stay in this add-on.

Inheritance

  • object
  • ConsoleGraphicsExtensions

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Talks and demos Guide

    Typed PowerShell demos, live presentation and slide-ready PNG, GIF, APNG and MP4 exports.

Methods

public static IReadOnlyList<string> SaveChapterPngs(SessionRecording recording, string directory, GraphicsExportOptions? options = null, CancellationToken cancellationToken = default) #
ConsoleGraphicsExtensions.cs:37

Saves one numbered PNG per chapter. Destination is a directory; chapter labels never become paths.

Parameters

recording ConsoleMonster.Sessions.SessionRecording required
directory string required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional

Returns

IReadOnlyList<string>
SaveGraphics 2 overloads
public static void SaveGraphics(SessionRecording recording, string path, GraphicsFormat format, GraphicsExportOptions? options = null, CancellationToken cancellationToken = default) #
ConsoleGraphicsExtensions.cs:49

Encodes a terminal recording to GIF, APNG or optional ffmpeg MP4. PNG selects the final frame.

Parameters

recording ConsoleMonster.Sessions.SessionRecording required
path string required
format ConsoleMonster.Graphics.GraphicsFormat required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
public static void SaveGraphics(IWidget dashboard, IEnumerable<LiveEvent> events, string path, GraphicsFormat format, GraphicsExportOptions? options = null, CancellationToken cancellationToken = default) #
ConsoleGraphicsExtensions.cs:57

Encodes recorded dashboard events through the existing widget replay engine.

Parameters

dashboard ConsoleMonster.Layout.IWidget required
events System.Collections.Generic.IEnumerable<ConsoleMonster.Live.LiveEvent> required
path string required
format ConsoleMonster.Graphics.GraphicsFormat required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional
cancellationToken System.Threading.CancellationToken = default optional
SavePng 3 overloads
public static void SavePng(CellBuffer frame, string path, GraphicsExportOptions? options = null) #
ConsoleGraphicsExtensions.cs:29

Saves a frame as PNG.

Parameters

frame ConsoleMonster.Canvas.CellBuffer required
path string required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional
public static void SavePng(IWidget widget, string path, GraphicsExportOptions? options = null) #
ConsoleGraphicsExtensions.cs:31

Renders a widget and saves PNG.

Parameters

widget ConsoleMonster.Layout.IWidget required
path string required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional
public static void SavePng(SessionRecording recording, string path, GraphicsExportOptions? options = null, TimeSpan? at = null) #
ConsoleGraphicsExtensions.cs:34

Saves a recording's final frame, or the frame at a source time.

Parameters

recording ConsoleMonster.Sessions.SessionRecording required
path string required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional
at System.TimeSpan? = null optional
ToPng 3 overloads
public static byte[] ToPng(CellBuffer frame, GraphicsExportOptions? options = null) #
ConsoleGraphicsExtensions.cs:19

Encodes a rendered frame as PNG.

Parameters

frame ConsoleMonster.Canvas.CellBuffer required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional

Returns

byte[]
public static byte[] ToPng(IWidget widget, GraphicsExportOptions? options = null) #
ConsoleGraphicsExtensions.cs:22

Renders a widget and encodes PNG.

Parameters

widget ConsoleMonster.Layout.IWidget required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional

Returns

byte[]
public static byte[] ToPng(LiveSession session, GraphicsExportOptions? options = null) #
ConsoleGraphicsExtensions.cs:27

Encodes the latest live-session snapshot as PNG.

Parameters

session ConsoleMonster.Live.LiveSession required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional

Returns

byte[]
public static RgbaImage ToRaster(CellBuffer frame, GraphicsExportOptions? options = null) #
ConsoleGraphicsExtensions.cs:17

Rasterises a frame with the core's geometric glyphs and ChartForgeX typography.

Parameters

frame ConsoleMonster.Canvas.CellBuffer required
options ConsoleMonster.Graphics.GraphicsExportOptions? = null optional

Returns

RgbaImage