Struct roccat_vulcan_api_rs::ColorBuffer

pub struct ColorBuffer<T> { /* fields omitted */ }

Encode the set of color for crate::KeyboardApi::render.

Example

 use std::{thread::sleep, time::Duration};

 use roccat_vulcan_api_rs::{ColorBuffer, ColorRgb, ErrorRoccatVulcanApi, KeyboardApi};

 let keyboard = KeyboardApi::new()?;
 let buffer = ColorBuffer::from_element(ColorRgb::new(255, 0, 255));
 keyboard.render(&buffer)?;
 sleep(Duration::from_secs(1));

Implementations

impl<T> ColorBuffer<T>

pub const fn from_array(buffer: [T; 144]) -> Self

Create a buffer from an array

pub const fn buffer(&self) -> &[T; 144]

Get the buffer as an array

pub fn buffer_mut(&mut self) -> &mut [T; 144]

Get a mutable reference to the buffer as an array

pub fn get<I: SliceIndex<[T]>>(&self, index: I) -> Option<&I::Output>

See https://doc.rust-lang.org/std/primitive.slice.html#method.get

pub fn get_mut<I: SliceIndex<[T]>>(
    &mut self,
    index: I
) -> Option<&mut I::Output>

See https://doc.rust-lang.org/std/primitive.slice.html#method.get_mut

pub fn iter(
    &self
) -> impl Iterator<Item = &T> + FusedIterator + ExactSizeIterator + DoubleEndedIterator

Returns an iterator in the colors

pub fn iter_mut(
    &mut self
) -> impl Iterator<Item = &mut T> + FusedIterator + ExactSizeIterator + DoubleEndedIterator

Return an mutable iterator on the colors

impl<C: Into<ColorRgb> + Clone> ColorBuffer<C>

pub fn get_led_buffer(&self) -> [u8; 455]

Get an array of u8 that is ready to be send to the led device

impl<T: Copy> ColorBuffer<T>

pub fn from_element(color: T) -> Self

Create the buffer with the same color for each key

impl<T: Copy + Default> ColorBuffer<T>

pub fn new() -> Self

Create a new buffer with default values

Trait Implementations

impl<T: Clone> Clone for ColorBuffer<T>

fn clone(&self) -> ColorBuffer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ColorBuffer<T>

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

Formats the value using the given formatter.

impl<T: Default + Copy> Default for ColorBuffer<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Display> Display for ColorBuffer<T>

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

Formats the value using the given formatter.

impl<T> From<[T; 144]> for ColorBuffer<T>

fn from(array: [T; 144]) -> Self

Performs the conversion.

impl<T> From<ColorBuffer<T>> for [T; 144]

fn from(c_buffer: ColorBuffer<T>) -> Self

Performs the conversion.

impl<T: Hash> Hash for ColorBuffer<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T, I: SliceIndex<[T]>> Index<I> for ColorBuffer<T>

fn index(&self, index: I) -> &Self::Output

Panic

panics in the case where index >= NUMBER_KEY_LED_BUFFER

use roccat_vulcan_api_rs::{ColorBuffer, ColorRgb, NUMBER_KEY_LED_BUFFER};

let color_buffer = ColorBuffer::from_element(ColorRgb::new(255, 0, 0));
let _ = color_buffer[NUMBER_KEY_LED_BUFFER];

type Output = I::Output

The returned type after indexing.

impl<T, I: SliceIndex<[T]>> IndexMut<I> for ColorBuffer<T>

fn index_mut(&mut self, index: I) -> &mut Self::Output

Panic

panics in the case where index >= NUMBER_KEY_LED_BUFFER

use roccat_vulcan_api_rs::{ColorBuffer, ColorRgb, NUMBER_KEY_LED_BUFFER};

let mut color_buffer = ColorBuffer::from_element(ColorRgb::new(255, 0, 0));
color_buffer[NUMBER_KEY_LED_BUFFER] = ColorRgb::new(255, 255, 255);

impl<'a, T> IntoIterator for &'a ColorBuffer<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = <&'a [T; 144] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut ColorBuffer<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = <&'a mut [T; 144] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for ColorBuffer<T>

fn cmp(&self, other: &ColorBuffer<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<ColorBuffer<T>> for ColorBuffer<T>

fn eq(&self, other: &ColorBuffer<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ColorBuffer<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<ColorBuffer<T>> for ColorBuffer<T>

fn partial_cmp(&self, other: &ColorBuffer<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy> Copy for ColorBuffer<T>

impl<T: Eq> Eq for ColorBuffer<T>

impl<T> StructuralEq for ColorBuffer<T>

impl<T> StructuralPartialEq for ColorBuffer<T>