anim_fx.h

/*
 * Card animation effect-stepping functions
 */

#ifndef _ANIM_FX_H
#define _ANIM_FX_H

#include <stdbool.h>

/**
 * Prototype for an effect-stepping function.
 *
 * Note that any effect-stepping function using static variables to keep
 * state makes the effect non-reentrant, and cannot be used in more than one
 * thread.
 *
 * @param first True if this is the function invocation for the first step.
 * @param pnext Location of the pointer to this function, and for the pointer
 *              to the next effect-stepping function to call, after the
 *              returned delay elapsed.
 *
 * @return The delay after which the function pointed to by pnext will be
 *         called.
 */
typedef unsigned int (*anim_fx_fn)(bool first, void **pnext);

/** Stop animation forever */
extern unsigned int anim_fx_stop(bool first, void **pnext_fx);

/** Shimmer stars forever */
extern unsigned int anim_fx_stars_shimmer(bool first, void **pnext_fx);

/** Fade in the topper to max brightness, then stop */
extern unsigned int anim_fx_topper_fade_in(bool first, void **pnext_fx);

/**
 * Fade in the balls over 1.5s, wait 10 seconds, then fade out over 1.5s,
 * and run random balls effects forever.
 */
extern unsigned int anim_fx_balls_fade_in_and_out(bool first, void **pnext_fx);

/** Send waves through the balls, then run random balls effects forever */
extern unsigned int anim_fx_balls_wave(bool first, void **pnext_fx);

/** Glitter the balls, then run random balls effects forever */
extern unsigned int anim_fx_balls_glitter(bool first, void **pnext_fx);

/** Cycle ball colors, then run random balls effects forever */
extern unsigned int anim_fx_balls_cycle_colors(bool first, void **pnext_fx);

/** Snow balls, then run random balls effects forever */
extern unsigned int anim_fx_balls_snow(bool first, void **pnext_fx);

/** Shimmer the balls, then run random balls effects forever */
extern unsigned int anim_fx_balls_shimmer(bool first, void **pnext_fx);

/** Shoot the balls onto and off the tree, run random effects forever */
extern unsigned int anim_fx_balls_shoot(bool first, void **pnext_fx);

/** Run random balls effects forever */
extern unsigned int anim_fx_balls_random(bool first, void **pnext_fx);

/** Flare the balls on and slowly off, run random effects forever */
extern unsigned int anim_fx_balls_flare(bool first, void **pnext_fx);

#endif /* _ANIM_FX_H */