ledfx
    Preparing search index...

    Interface Texter2dEffectConfig

    Specific configuration for the 'texter2d' effect.

    interface Texter2dEffectConfig {
        alpha?: boolean;
        deep_diag?: boolean;
        font?:
            | "Blade-5x8"
            | "Roboto Regular"
            | "Roboto Bold"
            | "Roboto Black"
            | "Stop"
            | "Technique"
            | "8bitOperatorPlus8"
            | "Press Start 2P";
        height_percent?: number;
        impulse_decay?: number;
        multiplier?: number;
        option_1?: boolean;
        option_2?: boolean;
        resize_method?: "Fast"
        | "Fastest"
        | "Slow";
        speed_option_1?: number;
        text?: string;
        text_color?: string;
        text_effect?:
            | "Side Scroll"
            | "Spokes"
            | "Carousel"
            | "Wave"
            | "Pulse"
            | "Fade";
        type: "texter2d";
        use_gradient?: boolean;
        value_option_1?: number;
    }
    Index

    Properties

    alpha?: boolean

    apply alpha effect to text

    False
    
    deep_diag?: boolean

    Diagnostic overlayed on matrix

    False
    
    font?:
        | "Blade-5x8"
        | "Roboto Regular"
        | "Roboto Bold"
        | "Roboto Black"
        | "Stop"
        | "Technique"
        | "8bitOperatorPlus8"
        | "Press Start 2P"

    Font to render text with

    'Press Start 2P'
    
    height_percent?: number

    Font size as a percentage of the display height, fonts are unpredictable!

    100
    

    10

    150

    impulse_decay?: number

    Decay filter applied to the impulse for development

    0.1
    

    0.01

    0.3

    multiplier?: number

    multiplier of audio effect injection

    1
    

    0.0

    10

    option_1?: boolean

    Text effect specific option switch

    False
    
    option_2?: boolean

    Text effect specific option switch

    False
    
    resize_method?: "Fast" | "Fastest" | "Slow"

    What aliasing strategy to use when manipulating text elements

    'Fast'
    
    speed_option_1?: number

    general speed slider for text effects

    1
    

    0.0

    3

    text?: string

    Your text to display

    'Your text here'
    
    text_color?: string

    Color of text

    '#FFFFFF'
    
    text_effect?: "Side Scroll" | "Spokes" | "Carousel" | "Wave" | "Pulse" | "Fade"

    Text effect to apply to configuration

    'Side Scroll'
    
    type: "texter2d"
    use_gradient?: boolean

    Use gradient for word colors

    False
    
    value_option_1?: number

    general value slider for text effects

    0.5
    

    0.0

    1.0