ColorShift
Quick Start
from terminaltexteffects import Gradient
from terminaltexteffects.effects.effect_colorshift import ColorShift
effect = ColorShift("YourTextHere")
effect.effect_config.travel = True
effect.effect_config.travel_direction = Gradient.Direction.RADIAL
with effect.terminal_output() as terminal:
for frame in effect:
terminal.print(frame)
Display a gradient that shifts colors across the terminal.
Classes:
Name | Description |
---|---|
ColorShift |
Display a gradient that shifts colors across the terminal. |
ColorShiftConfig |
Configuration for the ColorShift effect. |
ColorShiftIterator |
Iterator for the ColorShift effect. Does not normally need to be called directly. |
ColorShift
Bases: BaseEffect[ColorShiftConfig]
Display a gradient that shifts colors across the terminal.
Source code in terminaltexteffects/effects/effect_colorshift.py
ColorShiftConfig
dataclass
Bases: ArgsDataClass
Configuration for the ColorShift effect.
Attributes:
Name | Type | Description |
---|---|---|
gradient_stops |
tuple[Color, ...]
|
Tuple of colors for the gradient. If only one color is provided, the characters will be displayed in that color. |
gradient_steps |
tuple[int, ...] | int
|
Tuple of the number of gradient steps to use. More steps will create a smoother and longer gradient animation. Valid values are n > 0. |
gradient_frames |
int
|
Number of frames to display each gradient step. Increase to slow down the gradient animation. |
no_loop |
bool
|
Do not loop the gradient. If not set, the gradient generation will loop the final gradient color back to the first gradient color. |
travel |
bool
|
Display the gradient as a traveling wave. |
travel_direction |
Direction
|
Direction the gradient travels across the canvas. |
reverse_travel_direction |
bool
|
Reverse the gradient travel direction. |
cycles |
int
|
Number of times to cycle the gradient. Use 0 for infinite. Valid values are n >= 0. |
skip_final_gradient |
bool
|
Skip the final gradient. |
final_gradient_stops |
tuple[Color, ...]
|
Tuple of colors for the final color gradient. If only one color is provided, the characters will be displayed in that color. |
final_gradient_steps |
tuple[int, ...] | int
|
Tuple of the number of gradient steps to use for the final gradient. More steps will create a smoother and longer gradient animation. Valid values are n > 0. |
final_gradient_direction |
Direction
|
Direction of the final gradient across the canvas. |
Source code in terminaltexteffects/effects/effect_colorshift.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
|
cycles = ArgField(cmd_name='--cycles', type_parser=argvalidators.PositiveInt.type_parser, default=3, metavar=argvalidators.PositiveInt.METAVAR, help='Number of times to cycle the gradient.')
class-attribute
instance-attribute
int : Number of times to cycle the gradient. Use 0 for infinite.
final_gradient_direction = ArgField(cmd_name='--final-gradient-direction', type_parser=argvalidators.GradientDirection.type_parser, default=Gradient.Direction.VERTICAL, metavar=argvalidators.GradientDirection.METAVAR, help='Direction of the final gradient.')
class-attribute
instance-attribute
Gradient.Direction : Direction of the final gradient.
final_gradient_steps = ArgField(cmd_name=['--final-gradient-steps'], type_parser=argvalidators.PositiveInt.type_parser, nargs='+', default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Space separated, unquoted, list of the number of gradient steps to use. More steps will create a smoother and longer gradient animation.')
class-attribute
instance-attribute
tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will create a smoother and longer gradient animation.
final_gradient_stops = ArgField(cmd_name=['--final-gradient-stops'], type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('e81416'), Color('ffa500'), Color('faeb36'), Color('79c314'), Color('487de7'), Color('4b369d'), Color('70369d')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one color is provided, the characters will be displayed in that color.')
class-attribute
instance-attribute
tuple[Color, ...] : Tuple of colors for the final color gradient. If only one color is provided, the characters will be displayed in that color.
gradient_frames = ArgField(cmd_name='--gradient-frames', type_parser=argvalidators.PositiveInt.type_parser, default=5, metavar=argvalidators.PositiveInt.METAVAR, help='Number of frames to display each gradient step. Increase to slow down the gradient animation.')
class-attribute
instance-attribute
int : Number of frames to display each gradient step. Increase to slow down the gradient animation.
gradient_steps = ArgField(cmd_name='--gradient-steps', type_parser=argvalidators.PositiveInt.type_parser, nargs='+', default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Number of gradient steps to use. More steps will create a smoother gradient animation.')
class-attribute
instance-attribute
tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will create a smoother and longer gradient animation.
gradient_stops = ArgField(cmd_name=['--gradient-stops'], type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('e81416'), Color('ffa500'), Color('faeb36'), Color('79c314'), Color('487de7'), Color('4b369d'), Color('70369d')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the gradient.')
class-attribute
instance-attribute
tuple[Color, ...] : Tuple of colors for the gradient. If only one color is provided, the characters will be displayed in that color.
no_loop = ArgField(cmd_name='--no-loop', action='store_true', help='Do not loop the gradient. If not set, the gradient generation will loop the final gradient color back to the first gradient color.')
class-attribute
instance-attribute
bool : Do not loop the gradient. If not set, the gradient generation will loop the final gradient color back to the first gradient color.
reverse_travel_direction = ArgField(cmd_name='--reverse-travel-direction', action='store_true', help='Reverse the gradient travel direction.')
class-attribute
instance-attribute
bool : Reverse the gradient travel direction.
skip_final_gradient = ArgField(cmd_name='--skip-final-gradient', action='store_true', help='Skip the final gradient.')
class-attribute
instance-attribute
bool : Skip the final gradient.
travel = ArgField(cmd_name='--travel', action='store_true', help='Display the gradient as a traveling wave')
class-attribute
instance-attribute
bool : Display the gradient as a traveling wave.
travel_direction = ArgField(cmd_name='--travel-direction', default=Gradient.Direction.HORIZONTAL, type_parser=argvalidators.GradientDirection.type_parser, metavar=argvalidators.GradientDirection.METAVAR, help='Direction the gradient travels across the canvas.')
class-attribute
instance-attribute
Gradient.Direction : Direction the gradient travels across the canvas.
get_effect_class()
classmethod
ColorShiftIterator
Bases: BaseEffectIterator[ColorShiftConfig]
Iterator for the ColorShift effect.
Source code in terminaltexteffects/effects/effect_colorshift.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
|
__init__(effect)
Initialize the iterator with the provided effect.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
effect
|
ColorShift
|
The effect to use for the iterator. |
required |
Source code in terminaltexteffects/effects/effect_colorshift.py
__next__()
Return the next frame in the animation.
build()
Build the initial state of the effect.
Source code in terminaltexteffects/effects/effect_colorshift.py
loop_tracker(character)
Track the number of times a character has looped through the gradient.