Class PromptGlyphStyle

Namespace: MicroEngine.UI
Assembly: MicroEngine.dll
Guide: UI widgets

Colours of prompt glyphs (PromptText): key caps, gamepad buttons and touch controls.

C#

public sealed record PromptGlyphStyle : IEquatable<PromptGlyphStyle>

Inheritance

object ← PromptGlyphStyle

Implements

IEquatable<PromptGlyphStyle>

Constructors

PromptGlyphStyle(Color, Color, Color)

Colours of prompt glyphs (PromptText): key caps, gamepad buttons and touch controls.

C#

public PromptGlyphStyle(Color Cap, Color CapBorder, Color CapText)

Parameters

Cap Color

Fill of key caps and of gamepad buttons without a colour of their own.

CapBorder Color

Outline of caps, pills and touch rings.

CapText Color

Text on caps and buttons.

Fields

Default

Light caps with dark text, readable on most backgrounds.

C#

public static readonly PromptGlyphStyle Default

Field Value

PromptGlyphStyle

Properties

Cap

Fill of key caps and of gamepad buttons without a colour of their own.

C#

public Color Cap { get; init; }

Property Value

Color

CapBorder

Outline of caps, pills and touch rings.

C#

public Color CapBorder { get; init; }

Property Value

Color

CapText

Text on caps and buttons.

C#

public Color CapText { get; init; }

Property Value

Color

ColoredFaceButtons

Whether Xbox and Nintendo face buttons are filled with their usual colours (A green, B red, X blue, Y yellow).

C#

public bool ColoredFaceButtons { get; init; }

Property Value

bool

Methods

<Clone>$()

C#

public PromptGlyphStyle <Clone>$()

Returns

PromptGlyphStyle

Deconstruct(out Color, out Color, out Color)

C#

public void Deconstruct(out Color Cap, out Color CapBorder, out Color CapText)

Parameters

Cap Color

CapBorder Color

CapText Color

Equals(object?)

C#

public override bool Equals(object? obj)

Parameters

obj object?

Returns

bool

Equals(PromptGlyphStyle?)

C#

public bool Equals(PromptGlyphStyle? other)

Parameters

other PromptGlyphStyle?

Returns

bool

From(UiTheme)

Caps in a theme’s text colour, outlined with its shadow, labelled in its panel colour.

C#

public static PromptGlyphStyle From(UiTheme theme)

Parameters

theme UiTheme

Returns

PromptGlyphStyle

GetHashCode()

C#

public override int GetHashCode()

Returns

int

ToString()

C#

public override string ToString()

Returns

string

Operators

operator ==(PromptGlyphStyle?, PromptGlyphStyle?)

C#

public static bool operator ==(PromptGlyphStyle? left, PromptGlyphStyle? right)

Parameters

left PromptGlyphStyle?

right PromptGlyphStyle?

Returns

bool

operator !=(PromptGlyphStyle?, PromptGlyphStyle?)

C#

public static bool operator !=(PromptGlyphStyle? left, PromptGlyphStyle? right)

Parameters

left PromptGlyphStyle?

right PromptGlyphStyle?

Returns

bool