Pixie Chroma
Documentation for the easiest 5x7 LED displays for Arduino!
pixie_animations.h File Reference
#include "../Pixie_Chroma.h"

Go to the source code of this file.

Functions

void ANIMATION_NULL (PixieChroma *_p, float delta)
 It does nothing, but it does nothing REALLY WELL! You can enable this empty function with pix.set_animation(ANIMATION_NULL) to fully manually control LEDs when you want using pix.show(). More...
 
void ANIMATION_STATIC (PixieChroma *_p, float delta)
 Shows the current color palette without animation. More...
 
void ANIMATION_PALETTE_SHIFT_LEFT (PixieChroma *_p, float delta)
 Shows the current color palette, while constantly shifting it to the left. More...
 
void ANIMATION_PALETTE_SHIFT_RIGHT (PixieChroma *_p, float delta)
 Shows the current color palette, while constantly shifting it to the right. More...
 
void ANIMATION_GLITTER (PixieChroma *_p, float delta)
 Shows the current color palette with a sparkling effect. More...
 
void ANIMATION_PENDULUM (PixieChroma *_p, float delta)
 Sways the current color palette left and right with a sine function at 1Hz intervals. More...
 
void ANIMATION_PENDULUM_WIDE (PixieChroma *_p, float delta)
 Sways the current color palette left and right with a sine function at 1Hz intervals. Wider travel than ANIMATION_PENDULUM. More...
 
void _PALETTE_SHIFT (PixieChroma *_p, int8_t amount, float delta)
 Internal animation, shifts the color palette a fixed amount on each run. More...
 
void _PENDULUM (PixieChroma *_p, float center_position, float sway_width)
 Internal animation that sways the current color palette left and right with a sine function at 1Hz intervals. (Custom width) More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2, CRGB col3)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2, CRGB col3, CRGB col4)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2, CRGB col3, CRGB col4, CRGB col5)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2, CRGB col3, CRGB col4, CRGB col5, CRGB col6)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2, CRGB col3, CRGB col4, CRGB col5, CRGB col6, CRGB col7)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 
CRGBPalette16 make_gradient (CRGB col1, CRGB col2, CRGB col3, CRGB col4, CRGB col5, CRGB col6, CRGB col7, CRGB col8)
 Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient. More...
 

Detailed Description

Designed specifically to work with Pixie Chroma: -—> https://connornishijima.github.io/PixieChroma

Last Updated by Connor Nishijima on 10/21/21

Definition in file pixie_animations.h.

Function Documentation

◆ ANIMATION_NULL()

void ANIMATION_NULL ( PixieChroma _p,
float  delta 
)

It does nothing, but it does nothing REALLY WELL! You can enable this empty function with pix.set_animation(ANIMATION_NULL) to fully manually control LEDs when you want using pix.show().

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 12 of file pixie_animations.cpp.

◆ ANIMATION_STATIC()

void ANIMATION_STATIC ( PixieChroma _p,
float  delta 
)

Shows the current color palette without animation.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 18 of file pixie_animations.cpp.

◆ ANIMATION_PALETTE_SHIFT_LEFT()

void ANIMATION_PALETTE_SHIFT_LEFT ( PixieChroma _p,
float  delta 
)

Shows the current color palette, while constantly shifting it to the left.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 46 of file pixie_animations.cpp.

◆ ANIMATION_PALETTE_SHIFT_RIGHT()

void ANIMATION_PALETTE_SHIFT_RIGHT ( PixieChroma _p,
float  delta 
)

Shows the current color palette, while constantly shifting it to the right.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 51 of file pixie_animations.cpp.

◆ ANIMATION_GLITTER()

void ANIMATION_GLITTER ( PixieChroma _p,
float  delta 
)

Shows the current color palette with a sparkling effect.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 56 of file pixie_animations.cpp.

◆ ANIMATION_PENDULUM()

void ANIMATION_PENDULUM ( PixieChroma _p,
float  delta 
)

Sways the current color palette left and right with a sine function at 1Hz intervals.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 94 of file pixie_animations.cpp.

◆ ANIMATION_PENDULUM_WIDE()

void ANIMATION_PENDULUM_WIDE ( PixieChroma _p,
float  delta 
)

Sways the current color palette left and right with a sine function at 1Hz intervals. Wider travel than ANIMATION_PENDULUM.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 100 of file pixie_animations.cpp.

◆ _PALETTE_SHIFT()

void _PALETTE_SHIFT ( PixieChroma _p,
int8_t  amount,
float  delta 
)

Internal animation, shifts the color palette a fixed amount on each run.

Parameters
_pUsed to pass a reference to the PixieChroma class instance
amountAmount to shift the color palette (in 1/256ths) each frame
deltaUsed to regulate animation playback consistency if performance drops

Definition at line 30 of file pixie_animations.cpp.

◆ _PENDULUM()

void _PENDULUM ( PixieChroma _p,
float  center_position,
float  sway_width 
)

Internal animation that sways the current color palette left and right with a sine function at 1Hz intervals. (Custom width)

Parameters
_pUsed to pass a reference to the PixieChroma class instance
center_positionOffset of the color palette left or right
sway_widthOffset multiplier

Definition at line 72 of file pixie_animations.cpp.

◆ make_gradient() [1/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 106 of file pixie_animations.cpp.

◆ make_gradient() [2/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2,
CRGB  col3 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
col3Third color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 117 of file pixie_animations.cpp.

◆ make_gradient() [3/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2,
CRGB  col3,
CRGB  col4 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
col3Third color
col4Fourth color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 129 of file pixie_animations.cpp.

◆ make_gradient() [4/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2,
CRGB  col3,
CRGB  col4,
CRGB  col5 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
col3Third color
col4Fourth color
col5Fifth color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 142 of file pixie_animations.cpp.

◆ make_gradient() [5/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2,
CRGB  col3,
CRGB  col4,
CRGB  col5,
CRGB  col6 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
col3Third color
col4Fourth color
col5Fifth color
col6Sixth color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 156 of file pixie_animations.cpp.

◆ make_gradient() [6/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2,
CRGB  col3,
CRGB  col4,
CRGB  col5,
CRGB  col6,
CRGB  col7 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
col3Third color
col4Fourth color
col5Fifth color
col6Sixth color
col7Seventh color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 171 of file pixie_animations.cpp.

◆ make_gradient() [7/7]

CRGBPalette16 make_gradient ( CRGB  col1,
CRGB  col2,
CRGB  col3,
CRGB  col4,
CRGB  col5,
CRGB  col6,
CRGB  col7,
CRGB  col8 
)

Converts a set of CRGB colors to a gradient, and creates a color palette from that gradient.

Parameters
col1First color
col2Second color
col3Third color
col4Fourth color
col5Fifth color
col6Sixth color
col7Seventh color
col8Eighth color
Returns
A CRGBPalette16 object for use with set_palette()

Definition at line 187 of file pixie_animations.cpp.