#include <base_light_effects.h>

Inheritance diagram for esphome::light::FlickerLightEffect:

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.

virtual void	start_internal ()

virtual void	stop ()
	Called when this effect is about to be removed.

const std::string &	get_name ()

virtual void	init ()
	Internal method called by the LightState when this light effect is registered in it.

void	init_internal (LightState *state)

uint32_t	get_index () const
	Get the index of this effect in the parent light's effect list.

bool	is_active () const
	Check if this effect is currently active.

LightState *	get_light_state () const
	Get a reference to the parent light state.

Protected Attributes
float	intensity_ {}

float	alpha_ {}

Protected Attributes inherited from esphome::light::LightEffect
LightState *	state_ {nullptr}

std::string	name_

Additional Inherited Members
Protected Member Functions inherited from esphome::light::LightEffect
uint32_t	get_index_in_parent_ () const
	Internal method to find this effect's index in the parent light's effect list.

Detailed Description

Definition at line 199 of file base_light_effects.h.

Constructor & Destructor Documentation

◆ FlickerLightEffect()

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

inlineexplicit

Definition at line 201 of file base_light_effects.h.

Member Function Documentation

◆ apply()

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

inlineoverridevirtual

Implements esphome::light::LightEffect.

Definition at line 203 of file base_light_effects.h.

◆ set_alpha()

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

inline

Definition at line 230 of file base_light_effects.h.

◆ set_intensity()

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

inline

Definition at line 231 of file base_light_effects.h.

Field Documentation

◆ alpha_

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

protected

Definition at line 235 of file base_light_effects.h.

◆ intensity_

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

protected

Definition at line 234 of file base_light_effects.h.

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

esphome/components/light/base_light_effects.h

Public Member Functions

Protected Attributes

Additional Inherited Members