Skip to main content

API Reference

Welcome to the Locus API reference documentation.

Core API​

The Core package provides the core functionality of the animation engine:

  • app - Core classes such as scenes, projects, renderers
  • signals - Reactive signal system
  • types - Basic types such as vectors, matrices
  • scenes - Scene descriptions and generators
  • flow - Time control (loops, timers, etc.)
  • tweening - Tween animation
  • transitions - Transition effects
  • threading - Thread management
  • plugin - Plugin system
  • utils - Utility functions

2D API​

The 2D package provides Canvas-based 2D rendering components:

  • components - 2D graphics components (nodes, circles, rectangles, text, etc.)
  • code - Code editor component
  • curves - Curve and path components
  • utils - Utility functions
  • scenes - 2D scenes
FeatureDocumentation
Create scenesScene
Add nodesNode
Use signalsSignal
Tween animationTween