ColorRampShade Struct

public struct ColorRampShade : IComparable<ColorRampShade>, IEquatable<ColorRampShade>

public ColorRampShade(int shadeNumber, UIColor color)

Parameter	Type	Description
shadeNumber	int	The shade's number (0..1000) within its parent color ramp. Out of range values are coerced via ClampShadeNumber(int).
color	UIColor	The shade's color value.

public readonly UIColor Color { get; }

Property Value

UIColor:

The shade's color value.

public readonly bool IsInterpolated { get; }

Property Value

bool:

true if the shade is interpolated; otherwise, false.

public readonly int Number { get; }

Property Value

int:

The shade's number (0..1000) within its parent color ramp.

public static int ClampShadeNumber(int shadeNumber)

Parameter	Type	Description
shadeNumber	int	The shade number to coerce.

Returns

int:

The clamped shade number.

public readonly int CompareTo(ColorRampShade other)

Parameter	Type	Description
other	ColorRampShade	An object to compare with this instance.

Returns

int:

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

public readonly bool Equals(ColorRampShade other)

Parameter	Type	Description
other	ColorRampShade	An object to compare with this object.

Returns

bool:

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

public override readonly bool Equals(object obj)

Parameter	Type	Description
obj	object	The object to compare with the current object.

Returns

bool:

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

public override readonly int GetHashCode()

Returns

int:

A hash code for the current object.

public override readonly string ToString()

Returns

string:

The string representation of this object.

public static bool operator ==(ColorRampShade left, ColorRampShade right)

Parameter	Type	Description
left	ColorRampShade	The first object to compare.
right	ColorRampShade	The second object to compare.

Returns

bool:

true if the two objects are equal; otherwise, false.

public static bool operator >(ColorRampShade left, ColorRampShade right)

Parameter	Type	Description
left	ColorRampShade	The first object to compare.
right	ColorRampShade	The second object to compare.

Returns

bool:

true if the first object is greater than the second; otherwise, false.

public static bool operator >=(ColorRampShade left, ColorRampShade right)

Parameter	Type	Description
left	ColorRampShade	The first object to compare.
right	ColorRampShade	The second object to compare.

Returns

bool:

true if the first object is greater than or equal to the second; otherwise, false.

public static bool operator !=(ColorRampShade left, ColorRampShade right)

Parameter	Type	Description
left	ColorRampShade	The first object to compare.
right	ColorRampShade	The second object to compare.

Returns

bool:

true if the two objects are not equal; otherwise, false.

public static bool operator <(ColorRampShade left, ColorRampShade right)

Parameter	Type	Description
left	ColorRampShade	The first object to compare.
right	ColorRampShade	The second object to compare.

Returns

bool:

true if the first object is less than the second; otherwise, false.

public static bool operator <=(ColorRampShade left, ColorRampShade right)

Parameter	Type	Description
left	ColorRampShade	The first object to compare.
right	ColorRampShade	The second object to compare.

Returns

bool:

true if the first object is less than or equal to the second; otherwise, false.