Skip to content

TextSource

ClassLEDStudioLEDStudio
public sealed class TextSource : ITextStyledSource, ILedSource, ITextScrollOffsetSource, ITextBlinkSource

Source adapter for text content. Renders text into a small RenderTexture and caches it when the content hasn’t changed. Supports a built-in 5x7 bitmap font and a TMP-backed font-texture renderer for arbitrary font assets and multilingual text.

public LedSourceType SourceType { get; }

No description is available for this member.

Returns

LEDStudio.LedSourceType — No return description is available.

public bool IsReady { get; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

public bool IsDirty { get; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

public Texture OutputTexture { get; }

No description is available for this member.

Returns

UnityEngine.Texture — No return description is available.

public bool RequiresTimeUpdates { get; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

public bool AutoScroll { get; set; }

Automatically scroll text that overflows the board width.

Returns

System.Boolean — No return description is available.

public bool AlwaysScroll { get; set; }

Scroll even when text fits within the board width.

Returns

System.Boolean — No return description is available.

public bool SeamlessWrap { get; set; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

public float SeamlessWrapPaddingPixels { get; set; }

No description is available for this member.

Returns

System.Single — No return description is available.

public LedSeamlessWrapDistribution SeamlessWrapDistribution { get; set; }

No description is available for this member.

Returns

LEDStudio.LedSeamlessWrapDistribution — No return description is available.

public LedTextScrollAxis ScrollAxis { get; set; }

No description is available for this member.

Returns

LEDStudio.LedTextScrollAxis — No return description is available.

public float ScrollSpeed { get; set; }

Scroll speed in pixels per second.

Returns

System.Single — No return description is available.

public float ScrollOffsetPercent { get; set; }

No description is available for this member.

Returns

System.Single — No return description is available.

public LedTextBlinkSettings BlinkSettings { get; set; }

No description is available for this member.

Returns

LEDStudio.LedTextBlinkSettings — No return description is available.

TextSource(string, Color, LedTextSettings, TMP_FontAsset, Color)

Section titled “TextSource(string, Color, LedTextSettings, TMP_FontAsset, Color)”
public TextSource(string text, Color color, LedTextSettings textSettings, TMP_FontAsset fontAsset = null, Color backgroundColor = default)

No description is available for this member.

Parameters

Name Type Description
text System.String
color UnityEngine.Color
textSettings LEDStudio.LedTextSettings
fontAsset TMPro.TMP_FontAsset
backgroundColor UnityEngine.Color

public void SetRenderBackend(ILedTextRenderBackend renderBackend)

No description is available for this member.

Parameters

Name Type Description
renderBackend LEDStudio.ILedTextRenderBackend
public void SetTreatTextAsMarkup(bool treatAsMarkup)

No description is available for this member.

Parameters

Name Type Description
treatAsMarkup System.Boolean

SetTextSettings(LedTextSettings, TMP_FontAsset)

Section titled “SetTextSettings(LedTextSettings, TMP_FontAsset)”
public void SetTextSettings(LedTextSettings settings, TMP_FontAsset fontAsset)

No description is available for this member.

Parameters

Name Type Description
settings LEDStudio.LedTextSettings
fontAsset TMPro.TMP_FontAsset
public void SetText(string text)

No description is available for this member.

Parameters

Name Type Description
text System.String
public void SetColor(Color color)

No description is available for this member.

Parameters

Name Type Description
color UnityEngine.Color
public void SetBackgroundColor(Color backgroundColor)

No description is available for this member.

Parameters

Name Type Description
backgroundColor UnityEngine.Color
public void Prepare(Vector2Int targetResolution)

No description is available for this member.

Parameters

Name Type Description
targetResolution UnityEngine.Vector2Int
public void UpdateSource(in TimeStep step)

No description is available for this member.

Parameters

Name Type Description
step ImpossibleRobert.Common.Timing.TimeStep
public static ulong GetGlyphPublic(char c)

No description is available for this member.

Parameters

Name Type Description
c System.Char

Returns

System.UInt64 — No return description is available.

public void MarkClean()

No description is available for this member.

public void GetDirtyRects(List<RectInt> outRects)

No description is available for this member.

Parameters

Name Type Description
outRects System.Collections.Generic.List{UnityEngine.RectInt}
public bool TryGetContentBounds(out RectInt bounds)

No description is available for this member.

Parameters

Name Type Description
bounds UnityEngine.RectInt

Returns

System.Boolean — No return description is available.

public void Release()

No description is available for this member.