Treehopper C# API
IFlushable Interface Reference

Represents any object that has a flushable interface More...

Inheritance diagram for IFlushable:
Apa102 GraphicDisplay ILedDriver LedDisplay LedDisplayCollection RgbLed IFlushableOutputPort< TDigitalPin > ChainableShiftRegisterOutput Pca9685

Public Member Functions

Task FlushAsync (bool force=false)
 Flush changed data to the port expander More...
 

Properties

bool AutoFlush [get, set]
 Whether this interface should automatically flush new values or not More...
 
IFlushable Parent [get]
 Gets or sets the parent flushable device (if it exists); if this property is set by this driver, it is expected that flushing the parent will also flush this device More...
 

Detailed Description

Represents any object that has a flushable interface

Member Function Documentation

◆ FlushAsync()

Task FlushAsync ( bool  force = false)

Flush changed data to the port expander

Parameters
forcewhether to flush all data to the port expander, even if it doesn't appear to have been changed

Implemented in Max7219, Pca9685, LedDriver, BarGraph, ChainableShiftRegisterOutput, RgbLed, Tm1650, Ht16k33, GraphicDisplay, Apa102, Is31fl3218, LedDisplayCollection, GpioLedDriver< TDigitalOutPin >, and PwmLedDriver< TPwm >.

Property Documentation

◆ AutoFlush

bool AutoFlush
getset

Whether this interface should automatically flush new values or not

◆ Parent

IFlushable Parent
get

Gets or sets the parent flushable device (if it exists); if this property is set by this driver, it is expected that flushing the parent will also flush this device

This property is designed to make LED displays, which operate across groups of LEDs (and possibly groups of LED drivers), much more efficient to update. Many commonly-used LED drivers are shift registers that are chained together; since these cannot be individually addressed, any write to one must include a write to all the other ones. By properly setting the parent shift register in each chain, displays can optimize these updates.


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