Class LedGroupExtension

Offers some extensions and helper-methods for ILedGroup related things.

Inheritance

object

LedGroupExtension

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: RGB.NET.Core

Assembly: RGB.NET.Core.dll

Syntax

public static class LedGroupExtension

Methods

Attach(ILedGroup, RGBSurface)

Attaches the specified ILedGroup to the RGBSurface.

Declaration

public static bool Attach(this ILedGroup ledGroup, RGBSurface surface)

Parameters

Type	Name	Description
ILedGroup	ledGroup	The ILedGroup to attach.
RGBSurface	surface	The RGBSurface to attach this group to.

Returns

Type	Description
bool	true if the ILedGroup could be attached; otherwise, false.

Detach(ILedGroup)

Detaches the specified ILedGroup from the RGBSurface.

Declaration

public static bool Detach(this ILedGroup ledGroup)

Parameters

Type	Name	Description
ILedGroup	ledGroup	The ILedGroup to attach.

Returns

Type	Description
bool	true if the ILedGroup could be detached; otherwise, false.

Exclude(ILedGroup, params Led[])

Returns a new ListLedGroup which contains all Led from the specified ILedGroup excluding the specified ones.

Declaration

public static ListLedGroup Exclude(this ILedGroup ledGroup, params Led[] ledIds)

Parameters

Type	Name	Description
ILedGroup	ledGroup	The base ILedGroup.
Led[]	ledIds	The Led to exclude.

Returns

Type	Description
ListLedGroup	The new ListLedGroup.

ToListLedGroup(ILedGroup)

Converts the specified ILedGroup to a ListLedGroup.

Declaration

public static ListLedGroup ToListLedGroup(this ILedGroup ledGroup)

Parameters

Type	Name	Description
ILedGroup	ledGroup	The ILedGroup to convert.

Returns

Type	Description
ListLedGroup	The converted ListLedGroup.