Struct Filter 

pub struct Filter { /* private fields */ }

A Filter is a set of LEDs that can be obtained via one of Sled’s getter-type methods.

They are particularly useful for scenarios when you have computationally expensive calculations and you want to limit which LEDs those calculations are run on. Once you’ve created a filter, you can save it to Data for use in draw/compute stages. Using this pattern, we can pre-compute important sets at startup and then store them to the driver for later usage.

driver.set_startup_commands(|sled, data| {
    let area: Filter = sled.within_dist_from(
        5.0, Vec2::new(-0.25, 1.5)
    );

   data.set("area_of_effect", area);
    Ok(())
});
driver.set_draw_commands(|sled, data, _| {
    let area_filter = data.get("area_of_effect")?;
    sled.modulate_filter(area_filter, |led| {
        // expensive computation
    });
    Ok(())
});

Implementations

impl Filter

pub fn len(&self) -> usize

Returns the number of leds contained in the underlying set.

pub fn is_empty(&self) -> bool

Returns true if the underlying set is empty.

pub fn and(&self, other: &Self) -> Self

Returns a new Filter containing all lEDs that were in both this and the inputted other Filter.

pub fn or(&self, other: &Self) -> Self

Returns a new Filter containing all lEDs that were in either this or the inputted other Filter.

Trait Implementations

impl Clone for Filter

fn clone(&self) -> Filter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Filter

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

Formats the value using the given formatter.

impl Extend<u16> for Filter

fn extend<T: IntoIterator<Item = u16>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<Color: ColorType> From<&[Led<Color>]> for Filter

fn from(value: &[Led<Color>]) -> Self

Converts to this type from the input type.

impl From<BTreeSet<u16>> for Filter

fn from(value: BTreeSet<u16>) -> Self

Converts to this type from the input type.

impl FromIterator<u16> for Filter

fn from_iter<T: IntoIterator<Item = u16>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for &Filter

type Item = u16

The type of the elements being iterated over.

type IntoIter = IntoIter<u16>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Filter

type Item = u16

The type of the elements being iterated over.

type IntoIter = IntoIter<u16>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Filter

fn eq(&self, other: &Filter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Filter

impl StructuralPartialEq for Filter