Interface IMouse

Interface for mouse functionality.

Inherited Members

IDevice.ClearAsync()

IDevice.SetAllAsync(Color)

IDevice.SetEffectAsync(Guid)

IDevice.CurrentEffectId

Namespace: Colore

Assembly: Colore.dll

Syntax

public interface IMouse : IDevice

Properties

Item[GridLed]

Gets or sets the Color for a specified GridLed on the mouse's virtual grid.

Declaration

Color this[GridLed led] { get; set; }

Parameters

Type	Name	Description
GridLed	led	The GridLed to query.

Property Value

Type	Description
Color	The Color currently set for the specified GridLed.

Item[Int32, Int32]

Gets or sets the Color for a specific position on the mouse's virtual grid.

Declaration

Color this[int row, int column] { get; set; }

Parameters

Type	Name	Description
Int32	row	The row to query, between 0 and MaxRows (exclusive upper-bound).
Int32	column	The column to query, between 0 and MaxColumns (exclusive upper-bound).

Property Value

Type	Description
Color	The Color at the specified position.

Methods

SetEffectAsync(MouseEffectType)

Sets an effect without any parameters. Currently, this only works for the None effect.

Declaration

Task<Guid> SetEffectAsync(MouseEffectType effectType)

Parameters

Type	Name	Description
MouseEffectType	effectType	Effect options.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetGridAsync(CustomMouseEffect)

Sets a custom grid effect on the mouse.

Declaration

Task<Guid> SetGridAsync(CustomMouseEffect effect)

Parameters

Type	Name	Description
CustomMouseEffect	effect	An instance of the CustomMouseEffect struct.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetStaticAsync(Color, Led)

Sets a static effect on the mouse.

Declaration

Task<Guid> SetStaticAsync(Color color, Led led)

Parameters

Type	Name	Description
Color	color	The color to use.
Led	led	Which LED(s) to affect.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.

SetStaticAsync(StaticMouseEffect)

Sets a static color on the mouse.

Declaration

Task<Guid> SetStaticAsync(StaticMouseEffect effect)

Parameters

Type	Name	Description
StaticMouseEffect	effect	An instance of the StaticMouseEffect effect.

Returns

Type	Description
Task<Guid>	A Guid for the effect that was set.