esphome::light::LightEffectNames Class Reference

Effect names as the native API lists them: "None" first, then each effect; empty without effects. More...

#include <light_effect_names.h>

Data Structures
class	Iterator

Public Member Functions
	LightEffectNames (const ConstVector< LightEffect * > &effects)
ESPHOME_ALWAYS_INLINE Iterator	begin () const
ESPHOME_ALWAYS_INLINE Iterator	end () const
ESPHOME_ALWAYS_INLINE bool	empty () const

Protected Attributes
const ConstVector< LightEffect * > &	effects_

Detailed Description

Effect names as the native API lists them: "None" first, then each effect; empty without effects.

Reads the light's effect table directly, so listing entities allocates nothing. Holds a reference: it only lives for one synchronous encode, and by value costs flash on every copy.

Definition at line 12 of file light_effect_names.h.

Constructor & Destructor Documentation

LightEffectNames()

esphome::light::LightEffectNames::LightEffectNames ( const ConstVector< LightEffect * > & effects )

inlineexplicit

Definition at line 14 of file light_effect_names.h.

Member Function Documentation

begin()

ESPHOME_ALWAYS_INLINE Iterator esphome::light::LightEffectNames::begin ( ) const

inline

Definition at line 34 of file light_effect_names.h.

empty()

ESPHOME_ALWAYS_INLINE bool esphome::light::LightEffectNames::empty ( ) const

inline

Definition at line 38 of file light_effect_names.h.

end()

ESPHOME_ALWAYS_INLINE Iterator esphome::light::LightEffectNames::end ( ) const

inline

Definition at line 35 of file light_effect_names.h.

Field Documentation

effects_

const ConstVector<LightEffect *>& esphome::light::LightEffectNames::effects_

protected

Definition at line 41 of file light_effect_names.h.

---

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

• esphome/components/light/light_effect_names.h