Struct SeStringDrawParams

Render styles for a SeString.

Assembly: Dalamud.dll

Declaration

public struct SeStringDrawParams : IEquatable<SeStringDrawParams>

Implements:
System.IEquatable<Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams>

Properties

TargetDrawList

Gets or sets the target draw list.

Declaration

public ImDrawListPtr? TargetDrawList { readonly get; set; }

Remarks

If this value is set, Dalamud.Bindings.ImGui.ImGui.Dummy(System.Numerics.Vector2) will not be called, and ImGui ID will be ignored. You must specify a valid draw list, a valid font via Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams.Font and Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams.FontSize if you set this value, since the renderer will not be able to retrieve them from ImGui context. Must be set when drawing off the main thread.

GetEntity

Gets or sets the function to be called on every codepoint and payload for the purpose of offering chances to draw something else instead of glyphs or SeString payload entities.

Declaration

public SeStringReplacementEntity.GetEntityDelegate? GetEntity { readonly get; set; }

ScreenOffset

Gets or sets the screen offset of the left top corner.

Declaration

public Vector2? ScreenOffset { readonly get; set; }

Font

Gets or sets the font to use.

Declaration

public ImFontPtr? Font { readonly get; set; }

Remarks

Must be set when specifying a target draw-list or drawing off the main thread.

FontSize

Gets or sets the font size.

Declaration

public float? FontSize { readonly get; set; }

Remarks

Must be set when specifying a target draw-list or drawing off the main thread.

LineHeight

Gets or sets the line height ratio.

Declaration

public float? LineHeight { readonly get; set; }

WrapWidth

Gets or sets the wrapping width.

Declaration

public float? WrapWidth { readonly get; set; }

LinkUnderlineThickness

Gets or sets the thickness of underline under links.

Declaration

public float? LinkUnderlineThickness { readonly get; set; }

Opacity

Gets or sets the opacity, commonly called "alpha".

Declaration

public float? Opacity { readonly get; set; }

EdgeStrength

Gets or sets the strength of the edge, which will have effects on the edge opacity.

Declaration

public float? EdgeStrength { readonly get; set; }

ThemeIndex

Gets or sets the theme that will decide the colors to use for Lumina.Text.Payloads.MacroCode.ColorType and Lumina.Text.Payloads.MacroCode.EdgeColorType.

Declaration

public int? ThemeIndex { readonly get; set; }

Color

Gets or sets the color of the rendered text.

Declaration

public uint? Color { readonly get; set; }

EdgeColor

Gets or sets the color of the rendered text edge.

Declaration

public uint? EdgeColor { readonly get; set; }

ShadowColor

Gets or sets the color of the rendered text shadow.

Declaration

public uint? ShadowColor { readonly get; set; }

LinkHoverBackColor

Gets or sets the background color of a link when hovered.

Declaration

public uint? LinkHoverBackColor { readonly get; set; }

LinkActiveBackColor

Gets or sets the background color of a link when active.

Declaration

public uint? LinkActiveBackColor { readonly get; set; }

ForceEdgeColor

Gets or sets a value indicating whether to force the color of the rendered text edge.

Declaration

public bool ForceEdgeColor { readonly get; set; }

Remarks

If set, then Lumina.Text.Payloads.MacroCode.EdgeColor and Lumina.Text.Payloads.MacroCode.EdgeColorType will be ignored.

Bold

Gets or sets a value indicating whether the text is rendered bold.

Declaration

public bool Bold { readonly get; set; }

Italic

Gets or sets a value indicating whether the text is rendered italic.

Declaration

public bool Italic { readonly get; set; }

Edge

Gets or sets a value indicating whether the text is rendered with edge.

Declaration

public bool Edge { readonly get; set; }

Remarks

If an edge color is pushed with Lumina.Text.Payloads.MacroCode.EdgeColor or Lumina.Text.Payloads.MacroCode.EdgeColorType, it will be drawn regardless. Set Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams.ForceEdgeColor to true and set Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams.EdgeColor to 0 to fully disable edge.

Shadow

Gets or sets a value indicating whether the text is rendered with shadow.

Declaration

public bool Shadow { readonly get; set; }

Methods

ToString()

Declaration

public override readonly string ToString()

Returns

System.String

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

System.Int32

Equals(object)

Declaration

public override readonly bool Equals(object obj)

Returns

System.Boolean

Parameters

Type	Name
System.Object	obj

Equals(SeStringDrawParams)

Declaration

public readonly bool Equals(SeStringDrawParams other)

Returns

System.Boolean

Parameters

Type	Name
Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams	other

Implements

• System.IEquatable<Dalamud.Interface.ImGuiSeStringRenderer.SeStringDrawParams>