FastLED 3.9.15
Loading...
Searching...
No Matches
fl::WaveFxArgs Struct Reference

Detailed Description

Configuration parameters for WaveFx effect.

Defines all the settings that control wave behavior including simulation quality, physics parameters, and color mapping.

Definition at line 102 of file wave.h.

#include <wave.h>

Public Member Functions

 WaveFxArgs () FL_NOEXCEPT=default
 
 WaveFxArgs (const WaveFxArgs &) FL_NOEXCEPT=default
 
 WaveFxArgs (SuperSample factor, bool half_duplex, bool auto_updates, float speed, float dampening, WaveCrgbMapPtr crgbMap)
 Construct with all parameters.
 
WaveFxArgsoperator= (const WaveFxArgs &) FL_NOEXCEPT=default
 

Public Attributes

bool auto_updates = true
 If true, simulation advances automatically in draw()
 
WaveCrgbMapPtr crgbMap
 Custom color mapper (nullptr uses default grayscale)
 
float dampening = 6.0f
 Energy dampening factor (higher = faster decay, typical: 3-10)
 
SuperSample factor = SuperSample::SUPER_SAMPLE_2X
 Supersampling quality (SUPER_SAMPLE_2X recommended for balance)
 
bool half_duplex = true
 If true, constrains waves to positive values only.
 
float speed = 0.16f
 Wave propagation speed (0.0-1.0, typical: 0.1-0.3)
 
bool use_change_grid = false
 Use change grid tracking for optimization (may reduce visual quality)
 
bool x_cyclical = false
 If true, waves wrap around the x-axis (cylindrical topology)
 

The documentation for this struct was generated from the following file: