Class DeathstalkerGridEffect
Describes a custom grid effect for every key.
Implements
Namespace: Colore.Effects.Keyboard
Assembly: Colore.dll
Syntax
public sealed class DeathstalkerGridEffect : ValueType, IEquatable<DeathstalkerGridEffect>
Remarks
This effect is only used for compatibility with the Razer Deathstalker Chroma keyboard.
Constructors
DeathstalkerGridEffect(Color)
Initializes a new instance of the DeathstalkerGridEffect struct with every position set to a specific color.
Declaration
public DeathstalkerGridEffect(Color color)
Parameters
Type | Name | Description |
---|---|---|
Color | color | The Color to set each position to. |
DeathstalkerGridEffect(DeathstalkerGridEffect)
Initializes a new instance of the DeathstalkerGridEffect struct with the colors copied from another struct of the same type.
Declaration
public DeathstalkerGridEffect(DeathstalkerGridEffect other)
Parameters
Type | Name | Description |
---|---|---|
DeathstalkerGridEffect | other | The CustomKeyboardEffect struct to copy data from. |
Properties
Item[Int32]
Gets or sets a position in the custom grid.
Declaration
public Color this[int index] { get; set; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | The index to access, zero indexed. |
Property Value
Type | Description |
---|---|
Color | The Color at the specified position. |
Methods
Clear()
Clears the colors from the grid, setting them to Black.
Declaration
public void Clear()
Clone()
Returns a copy of this struct.
Declaration
public DeathstalkerGridEffect Clone()
Returns
Type | Description |
---|---|
DeathstalkerGridEffect | A copy of this struct. |
Create()
Creates a new empty DeathstalkerGridEffect struct.
Declaration
public static DeathstalkerGridEffect Create()
Returns
Type | Description |
---|---|
DeathstalkerGridEffect | An instance of DeathstalkerGridEffect filled with the color black. |
Equals(DeathstalkerGridEffect)
Indicates whether the current object is equal to another object of the same type.
Declaration
public bool Equals(DeathstalkerGridEffect other)
Parameters
Type | Name | Description |
---|---|---|
DeathstalkerGridEffect | other | A CustomKeyboardEffect to compare with this object. |
Returns
Type | Description |
---|---|
Boolean |
|
Equals(Object)
Indicates whether this instance and a specified object are equal.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | Another object to compare to. |
Returns
Type | Description |
---|---|
Boolean |
|
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. |
Set(Color)
Sets the entire grid to a specific Color.
Declaration
public void Set(Color color)
Parameters
Type | Name | Description |
---|---|---|
Color | color | The Color to apply. |
Operators
Equality(DeathstalkerGridEffect, Object)
Compares an instance of DeathstalkerGridEffect with another object for equality.
Declaration
public static bool operator ==(DeathstalkerGridEffect left, object right)
Parameters
Type | Name | Description |
---|---|---|
DeathstalkerGridEffect | left | The left operand, an instance of DeathstalkerGridEffect. |
Object | right | The right operand, any type of object. |
Returns
Type | Description |
---|---|
Boolean |
|
Inequality(DeathstalkerGridEffect, Object)
Compares an instance of DeathstalkerGridEffect with another object for inequality.
Declaration
public static bool operator !=(DeathstalkerGridEffect left, object right)
Parameters
Type | Name | Description |
---|---|---|
DeathstalkerGridEffect | left | The left operand, an instance of DeathstalkerGridEffect. |
Object | right | The right operand, any type of object. |
Returns
Type | Description |
---|---|
Boolean |
|