LedTextBlinkSettings

StructLEDStudioLEDStudio

public struct LedTextBlinkSettings

Configures text flashing or fading with on, off, and transition durations in seconds.

Fields

Enabled

[Tooltip("Enable timed blinking for this text source.")]
public bool Enabled

Returns

System.Boolean

Mode

[Tooltip("Blink shape. Flash switches instantly, Fade pulses smoothly.")]
public LedTextBlinkMode Mode

Returns

LEDStudio.LedTextBlinkMode

BlinksPerSecond

[Tooltip("Blink cycles per second.")]
[Min(0.01)]
public float BlinksPerSecond

Returns

System.Single

OnTimePercent

[Tooltip("Percent of each cycle spent in the bright phase.")]
[Range(1, 99)]
public float OnTimePercent

Returns

System.Single

DimAlpha

[Tooltip("Text alpha during the dim phase. 0 is fully off, 1 never dims.")]
[Range(0, 1)]
public float DimAlpha

Returns

System.Single

PhasePercent

[Tooltip("Cycle offset in percent, useful for alternating multiple text sources.")]
[Range(0, 100)]
public float PhasePercent

Returns

System.Single

Methods

Normalized()

public LedTextBlinkSettings Normalized()

Returns a copy with safe frequency, duty-cycle, alpha, and phase ranges for runtime evaluation.

Returns

LEDStudio.LedTextBlinkSettings

EvaluateAlpha(double)

public float EvaluateAlpha(double clockTime)

Evaluates the text alpha for the supplied board clock time.

Parameters

Name	Type	Description
clockTime	System.Double	Clock time in seconds.

Returns

System.Single: A normalized alpha value, or one when blinking is disabled.

Equals(LedTextBlinkSettings)

public bool Equals(LedTextBlinkSettings other)

Parameters

Name	Type
other	LEDStudio.LedTextBlinkSettings

Returns

System.Boolean

Equals(object)

public override bool Equals(object obj)

Parameters

Name	Type
obj	System.Object

Returns

System.Boolean

GetHashCode()

public override int GetHashCode()

Returns

System.Int32

Operators

operator ==(LedTextBlinkSettings, LedTextBlinkSettings)

public static bool operator ==(LedTextBlinkSettings a, LedTextBlinkSettings b)

Determines whether two blink configurations have identical enablement, mode, timing, alpha, and phase values.

Parameters

Name	Type
a	LEDStudio.LedTextBlinkSettings
b	LEDStudio.LedTextBlinkSettings

Returns

System.Boolean

operator !=(LedTextBlinkSettings, LedTextBlinkSettings)

public static bool operator !=(LedTextBlinkSettings a, LedTextBlinkSettings b)

Determines whether any enablement, mode, timing, alpha, or phase value differs between two blink configurations.

Parameters

Name	Type
a	LEDStudio.LedTextBlinkSettings
b	LEDStudio.LedTextBlinkSettings

Returns

System.Boolean

Properties

Default

public static LedTextBlinkSettings Default { get; }

Returns

LEDStudio.LedTextBlinkSettings