anim

README

anim

Package anim contains a range of terminal animations. These are used on cy's splash screen and in the background while fuzzy finding.

Documentation

Index

• Constants
• Variables
• func NewAnimator(ctx context.Context, animation Animation, initial image.Image, fps int, ...) *taro.Program
• func NewStory(ctx context.Context, creator Creator) *taro.Program
• type Animation
• type Animator
  • func (a *Animator) Init() tea.Cmd
  • func (a *Animator) Update(msg tea.Msg) (taro.Model, tea.Cmd)
  • func (a *Animator) View(state *tty.State)
• type Collapse
  • func (c *Collapse) Init(start image.Image)
  • func (c *Collapse) Update(delta time.Duration) image.Image
• type Conway
  • func (c *Conway) Init(start image.Image)
  • func (c *Conway) Update(delta time.Duration) image.Image
• type Cos
  • func (cos *Cos) Init(start image.Image)
  • func (cos *Cos) Update(delta time.Duration) image.Image
• type Creator
• type Cyform
  • func (c *Cyform) Init(start image.Image)
  • func (c *Cyform) Update(delta time.Duration) image.Image
• type Fluid
  • func (f *Fluid) Init(start image.Image)
  • func (f *Fluid) Update(delta time.Duration) image.Image
• type Midjo
  • func (m *Midjo) Init(start image.Image)
  • func (mid *Midjo) Update(delta time.Duration) image.Image
• type Option
  • func WithStartTime(start time.Time) Option
• type Story
  • func (s *Story) Init() tea.Cmd
  • func (s *Story) Update(msg tea.Msg) (taro.Model, tea.Cmd)
  • func (s *Story) View(state *tty.State)

Constants

const (
	POSITION_FACTOR = 10
)

const (
	TICKS_PER_SECOND = 10
)

Variables

var Animations = map[string]Creator{}

Functions

func NewAnimator

func NewAnimator(
	ctx context.Context,
	animation Animation,
	initial image.Image,
	fps int,
	options ...Option,
) *taro.Program

func NewStory

func NewStory(
	ctx context.Context,
	creator Creator,
) *taro.Program

Types

type Animation

type Animation interface {
	Init(image.Image)
	Update(delta time.Duration) image.Image
}

type Animator

type Animator struct {
	// contains filtered or unexported fields
}

func (*Animator) Init

func (a *Animator) Init() tea.Cmd

func (*Animator) Update

func (a *Animator) Update(msg tea.Msg) (taro.Model, tea.Cmd)

func (*Animator) View

func (a *Animator) View(state *tty.State)

type Collapse

type Collapse struct {
	// contains filtered or unexported fields
}

func (*Collapse) Init

func (c *Collapse) Init(start image.Image)

func (*Collapse) Update

func (c *Collapse) Update(delta time.Duration) image.Image

type Conway

type Conway struct {
	// contains filtered or unexported fields
}

func (*Conway) Init

func (c *Conway) Init(start image.Image)

func (*Conway) Update

func (c *Conway) Update(delta time.Duration) image.Image

type Cos

type Cos struct {
	// contains filtered or unexported fields
}

func (*Cos) Init

func (cos *Cos) Init(start image.Image)

func (*Cos) Update

func (cos *Cos) Update(delta time.Duration) image.Image

type Creator

type Creator func() Animation

type Cyform

type Cyform struct {
	// contains filtered or unexported fields
}

func (*Cyform) Init

func (c *Cyform) Init(start image.Image)

func (*Cyform) Update

func (c *Cyform) Update(delta time.Duration) image.Image

type Fluid

type Fluid struct {
	// contains filtered or unexported fields
}

func (*Fluid) Init

func (f *Fluid) Init(start image.Image)

func (*Fluid) Update

func (f *Fluid) Update(delta time.Duration) image.Image

type Midjo

type Midjo struct {
	// contains filtered or unexported fields
}

func (*Midjo) Init

func (m *Midjo) Init(start image.Image)

func (*Midjo) Update

func (mid *Midjo) Update(delta time.Duration) image.Image

type Option

type Option func(*Animator)

func WithStartTime

func WithStartTime(start time.Time) Option

type Story

type Story struct {
	util.Lifetime
	// contains filtered or unexported fields
}

func (*Story) Init

func (s *Story) Init() tea.Cmd

func (*Story) Update

func (s *Story) Update(msg tea.Msg) (taro.Model, tea.Cmd)

func (*Story) View

func (s *Story) View(state *tty.State)