Raxol.Terminal.Graphics.Animation (Raxol v2.0.1)

View Source

Terminal graphics animation adapter that bridges the existing Raxol.Animation.Framework with terminal graphics capabilities.

This module provides:

  • Frame-based animation system for terminal graphics
  • Integration with Kitty protocol animations
  • Smooth transitions for graphics elements
  • Performance monitoring for terminal animations
  • Fallback support for non-animation terminals

Usage

# Create a graphics fade animation
Graphics.Animation.create_graphics_animation(:fade_in, %{
  duration: 500,
  easing: :ease_out_cubic,
  from: %{opacity: 0.0},
  to: %{opacity: 1.0}
})

# Animate an image scaling
Graphics.Animation.create_image_animation(:scale_up, %{
  duration: 300,
  from: %{width: 100, height: 100},
  to: %{width: 200, height: 200}
})

Summary

Types

animation_id()
frame_data()
graphics_id()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

create_graphics_animation(name, params)

Creates a graphics animation definition for use with terminal graphics.

create_image_animation(name, frames, options)

Creates a smooth image animation between frames.

get_performance_metrics()

Gets current performance metrics for graphics animations.

handle_manager_cast(msg, state)

Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_cast/2.

start_graphics_animation(animation_name, graphics_id, options \\ %{})

Starts a graphics animation on a specific graphics element.

start_link(init_opts \\ [])
stop_graphics_animation(animation_id)

Stops a running graphics animation.

Types

animation_id()

@type animation_id() :: String.t()

frame_data()

@type frame_data() :: %{
  timestamp: non_neg_integer(),
  graphics_id: graphics_id(),
  properties: map()
}

graphics_id()

@type graphics_id() :: non_neg_integer()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

create_graphics_animation(name, params)

@spec create_graphics_animation(atom(), map()) :: :ok | {:error, term()}

Creates a graphics animation definition for use with terminal graphics.

Parameters

  • name - Animation name/identifier
  • params - Animation parameters including:
    • duration - Animation duration in milliseconds
    • easing - Easing function (see Raxol.Animation.Interpolate)
    • from/to - Graphics properties to animate
    • frame_delay - Delay between frames (default: calculated from fps)

create_image_animation(name, frames, options)

@spec create_image_animation(atom(), [binary()], map()) :: :ok | {:error, term()}

Creates a smooth image animation between frames.

Parameters

  • name - Animation name
  • frames - List of image data for animation frames
  • options - Animation options (duration, loop_count, etc.)

get_performance_metrics()

@spec get_performance_metrics() :: map()

Gets current performance metrics for graphics animations.

handle_manager_cast(msg, state)

Callback implementation for Raxol.Core.Behaviours.BaseManager.handle_manager_cast/2.

start_graphics_animation(animation_name, graphics_id, options \\ %{})

@spec start_graphics_animation(atom(), graphics_id(), map()) ::
  {:ok, animation_id()} | {:error, term()}

Starts a graphics animation on a specific graphics element.

Parameters

  • animation_name - Name of the animation to start
  • graphics_id - Graphics element ID to animate
  • options - Additional options for the animation instance

start_link(init_opts \\ [])

stop_graphics_animation(animation_id)

@spec stop_graphics_animation(animation_id()) :: :ok | {:error, term()}

Stops a running graphics animation.