AaronLiddiment / LEDText

FastLED Flexible Text Message Class requires LEDMatrix Class
89 stars 32 forks source link

Documentation for EFFECT_HSV_xx #25

Closed CobaltEcho closed 2 years ago

CobaltEcho commented 2 years ago

Is there documentation anywhere on what the following effects do? I read the wiki and the Function List page tells how to use them, but not what the effect actually is.

EFFECT_HSV_CV
EFFECT_HSV_CH
EFFECT_HSV_AV
EFFECT_HSV_AH

And the gradient versions:

COLR_GRAD_CV
COLR_GRAD_AV
COLR_GRAD_CH
COLR_GRAD_AH
AaronLiddiment commented 2 years ago

The Effect ones are listed on Page 4 of the Wiki and the Grad ones are for use with the function call SetTextColrOptions. Basically the V refers to vertical change, and the H refers to horizontal change. The C then refers to the character (graduates over the character width or height), and the A refers to the text area (graduates over the text area width or height). I hope that makes sense. The Effect ones are for use as part of the unsigned char text array that you pass to SetText whereas all the defines upto the Effect ones in the header are to be used with the SetTextColrOptions(), SetBackgroundMode() and SetOptionsChangeMode() calls.

CobaltEcho commented 2 years ago

Thanks again for your help! My project is coming along really well with your resources!