Class StaticMouseEffect

Describes the static effect type.

Inheritance
Object
StaticMouseEffect
Namespace: Colore.Effects.Mouse
Assembly: Colore.dll
Syntax
public sealed class StaticMouseEffect : ValueType, IEquatable<StaticMouseEffect>

Constructors

StaticMouseEffect(Color)

Initializes a new instance of the StaticMouseEffect struct, with a color to set for every LED.

Declaration
public StaticMouseEffect(Color color)
Parameters
Type Name Description
Color color

The colo to set for every LED.

StaticMouseEffect(Led, Color)

Initializes a new instance of the StaticMouseEffect struct.

Declaration
public StaticMouseEffect(Led led, Color color)
Parameters
Type Name Description
Led led

The Led on which to apply the color.
Color color

The Color to set.

Fields

Color

The color to apply.

Declaration
public readonly Color Color
Field Value
Type Description
Color

Led

The LED on which to apply the color.

Declaration
public readonly Led Led
Field Value
Type Description
Led

Methods

Equals(StaticMouseEffect)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(StaticMouseEffect other)
Parameters
Type Name Description
StaticMouseEffect other

An object to compare with this object.
Returns
Type Description
Boolean

true if the current object is equal to the other parameter; otherwise, false.

Equals(Object)

Indicates whether this instance and a specified object are equal.

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
Object other

The object to compare with the current instance.

Returns
Type Description
Boolean

true if other and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

A 32-bit signed integer that is the hash code for this instance.

Operators

Equality(StaticMouseEffect, StaticMouseEffect)

Compares an instance of StaticMouseEffect for equality with another StaticMouseEffect struct.

Declaration
public static bool operator ==(StaticMouseEffect left, StaticMouseEffect right)
Parameters
Type Name Description
StaticMouseEffect left

Left operand.
StaticMouseEffect right

Right operand.
Returns
Type Description
Boolean

true if the two instances are equal, otherwise false.

Inequality(StaticMouseEffect, StaticMouseEffect)

Compares an instance of StaticMouseEffect for inequality with another StaticMouseEffect struct.

Declaration
public static bool operator !=(StaticMouseEffect left, StaticMouseEffect right)
Parameters
Type Name Description
StaticMouseEffect left

Left operand.
StaticMouseEffect right

Right operand.
Returns
Type Description
Boolean

true if the two instances are not equal, otherwise false.

Implements