ESPHome  2022.9.2
Public Member Functions | Protected Attributes
esphome::light::FlickerLightEffect Class Reference

#include <base_light_effects.h>

Inheritance diagram for esphome::light::FlickerLightEffect:
esphome::light::LightEffect

Public Member Functions

 FlickerLightEffect (const std::string &name)
 
void apply () override
 
void set_alpha (float alpha)
 
void set_intensity (float intensity)
 
- Public Member Functions inherited from esphome::light::LightEffect
 LightEffect (std::string name)
 
virtual void start ()
 Initialize this LightEffect. Will be called once after creation. More...
 
virtual void start_internal ()
 
virtual void stop ()
 Called when this effect is about to be removed. More...
 
const std::string & get_name ()
 
virtual void init ()
 Internal method called by the LightState when this light effect is registered in it. More...
 
void init_internal (LightState *state)
 

Protected Attributes

float intensity_ {}
 
float alpha_ {}
 
- Protected Attributes inherited from esphome::light::LightEffect
LightStatestate_ {nullptr}
 
std::string name_
 

Detailed Description

Definition at line 180 of file base_light_effects.h.

Constructor & Destructor Documentation

◆ FlickerLightEffect()

esphome::light::FlickerLightEffect::FlickerLightEffect ( const std::string &  name)
inlineexplicit

Definition at line 182 of file base_light_effects.h.

Member Function Documentation

◆ apply()

void esphome::light::FlickerLightEffect::apply ( )
inlineoverridevirtual

Implements esphome::light::LightEffect.

Definition at line 184 of file base_light_effects.h.

◆ set_alpha()

void esphome::light::FlickerLightEffect::set_alpha ( float  alpha)
inline

Definition at line 211 of file base_light_effects.h.

◆ set_intensity()

void esphome::light::FlickerLightEffect::set_intensity ( float  intensity)
inline

Definition at line 212 of file base_light_effects.h.

Field Documentation

◆ alpha_

float esphome::light::FlickerLightEffect::alpha_ {}
protected

Definition at line 216 of file base_light_effects.h.

◆ intensity_

float esphome::light::FlickerLightEffect::intensity_ {}
protected

Definition at line 215 of file base_light_effects.h.


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