Show / Hide Table of Contents

Class Led

Represents a placeable element.

Inheritance
object
AbstractBindable
Placeable
Led
Implements
IBindable
INotifyPropertyChanged
IPlaceable
Inherited Members
Placeable.Location
Placeable.Size
Placeable.Scale
Placeable.Rotation
Placeable.ActualLocation
Placeable.ActualSize
Placeable.Boundary
Placeable.LocationChanged
Placeable.SizeChanged
Placeable.ScaleChanged
Placeable.RotationChanged
Placeable.ActualLocationChanged
Placeable.ActualSizeChanged
Placeable.BoundaryChanged
AbstractBindable.PropertyChanged
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
Namespace: RGB.NET.Core
Assembly: RGB.NET.Core.dll
Syntax
public sealed class Led : Placeable, IBindable, INotifyPropertyChanged, IPlaceable

Properties

| Edit this page View Source

AbsoluteBoundary

Gets a rectangle representing the logical location of the Led on the RGBSurface.

Declaration
public Rectangle AbsoluteBoundary { get; }
Property Value
Type Description
Rectangle
| Edit this page View Source

Color

Gets the current Color of the Led. Sets the RequestedColor for the next update.

Declaration
public Color Color { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

CustomData

Gets the provider-specific data associated with this led.

Declaration
public object? CustomData { get; }
Property Value
Type Description
object
| Edit this page View Source

Device

Gets the IRGBDevice this Led is associated with.

Declaration
public IRGBDevice Device { get; }
Property Value
Type Description
IRGBDevice
| Edit this page View Source

Id

Gets the LedId of the Led.

Declaration
public LedId Id { get; }
Property Value
Type Description
LedId
| Edit this page View Source

IsDirty

Indicates whether the Led is about to change it's color.

Declaration
public bool IsDirty { get; }
Property Value
Type Description
bool
| Edit this page View Source

LayoutMetadata

Gets or sets some custom metadata of this led.

Declaration
public object? LayoutMetadata { get; set; }
Property Value
Type Description
object
| Edit this page View Source

RequestedColor

Gets a copy of the Color the LED should be set to on the next update. Null if there is no update-request for the next update.

Declaration
public Color? RequestedColor { get; }
Property Value
Type Description
Color?
| Edit this page View Source

Shape

Gets or sets the Shape of the Led.

Declaration
public Shape Shape { get; set; }
Property Value
Type Description
Shape
| Edit this page View Source

ShapeData

Gets or sets the data used for by the Custom-Shape.

Declaration
public string? ShapeData { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ToString()

Converts the Id and the Color of this Led to a human-readable string.

Declaration
public override string ToString()
Returns
Type Description
string

A string that contains the Id and the Color of this Led. For example "Enter [A: 255, R: 255, G: 0, B: 0]".

Overrides
object.ToString()
| Edit this page View Source

UpdateActualPlaceableData()

Updates the ActualSize, ActualLocation and Boundary based on the Size, Scale and Rotation.

Declaration
protected override void UpdateActualPlaceableData()
Overrides
Placeable.UpdateActualPlaceableData()

Operators

| Edit this page View Source

implicit operator Color(Led)

Converts a Led to a Color.

Declaration
public static implicit operator Color(Led led)
Parameters
Type Name Description
Led led

The Led to convert.

Returns
Type Description
Color
| Edit this page View Source

implicit operator Rectangle(Led)

Converts a Led to a Rectangle.

Declaration
public static implicit operator Rectangle(Led led)
Parameters
Type Name Description
Led led

The Led to convert.

Returns
Type Description
Rectangle

Implements

IBindable
INotifyPropertyChanged
IPlaceable
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX