Interface IRGBDevice

Exposes the enumerator, which supports a simple iteration over a collection of a specified type.

Inherited Members
Namespace: RGB.NET.Core
Assembly: RGB.NET.Core.dll
Syntax
public interface IRGBDevice : IEnumerable<Led>, IEnumerable, IPlaceable, IBindable, INotifyPropertyChanged, IDisposable

Properties

| Edit this page View Source

ColorCorrections

Gets a list of color corrections applied to this device.

Declaration
IList<IColorCorrection> ColorCorrections { get; }
Property Value
Type Description
IList<IColorCorrection>
| Edit this page View Source

DeviceInfo

Gets generic information about the IRGBDevice.

Declaration
IRGBDeviceInfo DeviceInfo { get; }
Property Value
Type Description
IRGBDeviceInfo
| Edit this page View Source

this[LedId]

Gets the Led with the specified LedId.

Declaration
Led? this[LedId ledId] { get; }
Parameters
Type Name Description
LedId ledId

The LedId of the Led to get.
Property Value
Type Description
Led

The Led with the specified LedId or null if no Led is found.
| Edit this page View Source

this[Point]

Gets the Led at the specified physical location.

Declaration
Led? this[Point location] { get; }
Parameters
Type Name Description
Point location

The Point to get the location from.
Property Value
Type Description
Led

The Led at the specified Point or null if no location is found.
| Edit this page View Source

this[Rectangle, double]

Gets a list of Led inside the specified Rectangle.

Declaration
IEnumerable<Led> this[Rectangle referenceRect, double minOverlayPercentage = 0.5] { get; }
Parameters
Type Name Description
Rectangle referenceRect

The Rectangle to check.
double minOverlayPercentage

The minimal percentage overlay a Led must have with the Rectangle to be taken into the list.
Property Value
Type Description
IEnumerable<Led>

A enumerable of leds inside the specified rectangle.
| Edit this page View Source

Surface

Gets the surface this device is attached to.

Declaration
RGBSurface? Surface { get; }
Property Value
Type Description
RGBSurface

Methods

| Edit this page View Source

AddLed(LedId, in Point, in Size, object?)

Adds a led to the device.

Declaration
Led? AddLed(LedId ledId, in Point location, in Size size, object? customData = null)
Parameters
Type Name Description
LedId ledId

The id of the led.
Point location

The location of the led on the device.
Size size

The size of the led.
object customData

Custom data saved on the led.
Returns
Type Description
Led

The newly added led or null if a led with this id is already added.
| Edit this page View Source

RemoveLed(LedId)

Removes the led with the specified id from the device.

Declaration
Led? RemoveLed(LedId ledId)
Parameters
Type Name Description
LedId ledId

The id of the led to remove.
Returns
Type Description
Led

The removed led or null if there was no led with the specified id.
| Edit this page View Source

Update(bool)

Perform an update for all dirty Led, or all Led if flushLeds is set to true.

Declaration
void Update(bool flushLeds = false)
Parameters
Type Name Description
bool flushLeds

Specifies whether all Led (including clean ones) should be updated.