Skip to content
ConsoleMonster

API Reference

Class

ScreenCapture

Edit on GitHub
Namespace ConsoleMonster.Interactive
Assembly ConsoleMonster
Source ScreenCapture.cs:18
Modifiers sealed

Draws prompts, menus and forms into memory instead of the terminal and keeps every frame: for scripted demos, documentation screenshots and exports (ConsoleExporter.ToHtml(capture.LastFrame)). Set it on InteractiveOptions.Capture together with a scripted InteractiveOptions.Input.

Inheritance

  • Object
  • ScreenCapture

Usage

Explore 3 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 2

Accepted by parameters 1

Constructors

public ScreenCapture(Int32 width, Int32 height, Boolean inline = false) #
ScreenCapture.cs:18

Creates a capture of a fixed size.

Parameters

width System.Int32 requiredposition: 0
Width in cells.
height System.Int32 requiredposition: 1
Height in cells.
inline System.Boolean = false optionalposition: 2
Whether prompts draw as they would in the scrollback (true) or on a full screen (false).

Methods

public CellBuffer? FindFrame(String text) #
ScreenCapture.cs:41
Returns: CellBuffer?

The first frame whose text contains a phrase (for picking a screen to export), or null.

Parameters

text System.String requiredposition: 0
The phrase.

Returns

The frame, or null.

Properties

public Int32 Width { get; } #
ScreenCapture.cs:26

Width in cells.

public Int32 Height { get; } #
ScreenCapture.cs:29

Height in cells.

public IReadOnlyList<CellBuffer> Frames { get; } #
ScreenCapture.cs:32

Every frame drawn, in order.

public CellBuffer? LastFrame { get; } #
ScreenCapture.cs:35

The last frame drawn, or null.