Struct rs_ws281x::Controller

pub struct Controller { /* fields omitted */ }

The main struct used to control lights. Provides ways of accessing the light color values and rendering those values to the string.

Implementations

impl Controller

pub fn new(c_struct: ws2811_t) -> Self

Creates a new Controller

Note: This is only to be called from the Builder struct

pub fn render(&mut self) -> Result<()>

Render the colors to the string.

It doesn't automatically do this because it is a somewhat costly operation that should be batched.

pub fn wait(&mut self) -> Result<()>

Wait for a render to be completed.

pub fn channels(&self) -> Vec<usize>

Gets the channels with non-zero number of LED's associated with them.

I know this is somewhat non-intuitive, but naming it something like active_channels(&self) seemed overly verbose.

pub fn brightness(&self, channel: usize) -> u8

Gets the brightness of the LEDs

pub fn set_brightness(&mut self, channel: usize, value: u8)

Sets the brighness of the LEDs

pub fn leds(&self, channel: usize) -> &[RawColor]

Gets a slice view to the color array to be written to the LEDs. See leds_mut for a mutable slice view to this data.

Safety

This function is moderately unsafe because we rely on the promise from the C library that it will stick to its memory layout and that the pointer is valid.

pub fn leds_mut(&mut self, channel: usize) -> &mut [RawColor]

Gets a mutable slice pointing to the color array to be written to the LEDs.

Safety

This function is moderately unsafe because we rely on the promise from the C library that it will stick to its memory layout and that the pointer is valid.

Trait Implementations

impl Clone for Controller

pub fn clone(&self) -> Controller

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Controller

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Controller

pub fn drop(&mut self)

Executes the destructor for this type.