particle_field library

Classes

Particle

The basic particle used by ParticleField. It includes properties common to most particle effects.

ParticleController

The ParticleController is passed as a parameter to onTick and onInit and provides access to all of the run-time properties used to render the field, including the sprite sheet, list of particles, global opacity, blendmode, origin, and anchor.

ParticleField

ParticleField lets you add custom particle effects anywhere in your Flutter application easily. Simply provide a SpriteSheet (or ImageFrameProvider) and an onTick handler that manages your Particle list.

SpriteSheet

An ImageFrameProvider that works with basic sprite sheets or single frame images. It can accept an unloaded ImageProvider, and toggle isReady when it successfully loads.

Mixins

ImageFrameProvider

Generic interface for fetching frames of an image sequence such as a sprite sheet. Can be implemented to provide alternative sprite sheet implementations.

Typedefs

ParticleFieldInit = void Function(ParticleController controller)

Defines the signature for the function called when the ParticleField initializes.

ParticleFieldTick = void Function(ParticleController controller, Duration elapsed, Size size)

Defines the signature for the function responsible for updating the particles each tick in a ParticleField.