ScreenSurface Class

Definition

An object that renders a ICellSurface.

[DataContract]
[JsonObject(MemberSerialization.OptIn)]
public class ScreenSurface : ScreenObject, IDisposable, IScreenSurfaceEditable, IScreenSurface, IScreenObject, IPositionable, IComponentHost, ISurface, ISurfaceSettable, ICellSurfaceResize

Inheritance object → ScreenObject

Implements IDisposable, IScreenSurfaceEditable, IScreenSurface, IScreenObject, SadRogue.Primitives.IPositionable, IComponentHost, ISurface, ISurfaceSettable, ICellSurfaceResize

Constructors

ScreenSurface(int, int)

Creates a new screen object that can render a surface.

public ScreenSurface(int width, int height)

Parameters

width int
The width in cells of the surface.

height int
The height in cells of the surface.

ScreenSurface(int, int, ColoredGlyphBase[])

Creates a new screen object that can render a surface. Uses the specified cells to generate the surface.

public ScreenSurface(int width, int height, ColoredGlyphBase[] initialCells)

Parameters

width int
The width in cells of the surface.

height int
The height in cells of the surface.

initialCells ColoredGlyphBase[]
The initial cells to seed the surface.

ScreenSurface(int, int, int, int)

Creates a new surface with the specified width and height, with SadRogue.Primitives.Color.Transparent for the background and SadRogue.Primitives.Color.White for the foreground.

public ScreenSurface(int viewWidth, int viewHeight, int totalWidth, int totalHeight)

Parameters

viewWidth int
The visible width of the surface in cells.

viewHeight int
The visible height of the surface in cells.

totalWidth int
The total width of the surface in cells.

totalHeight int
The total height of the surface in cells.

ScreenSurface(IGridView<ColoredGlyphBase>, int, int)

Creates a new surface from a grid view. The cells between this object and the grid view are shared.

public ScreenSurface(IGridView<ColoredGlyphBase> surface, int visibleWidth = 0, int visibleHeight = 0)

Parameters

surface IGridView<ColoredGlyphBase>
The surface to use as the source of cells.

visibleWidth int
Optional view width. If 0, the view width matches the width of the surface.

visibleHeight int
Optional view height. If 0, the view width matches the height of the surface.

ScreenSurface(int, int, int, int, ColoredGlyphBase[]?)

Creates a new surface with the specified width and height, with SadRogue.Primitives.Color.Transparent for the background and SadRogue.Primitives.Color.White for the foreground.

public ScreenSurface(int viewWidth, int viewHeight, int totalWidth, int totalHeight, ColoredGlyphBase[]? initialCells)

Parameters

viewWidth int
The width of the surface in cells to show.

viewHeight int
The height of the surface in cells to show.

totalWidth int
The total width of the surface in cells.

totalHeight int
The total height of the surface in cells.

initialCells ColoredGlyphBase[]
The cells to seed the surface with. If null, creates the cell array for you.

ScreenSurface(ICellSurface, IFont?, Point?)

Creates a new screen object wrapping an existing surface.

[JsonConstructor]
public ScreenSurface(ICellSurface surface, IFont? font = null, Point? fontSize = null)

Parameters

surface ICellSurface
The surface.

font IFont
The font to use with the surface.

fontSize System.NullableSadRogue.Primitives.Point
The font size.

Fields

MouseState_EnteredWithButtonDown

A cached value determined by OnMouseEnter(MouseScreenObjectState). true when the mouse entered the surface bounds with the mouse button down.

protected bool MouseState_EnteredWithButtonDown

IsMouseOver

Indicates that the mouse is currently over this console.

protected bool IsMouseOver

Properties

ForceRendererRefresh

When true, forces the Renderer to refresh the backing texture with the latest state of the object.

public bool ForceRendererRefresh { get; set; }

DefaultRendererName

The name of the default renderer for this object.

public virtual string DefaultRendererName { get; }

Renderer

The renderer used to draw this surface.

[DataMember]
[JsonConverter(typeof(RendererJsonConverter))]
public IRenderer? Renderer { get; protected set; }

QuietSurfaceHandling

When true, prevents the Surface property from raising events and virtual methods when the surface changes.

[DataMember]
public bool QuietSurfaceHandling { get; set; }

Surface

The surface this screen object represents.

public ICellSurface Surface { get; set; }

IsDirty

When true, indicates that the Surface needs to be redrawn; otherwise false.

public bool IsDirty { get; set; }

Font

Font used with rendering.

public IFont Font { get; set; }

Tint

A tint used in rendering.

public Color Tint { get; set; }

AbsoluteArea

The pixel area on the screen this surface occupies.

public Rectangle AbsoluteArea { get; }

UsePixelPositioning

Treats the SadRogue.Primitives.IPositionable.Position of the object as if it is pixels and not cells.

public bool UsePixelPositioning { get; set; }

WidthPixels

The width of the surface in pixels.

public int WidthPixels { get; }

HeightPixels

The height of the surface in pixels.

public int HeightPixels { get; }

Width

The total width of the console.

public int Width { get; }

Height

The total height of the console.

public int Height { get; }

ViewWidth

Gets or sets the visible width of the surface in cells.

public int ViewWidth { get; set; }

ViewHeight

Gets or sets the visible height of the surface in cells.

public int ViewHeight { get; set; }

ViewPosition

The position of the view within the console.

public Point ViewPosition { get; set; }

MoveToFrontOnMouseClick

When true, this object will move to the front of its parent object when the mouse is clicked.

[DataMember]
public bool MoveToFrontOnMouseClick { get; set; }

FocusOnMouseClick

When true, this object will set IsFocused to true when the mouse is clicked.

[DataMember]
public bool FocusOnMouseClick { get; set; }

Methods

Resize(int, int, int, int, bool)

Resizes the surface to the specified width and height.

public void Resize(int viewWidth, int viewHeight, int totalWidth, int totalHeight, bool clear)

Parameters

viewWidth int
The viewable width of the surface.

viewHeight int
The viewable height of the surface.

totalWidth int
The maximum width of the surface.

totalHeight int
The maximum height of the surface.

clear bool
When true, resets every cell to the DefaultForeground, DefaultBackground and glyph 0.

Resize(int, int, bool)

Resizes the surface and view to the specified width and height.

public void Resize(int width, int height, bool clear)

Parameters

width int
The width of the surface and view.

height int
The height of the surface and view.

clear bool
When true, resets every cell to the DefaultForeground, DefaultBackground and glyph 0.

UpdateAbsolutePosition()

Sets a value for AbsolutePosition based on the SadRogue.Primitives.IPositionable.Position of this instance and the Parent instance.

public override void UpdateAbsolutePosition()

Render(TimeSpan)

Draws the Surface and all SadComponents and Children.

public override void Render(TimeSpan delta)

Parameters

delta TimeSpan
The time that has elapsed since the last call.

Update(TimeSpan)

Updates the Surface effects and all SadComponents and Children.

public override void Update(TimeSpan delta)

Parameters

delta TimeSpan
The time that has elapsed since this method was last called.

OnIsDirtyChanged()

Called when the IsDirty property changes.

protected virtual void OnIsDirtyChanged()

OnFontChanged(IFont, Point)

Called when the Font or FontSize property changes.

protected virtual void OnFontChanged(IFont oldFont, Point oldFontSize)

Parameters

oldFont IFont
The font prior to the change.

oldFontSize SadRogue.Primitives.Point
The font size prior to the change.

OnSurfaceChanged(ICellSurface)

Called when the Surface property is changed.

protected virtual void OnSurfaceChanged(ICellSurface oldSurface)

Parameters

oldSurface ICellSurface
The previous surface.

OnRendererChanged()

Called when the Renderer property is changed.

protected virtual void OnRendererChanged()

ToString()

Returns the value “ScreenSurface”.

public override string ToString()

Returns

string
The string “ScreenSurface”.

CallOnHostUpdated()

Calls the OnHostUpdated method on components, renderer, and rendersteps.

public void CallOnHostUpdated()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

~ScreenSurface()

Disposes Renderer.

protected ~ScreenSurface()

Dispose()

public void Dispose()