Class WindowAnimations

Namespace

SharpConsoleUI.Animation

Assembly

SharpConsoleUI.dll

Pre-built window animation helpers for common transitions.

public static class WindowAnimations

Inheritance

object

WindowAnimations

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

FadeIn(Window, TimeSpan?, Color?, EasingFunction?, Action?)

Fades a window in by reducing a solid color overlay from full intensity to zero. The overlay is registered via PostBufferPaint BEFORE the first frame renders, so the window appears fully covered initially and gradually reveals.

public static IAnimation FadeIn(Window window, TimeSpan? duration = null, Color? fadeColor = null, EasingFunction? easing = null, Action? onComplete = null)

Parameters

window Window

The window to fade in.

duration TimeSpan?

Fade duration. Defaults to AnimationDefaults.DefaultFadeDurationMs.

fadeColor Color?

The overlay color. Defaults to Color.Black.

easing EasingFunction

Easing function. Defaults to EaseInOut.

onComplete Action

Optional callback invoked when the fade completes.

Returns

IAnimation

The animation driving the fade.

FadeOut(Window, TimeSpan?, Color?, EasingFunction?, Action?)

Fades a window out by increasing a solid color overlay from zero to full intensity. Useful for graceful window dismissal - pair with an onComplete that closes the window.

public static IAnimation FadeOut(Window window, TimeSpan? duration = null, Color? fadeColor = null, EasingFunction? easing = null, Action? onComplete = null)

Parameters

window Window

The window to fade out.

duration TimeSpan?

Fade duration. Defaults to AnimationDefaults.DefaultFadeDurationMs.

fadeColor Color?

The overlay color. Defaults to Color.Black.

easing EasingFunction

Easing function. Defaults to EaseInOut.

onComplete Action

Optional callback invoked when the fade completes (e.g., close the window).

Returns

IAnimation

The animation driving the fade.

SlideIn(Window, SlideDirection, TimeSpan?, EasingFunction?, Action?)

Slides a window in from offscreen to its current position.

public static IAnimation SlideIn(Window window, SlideDirection direction, TimeSpan? duration = null, EasingFunction? easing = null, Action? onComplete = null)

Parameters

window Window

direction SlideDirection

duration TimeSpan?

easing EasingFunction

onComplete Action

Returns

IAnimation

SlideOut(Window, SlideDirection, TimeSpan?, EasingFunction?, Action?)

Slides a window out of view in the specified direction.

public static IAnimation SlideOut(Window window, SlideDirection direction, TimeSpan? duration = null, EasingFunction? easing = null, Action? onComplete = null)

Parameters

window Window

direction SlideDirection

duration TimeSpan?

easing EasingFunction

onComplete Action

Returns

IAnimation