Show / Hide Table of Contents

Namespace SadConsole

Classes

Algorithms

Provides a few minor helper methods related to filling.

Algorithms.NodeConnections<TNode>

Describes the 4-way connections of a node.

AnimatedScreenObject

A ScreenObject that displays an animated set of ICellSurface surfaces.

AnimatedScreenObject.AnimationStateChangedEventArgs

Event args for when the animation state changes

CellDecoratorHelpers

Helpers for CellDecorator and Decorators which manages null on the property.

CellSurface

An array of ColoredGlyphBase objects used to represent a 2D surface.

CellSurfaceEditor

Methods to interact with a ICellSurface.

ColoredGlyph

Represents an individual piece of a ICellSurface containing a glyph, foreground color, background color, and a mirror effect.

ColoredGlyphAndEffect

A ColoredGlyphBase with a ICellEffect.

ColoredGlyphBase

Represents an individual piece of a ICellSurface containing a glyph, foreground color, background color, and a mirror effect.

ColoredString

Represents a string that has foreground and background colors for each character in the string.

Console

A surface that has a cursor.

ExtendedLib_StringExtensions2

Extensions for the string type.

ExtendedLib_SurfaceExtensions

Extensions for the IScreenSurface type

ExtensionsSystem

FocusedScreenObjectStack

A stack of screen objects. The top-most of the stack is considered active and represented by the IScreenObject property.

FontExtensions

Extensions for IFont.

Game

The MonoGame implementation of the SadConsole Game Host.

GameHost

Represents the SadConsole game engine.

HandledEventArgs

Event args that allow a handled flag to be set.

Helpers

General code helpers.

LayeredScreenSurface

A basic console that can contain controls.

MonoGame_MirrorExtensions

Extensions for Mirror.

PointExtensions

Extensions for the Point type.

RectangleExtensions

Extensions for the Rectangle type.

SadFont

Represents a graphical font used by SadConsole.

ScreenObject

A generic object processed by SadConsole. Provides parent/child, components, and position.

ScreenObjectCollection

Manages the parent and children relationship for IScreenObject.

ScreenObjectCollection<TScreenObject>

Manages the parent and children relationship for IScreenObject.

ScreenObjectComparer

Compares IScreenObject with the SortOrder property.

ScreenSurface

An object that renders a ICellSurface.

Serializer

Common serialization tasks for SadConsole.

Serializer.Contracts

Registers the default converters for SadConsole objects, when needed.

Serializer.LogTraceWriter

A simple log writer that helps debug the JSON serialization.

Settings

Various settings for SadConsole.

Settings.Input

Settings related to input.

Settings.Rendering

Rendering options generally set by a game host.

ShapeParameters

Defines the parameters for generating a shape with a border and fill glyphs.

SimpleObjectDefinition

StringExtensions

Helpers for strings.

StringValidation

Validates a string

ValueChangedCancelableEventArgs<T>

Event arguments for an event fired when an object's properties are changed. The change can be cancelled.

Structs

CellDecorator

Decorates a cell with a colored glyph.

ColoredGlyphState

A ColoredGlyphBase with state information.

GlyphDefinition

Represents a decorator (glyph and mirror) defined by a font.

StringValidation.Result

The object produced when validating a string.

Interfaces

ICellSurface

An array of ColoredGlyphBase objects used to represent a 2D surface.

ICellSurfaceResize

Adds a method to support resizing a surface.

ICellSurfaceSettable

Adds a method to change the backing cells of a surface.

IFont

Represents a font used by the rendering engine.

IScreenObject

A generic object processed by SadConsole. Provides parent/child, components, position, and input callbacks.

IScreenSurface

A screen object that has mouse input, surface, and render information.

IScreenSurfaceEditable

The same as a IScreenSurface interface, except that it also implements ISurface for convenience.

ISurface

An interface that provides a Surface property that allows the editor extensions to work.

ISurfaceSettable

An interface that provides a Surface property which can be set.

ITexture

Represents a texture provided by a game host.

Enums

AnimatedScreenObject.AnimationState

Represents what state the animation is in.

FocusBehavior

How the console handles becoming focused and added to the FocusedScreenObjects collection.

HorizontalAlignment

Horizontal alignment modes.

ICellSurface.ConnectedLineIndex

Array index enum for line glyphs.

IFont.Sizes

The size options of a font.

Mirror

The mirroring mode

Orientation

Orientation modes.

Settings.WindowResizeOptions

Resize modes for the final SadConsole render pass.

TextureConvertBackgroundStyle

The style applied when Background is set.

TextureConvertForegroundStyle

The style applied when Foreground is set.

TextureConvertMode

The conversion mode from ITexture to ICellSurface.

VerticalAlignment

Vertical alignment modes.

Delegates

StringValidation.Validator

Validates a string value.

In this article

Back to top

Back to top Generated by DocFX