tuiffects

package module

Go to main page

Versions in this module

v0

v0.7.0

Aug 28, 2026

Changes in this version

type TuffBabyConfig

+ ExitEase Easing

+ ExitSpeed float64

v0.6.0

Aug 27, 2026

Changes in this version

type TuffBabyConfig

+ SourceFrameRate float64

v0.5.0

Aug 27, 2026

Changes in this version

type Descriptor

+ Origin string

+ type TuffBaby struct

+ func NewTuffBaby(config TuffBabyConfig) *TuffBaby

+ func (t *TuffBaby) Advance(e *Engine) bool

+ func (t *TuffBaby) Build(e *Engine) error

+ type TuffBabyConfig struct

+ FillerSymbols []string

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ FrameHold int

+ GatherEase Easing

+ GatherSpeed float64

+ HomeEase Easing

+ HomeSpeed float64

+ Loops int

+ PoseFrames int

+ Tones []Color

+ func DefaultTuffBabyConfig() TuffBabyConfig

v0.4.0

Aug 26, 2026

Changes in this version

+ var DynamicNeutralGrey = MustParseColor("808080")

+ type BinaryPath struct

+ func NewBinaryPath(config BinaryPathConfig) *BinaryPath

+ func (b *BinaryPath) Advance(e *Engine) bool

+ func (b *BinaryPath) Build(e *Engine) error

+ type BinaryPathConfig struct

+ ActiveBinaryGroups float64

+ BinaryColors []Color

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementSpeed float64

+ func DefaultBinaryPathConfig() BinaryPathConfig

+ type Blackhole struct

+ func NewBlackhole(config BlackholeConfig) *Blackhole

+ func (b *Blackhole) Advance(e *Engine) bool

+ func (b *Blackhole) Build(e *Engine) error

+ func (b *Blackhole) Err() error

+ type BlackholeConfig struct

+ BlackholeColor Color

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ StarColors []Color

+ func DefaultBlackholeConfig() BlackholeConfig

+ type BouncyBalls struct

+ func NewBouncyBalls(config BouncyBallsConfig) *BouncyBalls

+ func (b *BouncyBalls) Advance(e *Engine) bool

+ func (b *BouncyBalls) Build(e *Engine) error

+ type BouncyBallsConfig struct

+ BallColors []Color

+ BallDelay int

+ BallSymbols []string

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementEasing Easing

+ MovementSpeed float64

+ func DefaultBouncyBallsConfig() BouncyBallsConfig

+ type Bubbles struct

+ func NewBubbles(config BubblesConfig) *Bubbles

+ func (b *Bubbles) Advance(e *Engine) bool

+ func (b *Bubbles) Build(e *Engine) error

+ type BubblesConfig struct

+ BubbleColors []Color

+ BubbleDelay int

+ BubbleSpeed float64

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementEasing Easing

+ PopColor Color

+ PopCondition PopCondition

+ Rainbow bool

+ func DefaultBubblesConfig() BubblesConfig

+ type Burn struct

+ func NewBurn(config BurnConfig) *Burn

+ func (b *Burn) Advance(e *Engine) bool

+ func (b *Burn) Build(e *Engine) error

+ type BurnConfig struct

+ BurnColors []Color

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ SmokeChance float64

+ StartingColor Color

+ func DefaultBurnConfig() BurnConfig

+ type Crumble struct

+ func NewCrumble(config CrumbleConfig) *Crumble

+ func (c *Crumble) Advance(e *Engine) bool

+ func (c *Crumble) Build(e *Engine) error

+ type CrumbleConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ func DefaultCrumbleConfig() CrumbleConfig

+ type ErrorCorrect struct

+ func NewErrorCorrect(config ErrorCorrectConfig) *ErrorCorrect

+ func (x *ErrorCorrect) Advance(e *Engine) bool

+ func (x *ErrorCorrect) Build(e *Engine) error

+ type ErrorCorrectConfig struct

+ CorrectColor Color

+ ErrorColor Color

+ ErrorPairs float64

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementSpeed float64

+ SwapDelay int

+ func DefaultErrorCorrectConfig() ErrorCorrectConfig

+ type EtchPattern int

+ const EtchAlgorithm

+ const EtchGroup

+ type Expand struct

+ func NewExpand(config ExpandConfig) *Expand

+ func (x *Expand) Advance(e *Engine) bool

+ func (x *Expand) Build(e *Engine) error

+ type ExpandConfig struct

+ ExpandEasing Easing

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementSpeed float64

+ func DefaultExpandConfig() ExpandConfig

+ type ExpandDirection int

+ const ExpandHorizontal

+ const ExpandVertical

+ func ParseExpandDirection(name string) (ExpandDirection, bool)

+ type Fireworks struct

+ func NewFireworks(config FireworksConfig) *Fireworks

+ func (f *Fireworks) Advance(e *Engine) bool

+ func (f *Fireworks) Build(e *Engine) error

+ type FireworksConfig struct

+ ExplodeAnywhere bool

+ ExplodeDistance float64

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ FireworkColors []Color

+ FireworkSymbol string

+ FireworkVolume float64

+ LaunchDelay int

+ func DefaultFireworksConfig() FireworksConfig

+ type Highlight struct

+ func NewHighlight(config HighlightConfig) *Highlight

+ func (h *Highlight) Advance(e *Engine) bool

+ func (h *Highlight) Build(e *Engine) error

+ type HighlightConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ HighlightBrightness float64

+ HighlightDirection CharacterGroup

+ HighlightWidth int

+ func DefaultHighlightConfig() HighlightConfig

+ type LaserEtch struct

+ func NewLaserEtch(config LaserEtchConfig) *LaserEtch

+ func (l *LaserEtch) Advance(e *Engine) bool

+ func (l *LaserEtch) Build(e *Engine) error

+ type LaserEtchConfig struct

+ CoolGradientStops []Color

+ EtchDelay int

+ EtchPattern EtchPattern

+ EtchSpeed int

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ LaserGradientStops []Color

+ SparkCoolingFrames int

+ SparkGradientStops []Color

+ func DefaultLaserEtchConfig() LaserEtchConfig

+ type Matrix struct

+ func NewMatrix(config MatrixConfig) *Matrix

+ func (m *Matrix) Advance(e *Engine) bool

+ func (m *Matrix) Build(e *Engine) error

+ type MatrixConfig struct

+ ColorSwapChance float64

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ HighlightColor Color

+ RainColorGradient []Color

+ RainColumnDelayHigh int

+ RainColumnDelayLow int

+ RainFallDelayHigh int

+ RainFallDelayLow int

+ RainSymbols []string

+ RainTime int

+ ResolveDelay int

+ SymbolSwapChance float64

+ func DefaultMatrixConfig() MatrixConfig

+ type Middleout struct

+ func NewMiddleout(config MiddleoutConfig) *Middleout

+ func (m *Middleout) Advance(e *Engine) bool

+ func (m *Middleout) Build(e *Engine) error

+ type MiddleoutConfig struct

+ CenterEasing Easing

+ CenterMovementSpeed float64

+ ExpandDirection ExpandDirection

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ FullEasing Easing

+ FullMovementSpeed float64

+ StartingColor Color

+ func DefaultMiddleoutConfig() MiddleoutConfig

+ type OrbittingVolley struct

+ func NewOrbittingVolley(config OrbittingVolleyConfig) *OrbittingVolley

+ func (o *OrbittingVolley) Advance(e *Engine) bool

+ func (o *OrbittingVolley) Build(e *Engine) error

+ type OrbittingVolleyConfig struct

+ BottomLauncherSymbol string

+ CharacterEasing Easing

+ CharacterMovementSpeed float64

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ LaunchDelay int

+ LauncherMovementSpeed float64

+ LeftLauncherSymbol string

+ RightLauncherSymbol string

+ TopLauncherSymbol string

+ VolleySize float64

+ func DefaultOrbittingVolleyConfig() OrbittingVolleyConfig

+ type Overflow struct

+ func NewOverflow(config OverflowConfig) *Overflow

+ func (o *Overflow) Advance(e *Engine) bool

+ func (o *Overflow) Build(e *Engine) error

+ type OverflowConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ OverflowCyclesHigh int

+ OverflowCyclesLow int

+ OverflowGradientStops []Color

+ OverflowSpeed int

+ func DefaultOverflowConfig() OverflowConfig

+ type PopCondition int

+ const PopAnywhere

+ const PopOnBottom

+ const PopOnRow

+ func ParsePopCondition(name string) (PopCondition, bool)

+ type Pour struct

+ func NewPour(config PourConfig) *Pour

+ func (p *Pour) Advance(e *Engine) bool

+ func (p *Pour) Build(e *Engine) error

+ type PourConfig struct

+ Direction PourDirection

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ Gap int

+ MovementEasing Easing

+ MovementSpeedHigh float64

+ MovementSpeedLow float64

+ PourSpeed int

+ StartingColor Color

+ func DefaultPourConfig() PourConfig

+ type PourDirection int

+ const PourDown

+ const PourLeft

+ const PourRight

+ const PourUp

+ type Print struct

+ func NewPrint(config PrintConfig) *Print

+ func (p *Print) Advance(e *Engine) bool

+ func (p *Print) Build(e *Engine) error

+ type PrintConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ PrintHeadEasing Easing

+ PrintHeadReturnSpeed float64

+ PrintSpeed int

+ func DefaultPrintConfig() PrintConfig

+ type RandomSequence struct

+ func NewRandomSequence(config RandomSequenceConfig) *RandomSequence

+ func (r *RandomSequence) Advance(e *Engine) bool

+ func (r *RandomSequence) Build(e *Engine) error

+ type RandomSequenceConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ Speed float64

+ func DefaultRandomSequenceConfig() RandomSequenceConfig

+ type Rings struct

+ func NewRings(config RingsConfig) *Rings

+ func (r *Rings) Advance(e *Engine) bool

+ func (r *Rings) Build(e *Engine) error

+ type RingsConfig struct

+ DisperseDuration int

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ RingColors []Color

+ RingGap float64

+ SpinDisperseCycles int

+ SpinDuration int

+ SpinSpeedHigh float64

+ SpinSpeedLow float64

+ func DefaultRingsConfig() RingsConfig

+ type Scattered struct

+ func NewScattered(config ScatteredConfig) *Scattered

+ func (s *Scattered) Advance(e *Engine) bool

+ func (s *Scattered) Build(e *Engine) error

+ type ScatteredConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementEasing Easing

+ MovementSpeed float64

+ func DefaultScatteredConfig() ScatteredConfig

+ type Slice struct

+ func NewSlice(config SliceConfig) *Slice

+ func (s *Slice) Advance(e *Engine) bool

+ func (s *Slice) Build(e *Engine) error

+ type SliceConfig struct

+ Direction SliceDirection

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementEasing Easing

+ MovementSpeed float64

+ func DefaultSliceConfig() SliceConfig

+ type SliceDirection int

+ const SliceDiagonal

+ const SliceHorizontal

+ const SliceVertical

+ func ParseSliceDirection(name string) (SliceDirection, bool)

+ type Slide struct

+ func NewSlide(config SlideConfig) *Slide

+ func (s *Slide) Advance(e *Engine) bool

+ func (s *Slide) Build(e *Engine) error

+ type SlideConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ Gap int

+ Grouping SlideGrouping

+ Merge bool

+ MovementEasing Easing

+ MovementSpeed float64

+ ReverseDirection bool

+ func DefaultSlideConfig() SlideConfig

+ type SlideGrouping int

+ const SlideByColumn

+ const SlideByDiagonal

+ const SlideByRow

+ func ParseSlideGrouping(name string) (SlideGrouping, bool)

+ type Smoke struct

+ func NewSmoke(config SmokeConfig) *Smoke

+ func (s *Smoke) Advance(e *Engine) bool

+ func (s *Smoke) Build(e *Engine) error

+ type SmokeConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ SmokeGradientStops []Color

+ SmokeSymbols []string

+ StartingColor Color

+ UseWholeCanvas bool

+ func DefaultSmokeConfig() SmokeConfig

+ type Spotlights struct

+ func NewSpotlights(config SpotlightsConfig) *Spotlights

+ func (s *Spotlights) Advance(e *Engine) bool

+ func (s *Spotlights) Build(e *Engine) error

+ type SpotlightsConfig struct

+ BeamFalloff float64

+ BeamWidthRatio float64

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ SearchDuration int

+ SearchSpeedMax float64

+ SearchSpeedMin float64

+ SpotlightCount int

+ func DefaultSpotlightsConfig() SpotlightsConfig

+ type Spray struct

+ func NewSpray(config SprayConfig) *Spray

+ func (s *Spray) Advance(e *Engine) bool

+ func (s *Spray) Build(e *Engine) error

+ type SprayConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementEasing Easing

+ MovementSpeedHigh float64

+ MovementSpeedLow float64

+ SprayPosition SprayPosition

+ SprayVolume float64

+ func DefaultSprayConfig() SprayConfig

+ type SprayPosition int

+ const SprayCenter

+ const SprayEast

+ const SprayNorth

+ const SprayNorthEast

+ const SprayNorthWest

+ const SpraySouth

+ const SpraySouthEast

+ const SpraySouthWest

+ const SprayWest

+ func ParseSprayPosition(name string) (SprayPosition, bool)

+ type Swarm struct

+ func NewSwarm(config SwarmConfig) *Swarm

+ func (s *Swarm) Advance(e *Engine) bool

+ func (s *Swarm) Build(e *Engine) error

+ type SwarmConfig struct

+ BaseColors []Color

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ FlashColor Color

+ SwarmAreaCountHigh int

+ SwarmAreaCountLow int

+ SwarmCoordination float64

+ SwarmSize float64

+ func DefaultSwarmConfig() SwarmConfig

+ type Sweep struct

+ func NewSweep(config SweepConfig) *Sweep

+ func (s *Sweep) Advance(e *Engine) bool

+ func (s *Sweep) Build(e *Engine) error

+ type SweepConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ FirstSweepDirection CharacterGroup

+ SecondSweepDirection CharacterGroup

+ SweepSymbols []string

+ func DefaultSweepConfig() SweepConfig

+ type SynthGrid struct

+ func NewSynthGrid(config SynthGridConfig) *SynthGrid

+ func (s *SynthGrid) Advance(e *Engine) bool

+ func (s *SynthGrid) Build(e *Engine) error

+ type SynthGridConfig struct

+ GridColumnSymbol string

+ GridGradientDirection GradientDirection

+ GridGradientSteps []int

+ GridGradientStops []Color

+ GridRowSymbol string

+ MaxActiveBlocks float64

+ TextGenerationSymbols []string

+ TextGradientDirection GradientDirection

+ TextGradientSteps []int

+ TextGradientStops []Color

+ func DefaultSynthGridConfig() SynthGridConfig

+ type Thunderstorm struct

+ func NewThunderstorm(config ThunderstormConfig) *Thunderstorm

+ func (t *Thunderstorm) Advance(e *Engine) bool

+ func (t *Thunderstorm) Build(e *Engine) error

+ type ThunderstormConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ GlowingTextColor Color

+ LightningColor Color

+ RaindropSymbols []string

+ SparkGlowColor Color

+ SparkGlowTime int

+ SparkSymbols []string

+ StormTime int

+ TextGlowTime int

+ func DefaultThunderstormConfig() ThunderstormConfig

+ type Unstable struct

+ func NewUnstable(config UnstableConfig) *Unstable

+ func (u *Unstable) Advance(e *Engine) bool

+ func (u *Unstable) Build(e *Engine) error

+ type UnstableConfig struct

+ ExplosionEase Easing

+ ExplosionSpeed float64

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ ReassemblyEase Easing

+ ReassemblySpeed float64

+ UnstableColor Color

+ func DefaultUnstableConfig() UnstableConfig

+ type Wipe struct

+ func NewWipe(config WipeConfig) *Wipe

+ func (w *Wipe) Advance(e *Engine) bool

+ func (w *Wipe) Build(e *Engine) error

+ type WipeConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientFrames int

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ WipeDelay int

+ WipeDirection CharacterGroup

+ WipeEase Easing

+ func DefaultWipeConfig() WipeConfig

v0.3.0

Aug 26, 2026

Changes in this version

+ var ErrNoParticleSymbols = errors.New("tuiffects: a particle pool needs at least one symbol")

+ var ErrNoStartingCharacter = errors.New("tuiffects: no character at the spanning tree's starting coordinate")

+ var ErrParticleCountAboveMax = errors.New("tuiffects: cannot preallocate more particles than the pool's maximum")

+ func LinkCharacters(a, b *Character)

type Animation

+ func (a *Animation) ClearScenes()

+ type BreadthFirst struct

+ CharExploreOrder []*Character

+ Complete bool

+ ExploredLastStep []*Character

+ StartingChar *Character

+ func NewBreadthFirst(e *Engine, startingChar *Character, limitToTextBoundary bool) (*BreadthFirst, error)

+ func (b *BreadthFirst) Step()

type Character

+ Links []*Character

+ func (c *Character) ClearEvents()

+ type Clock struct

+ func NewRealClock() *Clock

+ func NewVirtualClock(frameRate int) *Clock

+ func (c *Clock) AdvanceFrame()

+ func (c *Clock) Elapsed() float64

+ func (c *Clock) Wall() float64

type Engine

+ Clock *Clock

type Motion

+ func (m *Motion) ClearPaths()

+ type ParticlePool struct

+ Coord Coord

+ MaxSize int

+ Particles []*Character

+ Symbols []string

+ func NewParticlePool(symbols []string, maxSize int, coord Coord, ...) (*ParticlePool, error)

+ func (p *ParticlePool) Acquire(e *Engine, symbol string, reset ParticleReset) *Character

+ func (p *ParticlePool) AvailableCount() int

+ func (p *ParticlePool) Emit(e *Engine, origin Coord, symbol string, visible bool, reset ParticleReset, ...) *Character

+ func (p *ParticlePool) Extend(particles ...*Character)

+ func (p *ParticlePool) Len() int

+ func (p *ParticlePool) Preallocate(e *Engine, count int) error

+ func (p *ParticlePool) Reclaim(e *Engine, ch *Character, hide, deactivate bool)

+ func (p *ParticlePool) ReclaimOnEvent(ch *Character, event Event, from Caller, hide, deactivate bool)

+ type ParticleReset struct

+ ClearEvents bool

+ ClearScenes bool

+ KeepActivePath bool

+ KeepActiveScene bool

+ KeepPaths bool

+ ResetAppearance bool

+ type PrimsSimple struct

+ CharLastLinked *Character

+ CharLinkOrder []*Character

+ Complete bool

+ EdgeChars []*Character

+ EdgeLastAdded *Character

+ EdgeLastPopped *Character

+ LimitToTextBoundary bool

+ func NewPrimsSimple(e *Engine, startingChar *Character, limitToTextBoundary bool) (*PrimsSimple, error)

+ func (p *PrimsSimple) Step(e *Engine)

+ type PrimsWeighted struct

+ CharLastLinked *Character

+ CharLinkOrder []*Character

+ Complete bool

+ LimitToTextBoundary bool

+ NeighborsLastAdded []*Character

+ func NewPrimsWeighted(e *Engine, startingChar *Character, limitToTextBoundary bool) (*PrimsWeighted, error)

+ func (p *PrimsWeighted) Step(e *Engine)

+ type RecursiveBacktracker struct

+ CharLastLinked *Character

+ CharLinkOrder []*Character

+ Complete bool

+ LimitToTextBoundary bool

+ Stack []*Character

+ StackLastPopped *Character

+ func NewRecursiveBacktracker(e *Engine, startingChar *Character, limitToTextBoundary bool) (*RecursiveBacktracker, error)

+ func (r *RecursiveBacktracker) Step(e *Engine)

type Terminal

+ func (t *Terminal) Neighbors(ch *Character) []*Character

+ type WeightedLink struct

+ CharA *Character

+ CharB *Character

+ Weight int

v0.2.0

Aug 26, 2026

Changes in this version

type Color

+ func AdjustColorBrightness(color Color, brightness float64) Color

type Coord

+ func ExtrapolateAlongRay(origin, target Coord, offsetFromTarget float64) Coord

+ func FindCoordsInCircle(center Coord, diameter int) []Coord

+ func FindCoordsInRect(origin Coord, distance int) []Coord

+ func FindCoordsOnRect(origin Coord, halfWidth, halfHeight int) []Coord

type Descriptor

+ NeedsFillCharacters bool

v0.1.0

Aug 26, 2026

Changes in this version

+ func Choice[T any](g *Rng, items []T) *T

+ func FindLengthOfBezierCurve(start Coord, control []Coord, end Coord) float64

+ func FindLengthOfLine(a, b Coord, doubleRowDiff bool) float64

+ func FindNormalizedDistanceFromCenter(bottom, top, left, right int, other Coord) (float64, bool)

+ func Names() []string

+ func Register(d Descriptor)

+ func Run(effect Effect, e *Engine, maxFrames int) ([]string, error)

+ func Shuffle[T any](g *Rng, items []T)

+ type Action struct

+ func ActivatePath(id string) Action

+ func ActivateScene(id string) Action

+ func Callback(fn func(e *Engine, ch *Character)) Action

+ func DeactivatePath(id string) Action

+ func DeactivateScene(id string) Action

+ func ResetAppearance() Action

+ func SetCoordinate(coord Coord) Action

+ func SetLayer(layer int) Action

+ type Anchor int

+ const AnchorC

+ const AnchorE

+ const AnchorN

+ const AnchorNE

+ const AnchorNW

+ const AnchorS

+ const AnchorSE

+ const AnchorSW

+ const AnchorW

+ type Animation struct

+ ExistingColorHandling ExistingColorHandling

+ InputBold bool

+ InputColors ColorPair

+ func (a *Animation) ActiveSceneIsComplete() bool

+ func (a *Animation) CurrentVisual() *CharacterVisual

+ func (a *Animation) NewScene(id string, opts SceneOptions) *Scene

+ func (a *Animation) Scene(id string) *Scene

+ func (a *Animation) SetAppearance(symbol string, colors ColorPair, usesInputColors bool)

+ type Caller struct

+ func PathCaller(id string) Caller

+ func SceneCaller(id string) Caller

+ func WaypointCaller(w *Waypoint) Caller

+ type Canvas struct

+ Bottom int

+ Center Coord

+ CenterColumn int

+ CenterRow int

+ Height int

+ Left int

+ Right int

+ TextBottom int

+ TextCenter Coord

+ TextCenterColumn int

+ TextCenterRow int

+ TextHeight int

+ TextLeft int

+ TextRight int

+ TextTop int

+ TextWidth int

+ Top int

+ Width int

+ func NewCanvas(width, height int) *Canvas

+ func (c *Canvas) CoordIsInCanvas(coord Coord) bool

+ func (c *Canvas) CoordIsInText(coord Coord) bool

+ func (c *Canvas) RandomColumn(rng *Rng, withinText bool) int

+ func (c *Canvas) RandomCoord(rng *Rng, outsideScope, withinText bool) Coord

+ func (c *Canvas) RandomRow(rng *Rng, withinText bool) int

+ type Character struct

+ Animation Animation

+ ID int

+ InputCoord Coord

+ InputSymbol string

+ IsFill bool

+ IsVisible bool

+ Layer int

+ Motion Motion

+ UsesInputColors bool

+ func (c *Character) IsActive() bool

+ func (c *Character) RegisterEvent(event Event, from Caller, action Action)

+ type CharacterFilter struct

+ Added bool

+ InnerFill bool

+ Input bool

+ OuterFill bool

+ func InputOnly() CharacterFilter

+ type CharacterGroup int

+ const GroupCenterToOutside

+ const GroupColumnLeftToRight

+ const GroupColumnRightToLeft

+ const GroupDiagonalBottomLeftToTopRight

+ const GroupDiagonalBottomRightToTopLeft

+ const GroupDiagonalTopLeftToBottomRight

+ const GroupDiagonalTopRightToBottomLeft

+ const GroupOutsideToCenter

+ const GroupRowBottomToTop

+ const GroupRowTopToBottom

+ type CharacterSort int

+ const SortBottomToTopLeftToRight

+ const SortBottomToTopRightToLeft

+ const SortMiddleRowToOutside

+ const SortOutsideRowToMiddle

+ const SortRandom

+ const SortTopToBottomLeftToRight

+ const SortTopToBottomRightToLeft

+ type CharacterVisual struct

+ Bold bool

+ Colors ColorPair

+ Italic bool

+ Symbol string

+ Underline bool

+ func NewCharacterVisual(symbol string, p VisualParams) *CharacterVisual

+ func PlainVisual(symbol string) *CharacterVisual

+ func (v *CharacterVisual) Formatted() string

+ type Color struct

+ B uint8

+ G uint8

+ R uint8

+ func MustParseColor(hex string) Color

+ func ParseColor(hex string) (Color, error)

+ func RGB(r, g, b uint8) Color

+ func ShiftColorTowards(color, target Color, factor float64) Color

+ func (c Color) Hex() string

+ type ColorPair struct

+ Bg Color

+ Fg Color

+ HasBg bool

+ HasFg bool

+ func Bg(c Color) ColorPair

+ func Fg(c Color) ColorPair

+ func FgBg(fg, bg Color) ColorPair

+ type Coord struct

+ Column int

+ Row int

+ func C(column, row int) Coord

+ func FindCoordOnBezierCurve(start Coord, control []Coord, end Coord, t float64) Coord

+ func FindCoordOnLine(start, end Coord, t float64) Coord

+ func FindCoordsOnCircle(origin Coord, radius, coordsLimit int, unique bool) []Coord

+ type CoordColorMap map[Coord]Color

+ func (m CoordColorMap) At(coord Coord, fallback Color) Color

+ type Decrypt struct

+ func NewDecrypt(config DecryptConfig) *Decrypt

+ func (d *Decrypt) Advance(e *Engine) bool

+ func (d *Decrypt) Build(e *Engine) error

+ type DecryptConfig struct

+ CiphertextColors []Color

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ TypingSpeed int

+ func DefaultDecryptConfig() DecryptConfig

+ type Descriptor struct

+ Description string

+ Name string

+ New Factory

+ func Descriptors() []Descriptor

+ func Lookup(name string) (Descriptor, bool)

+ type Easing int

+ const InBack

+ const InBounce

+ const InCirc

+ const InCubic

+ const InElastic

+ const InExpo

+ const InOutBack

+ const InOutBounce

+ const InOutCirc

+ const InOutCubic

+ const InOutElastic

+ const InOutExpo

+ const InOutQuad

+ const InOutQuart

+ const InOutQuint

+ const InOutSine

+ const InQuad

+ const InQuart

+ const InQuint

+ const InSine

+ const Linear

+ const OutBack

+ const OutBounce

+ const OutCirc

+ const OutCubic

+ const OutElastic

+ const OutExpo

+ const OutQuad

+ const OutQuart

+ const OutQuint

+ const OutSine

+ func ParseEasing(name string) (Easing, bool)

+ func (e Easing) Ease(p float64) float64

+ type Effect interface

+ Advance func(e *Engine) bool

+ Build func(e *Engine) error

+ type Engine struct

+ Rng *Rng

+ Terminal *Terminal

+ func NewEngine(terminal *Terminal, rng *Rng) *Engine

+ func (e *Engine) Activate(ch *Character)

+ func (e *Engine) ActivatePath(ch *Character, pathID string)

+ func (e *Engine) ActivateScene(ch *Character, sceneID string)

+ func (e *Engine) ActiveCharacters() []*Character

+ func (e *Engine) ActiveCount() int

+ func (e *Engine) ChainPaths(ch *Character, pathIDs []string, loop bool)

+ func (e *Engine) ClearActive()

+ func (e *Engine) Deactivate(ch *Character)

+ func (e *Engine) DeactivateScene(ch *Character, sceneID string)

+ func (e *Engine) Frame() string

+ func (e *Engine) FrameRows() [][]*CharacterVisual

+ func (e *Engine) MotionMove(ch *Character)

+ func (e *Engine) StepAnimation(ch *Character)

+ func (e *Engine) Tick(ch *Character)

+ func (e *Engine) Update()

+ type Event int

+ const PathActivated

+ const PathComplete

+ const PathHolding

+ const SceneActivated

+ const SceneComplete

+ const SegmentEntered

+ const SegmentExited

+ type ExistingColorHandling int

+ const AlwaysExistingColors

+ const DynamicExistingColors

+ const IgnoreExistingColors

+ type Factory func() Effect

+ type Frame struct

+ Duration int

+ Visual *CharacterVisual

+ type Gradient struct

+ Spectrum []Color

+ func NewGradient(stops []Color, steps []int, doLoop bool) (*Gradient, error)

+ func NewGradientSteps(stops []Color, steps int, doLoop bool) (*Gradient, error)

+ func (g *Gradient) BuildCoordinateColorMapping(minRow, maxRow, minColumn, maxColumn int, direction GradientDirection) (CoordColorMap, error)

+ func (g *Gradient) ColorAtFraction(fraction float64) Color

+ type GradientDirection int

+ const Diagonal

+ const Horizontal

+ const Radial

+ const Vertical

+ func ParseGradientDirection(name string) (GradientDirection, bool)

+ type InputCell struct

+ Bg Color

+ Bold bool

+ Fg Color

+ HasBg bool

+ HasFg bool

+ Symbol string

+ type Motion struct

+ CurrentCoord Coord

+ PreviousCoord Coord

+ func (m *Motion) DeactivatePath(id string)

+ func (m *Motion) MovementIsComplete() bool

+ func (m *Motion) NewPath(id string, opts PathOptions) (*Path, error)

+ func (m *Motion) Path(id string) *Path

+ func (m *Motion) SetCoordinate(coord Coord)

+ type Path struct

+ Ease Easing

+ HasEase bool

+ HasLayer bool

+ HoldTime int

+ ID string

+ Layer int

+ Loop bool

+ Segments []Segment

+ Speed float64

+ Waypoints []Waypoint

+ func (p *Path) NewWaypoint(coord Coord, bezierControl []Coord, id string) (*Waypoint, error)

+ type PathOptions struct

+ Ease Easing

+ HasEase bool

+ HasLayer bool

+ HoldTime int

+ Layer int

+ Loop bool

+ Speed float64

+ type Rain struct

+ func NewRain(config RainConfig) *Rain

+ func (r *Rain) Advance(e *Engine) bool

+ func (r *Rain) Build(e *Engine) error

+ type RainConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ MovementEasing Easing

+ MovementSpeedHigh float64

+ MovementSpeedLow float64

+ RainColors []Color

+ RainSymbols []string

+ func DefaultRainConfig() RainConfig

+ type Rng struct

+ func NewRng(seed uint64) *Rng

+ func (g *Rng) Float() float64

+ func (g *Rng) IndexBelow(n int) int

+ func (g *Rng) IntBelow(low, high int) int

+ func (g *Rng) IntBetween(low, high int) int

+ func (g *Rng) Uniform(low, high float64) float64

+ type Scene struct

+ Ease Easing

+ HasEase bool

+ ID string

+ IsLooping bool

+ Sync SyncMetric

+ func (s *Scene) AddFrame(symbol string, duration int, p VisualParams) error

+ func (s *Scene) ApplyGradientToSymbols(symbols []string, duration int, fg, bg *Gradient) error

+ type SceneOptions struct

+ Ease Easing

+ Frames int

+ HasEase bool

+ Looping bool

+ Sync SyncMetric

+ UsesInputColors bool

+ type Segment struct

+ Distance float64

+ End Waypoint

+ Start Waypoint

+ type SyncMetric int

+ const SyncDistance

+ const SyncNone

+ const SyncStep

+ type Terminal struct

+ AddedCharacters []*Character

+ Canvas *Canvas

+ Characters []*Character

+ Config TerminalConfig

+ InnerFillCharacters []*Character

+ InputCharacters []*Character

+ OuterFillCharacters []*Character

+ func NewTerminalFromCells(grid [][]InputCell, cfg TerminalConfig) *Terminal

+ func NewTerminalFromText(input string, cfg TerminalConfig) *Terminal

+ func (t *Terminal) AddCharacter(symbol string, coord Coord) *Character

+ func (t *Terminal) CharacterAtInputCoord(coord Coord) *Character

+ func (t *Terminal) CollectCharacters(filter CharacterFilter) []*Character

+ func (t *Terminal) Frame() string

+ func (t *Terminal) FrameRows() [][]*CharacterVisual

+ func (t *Terminal) GetCharacters(rng *Rng, filter CharacterFilter, order CharacterSort) []*Character

+ func (t *Terminal) GetCharactersGrouped(filter CharacterFilter, grouping CharacterGroup) [][]*Character

+ func (t *Terminal) SetCharacterVisibility(ch *Character, visible bool)

+ type TerminalConfig struct

+ AnchorText Anchor

+ ExistingColorHandling ExistingColorHandling

+ Height int

+ MakeFillCharacters bool

+ TabWidth int

+ Width int

+ type VhsTape struct

+ func NewVhsTape(config VhsTapeConfig) *VhsTape

+ func (v *VhsTape) Advance(e *Engine) bool

+ func (v *VhsTape) Build(e *Engine) error

+ type VhsTapeConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ GlitchLineChance float64

+ GlitchLineColors []Color

+ NoiseChance float64

+ NoiseColors []Color

+ TotalGlitchTime int

+ func DefaultVhsTapeConfig() VhsTapeConfig

+ type VisualParams struct

+ Bold bool

+ Colors ColorPair

+ Italic bool

+ Underline bool

+ type Waves struct

+ func NewWaves(config WavesConfig) *Waves

+ func (w *Waves) Advance(e *Engine) bool

+ func (w *Waves) Build(e *Engine) error

+ type WavesConfig struct

+ FinalGradientDirection GradientDirection

+ FinalGradientSteps []int

+ FinalGradientStops []Color

+ WaveCount int

+ WaveDirection CharacterGroup

+ WaveEasing Easing

+ WaveGradientSteps []int

+ WaveGradientStops []Color

+ WaveLength int

+ WaveSymbols []string

+ func DefaultWavesConfig() WavesConfig

+ type Waypoint struct

+ BezierControl []Coord

+ Coord Coord

+ ID string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL