roo_blink::RgbStep Class Reference

Single step of an RGB blink sequence. More...

#include <blinker.h>

Friends
class	RgbBlinker
constexpr RgbStep	RgbSetTo (Color color)
	Creates a step that sets the LED to the specified color instantly.
constexpr RgbStep	RgbHold (roo_time::Duration duration)
	Creates a step that holds the current color for the duration.
constexpr RgbStep	RgbTurnOff ()
	Creates a step that disables the LED. Equivalent to RgbSetTo(Color()).
constexpr RgbStep	RgbFadeTo (Color color, roo_time::Duration duration)
	Creates a step that fades to the target color over the duration.
constexpr RgbStep	RgbFadeOff (roo_time::Duration duration)
	Creates a step that fades the LED off over the duration.

Detailed Description

Single step of an RGB blink sequence.

Definition at line 15 of file blinker.h.

Friends And Related Symbol Documentation

RgbBlinker

friend class RgbBlinker

friend

Definition at line 24 of file blinker.h.

RgbFadeOff

constexpr RgbStep RgbFadeOff ( roo_time::Duration  duration )

friend

Creates a step that fades the LED off over the duration.

Definition at line 132 of file blinker.h.

RgbFadeTo

constexpr RgbStep RgbFadeTo ( Color  color, roo_time::Duration  duration  )

friend

Creates a step that fades to the target color over the duration.

Definition at line 128 of file blinker.h.

RgbHold

constexpr RgbStep RgbHold ( roo_time::Duration  duration )

friend

Creates a step that holds the current color for the duration.

Definition at line 124 of file blinker.h.

RgbSetTo

constexpr RgbStep RgbSetTo ( Color  color )

friend

Creates a step that sets the LED to the specified color instantly.

Definition at line 118 of file blinker.h.

RgbTurnOff

constexpr RgbStep RgbTurnOff ( )

friend

Creates a step that disables the LED. Equivalent to RgbSetTo(Color()).

Definition at line 122 of file blinker.h.

---

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

• temp_repos/roo_blink/src/roo_blink/rgb/blinker.h