Struct vcs_classic_hid::led::LedReport

pub struct LedReport(_);

Structure representing a report for LED activation on the controller.

Implementations

impl LedReport

pub fn new() -> Self

Create a new LED report.

By default, an LED report will turn off all LEDs.

pub fn filled(value: u8) -> Self

Create a new LED report filled with the given intensity value.

pub fn clear(&mut self)

Turn all ring of LEDs off.

pub fn fill(&mut self, value: u8)

Set all LEDs in the ring to the given value.

pub fn set_fuji(&mut self, value: u8)

Set the Fuji LED to a value.

pub fn set(&mut self, led: u8, value: u8)

Set a LED in the ring to a value.

pub fn set_selection(&mut self, selection: LedSelection, value: u8)

Set a selection of LEDs in the ring to a value.

pub fn invert(&mut self, led: u8)

Invert the value of the LED in the ring.

pub fn invert_selection(&mut self, selection: LedSelection)

Invert the values of a selection of the LED in the ring.

pub fn saturating_add(&mut self, led: u8, value_delta: i16)

Add an intensity to a LED in the ring.

The addition is relative to the receiving report value, and not the current state of the LEDs in the controller. Values are automatically clamped to the limits of the device.

pub fn saturating_add_selection(
    &mut self,
    selection: LedSelection,
    value_delta: i16
)

Add an intensity to a selection of LEDs in the ring.

The addition is relative to the receiving report value, and not the current state of the LEDs in the controller. Values are automatically clamped to the limits of the device.

pub fn send<D>(&self, device: D) -> Result<(), D::Error> where
    D: Device, 

Send this report as an HID message to the given device.

Safety: although not memory unsafe, the operation must be done on a readily available device handle for the Atari Classic Controller. The effects on any other device are unknown and potentially dangerous.

Trait Implementations

impl AsRef<[u8]> for LedReport

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Clone for LedReport

fn clone(&self) -> LedReport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LedReport

impl Debug for LedReport

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

Formats the value using the given formatter.

impl Default for LedReport

By default, an LED report will turn off all LEDs.

fn default() -> Self

Returns the “default value” for a type.

impl Eq for LedReport

impl PartialEq<LedReport> for LedReport

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

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

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

This method tests for !=.

impl StructuralEq for LedReport

impl StructuralPartialEq for LedReport