Skip to content

LedTextBlinkSettings

StructLEDStudioLEDStudio
public struct LedTextBlinkSettings

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

public bool Enabled

Returns

System.Boolean

public LedTextBlinkMode Mode

Returns

LEDStudio.LedTextBlinkMode

public float BlinksPerSecond

Returns

System.Single

public float OnTimePercent

Returns

System.Single

public float DimAlpha

Returns

System.Single

public float PhasePercent

Returns

System.Single

public LedTextBlinkSettings Normalized()

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

Returns

LEDStudio.LedTextBlinkSettings

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.

public bool Equals(LedTextBlinkSettings other)

Parameters

Name Type
other LEDStudio.LedTextBlinkSettings

Returns

System.Boolean

public override bool Equals(object obj)

Parameters

Name Type
obj System.Object

Returns

System.Boolean

public override int GetHashCode()

Returns

System.Int32

operator ==(LedTextBlinkSettings, LedTextBlinkSettings)

Section titled “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)

Section titled “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

public static LedTextBlinkSettings Default { get; }

Returns

LEDStudio.LedTextBlinkSettings