Twinkle Effect

Copyright 2023 Ethan Christensen

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class bruhanimate.bruheffect.twinkle_effect.TWINKLE_SPEC(char: chr, value: int)[source]

Bases: object

A single twinkle character that cycles through brightness levels.

__init__(char: chr, value: int)[source]

Initializes the twinkle character.

Parameters:

  • char (chr) – Character to display.

  • value (int) – Initial brightness index (0–23).

next()[source]

Advances the brightness by one step and returns self.

copy()[source]

Returns a copy of this TWINKLE_SPEC.

Returns:

Copy with the same char, value, and mode.

Return type:

TWINKLE_SPEC

class bruhanimate.bruheffect.twinkle_effect.TwinkleEffect(buffer: Buffer, background: str, settings: TwinkleSettings = None)[source]

Bases: BaseEffect

A twinkling star-like effect where characters pulse in brightness.

__init__(buffer: Buffer, background: str, settings: TwinkleSettings = None)[source]

Initializes the TwinkleEffect.

Parameters:

  • buffer (Buffer) – Effect buffer to push updates to.

  • background (str) – Character or string to use as the background.

  • settings (TwinkleSettings, optional) – Configuration for the effect. Defaults to None.

set_density(density: float)[source]

Sets the density of twinkling characters.

Parameters:

density (float) – Fraction of cells that twinkle, between 0 and 1.

set_twinkle_chars(twinkle_chars: list[str])[source]

Sets the characters used for the twinkle effect.

Parameters:

twinkle_chars (list[str]) – List of characters to randomly assign to twinkle positions.

render_frame(frame_number: int)[source]

Renders the next frame of the twinkle effect.

Parameters:

frame_number (int) – The current frame number.