Skip to content
SadConsole

IScreenSurface Interface

Definition

Section titled “Definition”

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

C#
public interface IScreenSurface : IScreenObject, IPositionable, IComponentHost

Properties

Section titled “Properties”

DefaultRendererName

Section titled “DefaultRendererName”

The name of the default renderer for this object.

C#
string DefaultRendererName { get; }

FocusOnMouseClick

Section titled “FocusOnMouseClick”

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

C#
bool FocusOnMouseClick { get; set; }

HeightPixels

Section titled “HeightPixels”

The height of the surface in pixels.

C#
int HeightPixels { get; }

MoveToFrontOnMouseClick

Section titled “MoveToFrontOnMouseClick”

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

C#
bool MoveToFrontOnMouseClick { get; set; }

Renderer

Section titled “Renderer”

The renderer used to draw this surface.

C#
IRenderer? Renderer { get; }

Surface

Section titled “Surface”

The surface.

C#
ICellSurface Surface { get; }

UsePixelPositioning

Section titled “UsePixelPositioning”

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

C#
bool UsePixelPositioning { get; set; }

WidthPixels

Section titled “WidthPixels”

The width of the surface in pixels.

C#
int WidthPixels { get; }

AbsoluteArea

Section titled “AbsoluteArea”

The pixel area on the screen this surface occupies.

C#
Rectangle AbsoluteArea { get; }

Font

Section titled “Font”

Font used with rendering.

C#
IFont Font { get; set; }

FontSize

Section titled “FontSize”

The size of the Font cells applied to the object when rendering.

C#
Point FontSize { get; set; }

ForceRendererRefresh

Section titled “ForceRendererRefresh”

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

C#
bool ForceRendererRefresh { get; set; }

IsDirty

Section titled “IsDirty”

Indicates the surface has changed and needs to be rendered.

C#
bool IsDirty { get; set; }

Tint

Section titled “Tint”

A tint used in rendering.

C#
Color Tint { get; set; }

Events

Section titled “Events”

MouseButtonClicked

Section titled “MouseButtonClicked”

Raised when a mouse button is clicked on this object.

C#
event EventHandler<MouseScreenObjectState> MouseButtonClicked

Event Type

Section titled “Event Type”

EventHandler<MouseScreenObjectState>

MouseEnter

Section titled “MouseEnter”

Raised when the mouse enters this object.

C#
event EventHandler<MouseScreenObjectState> MouseEnter

Event Type

Section titled “Event Type”

EventHandler<MouseScreenObjectState>

MouseExit

Section titled “MouseExit”

Raised when the mouse exits this object.

C#
event EventHandler<MouseScreenObjectState> MouseExit

Event Type

Section titled “Event Type”

EventHandler<MouseScreenObjectState>

MouseMove

Section titled “MouseMove”

Raised when the mouse moves around the this object.

C#
event EventHandler<MouseScreenObjectState> MouseMove

Event Type

Section titled “Event Type”

EventHandler<MouseScreenObjectState>