Struct Color

The Color is a struct to record the check's state.

Inherited Members
Namespace: ElmSharp
Assembly: ElmSharp.dll
Syntax
public struct Color

Constructors

Color(Int32, Int32, Int32)

Creates and initializes a new instance of the Color class with RGB parameters.

Declaration
public Color(int r, int g, int b)
Parameters
Type Name Description
Int32 r

Red of RGB.
Int32 g

Green of RGB.
Int32 b

Blue of RGB.
API Version
preview

Color(Int32, Int32, Int32, Int32)

Creates and initializes a new instance of the Color class with RGBA parameters.

Declaration
public Color(int r, int g, int b, int a)
Parameters
Type Name Description
Int32 r

Red of RGBA.
Int32 g

Green of RGBA.
Int32 b

Blue of RGBA.
Int32 a

Alpha of RGBA.
API Version
preview

Fields

Aqua

The Aqua is a predefined Color instance. It's RGB value is (0, 255, 255).

Declaration
public static readonly Color Aqua
Field Value
Type Description
Color
API Version
preview

Black

The Black is a predefined Color instance. It's RGB value is (0, 0, 0).

Declaration
public static readonly Color Black
Field Value
Type Description
Color
API Version
preview

Blue

The Blue is a predefined Color instance. It's RGB value is (0, 0, 255).

Declaration
public static readonly Color Blue
Field Value
Type Description
Color
API Version
preview

Fuchsia

The Fuchsia is a predefined Color instance. It's RGB value is (255, 0, 255).

Declaration
public static readonly Color Fuchsia
Field Value
Type Description
Color
API Version
preview

Gray

The Gray is a predefined Color instance. It's RGB value is (128, 128, 128).

Declaration
public static readonly Color Gray
Field Value
Type Description
Color
API Version
preview

Green

The Green is a predefined Color instance. It's RGB value is (0, 128, 0).

Declaration
public static readonly Color Green
Field Value
Type Description
Color
API Version
preview

Lime

The Lime is a predefined Color instance. It's RGB value is (0, 255, 0).

Declaration
public static readonly Color Lime
Field Value
Type Description
Color
API Version
preview

Maroon

The Maroon is a predefined Color instance. It's RGB value is (128, 0, 0).

Declaration
public static readonly Color Maroon
Field Value
Type Description
Color
API Version
preview

Navy

The Navy is a predefined Color instance. It's RGB value is (0, 0, 128).

Declaration
public static readonly Color Navy
Field Value
Type Description
Color
API Version
preview

Olive

The Olive is a predefined Color instance. It's RGB value is (128, 128, 0).

Declaration
public static readonly Color Olive
Field Value
Type Description
Color
API Version
preview

Orange

The Orange is a predefined Color instance. It's RGB value is (255, 165, 0).

Declaration
public static readonly Color Orange
Field Value
Type Description
Color
API Version
preview

Pink

The Pink is a predefined Color instance. It's RGB value is (255, 102, 255).

Declaration
public static readonly Color Pink
Field Value
Type Description
Color
API Version
preview

Purple

The Purple is a predefined Color instance. It's RGB value is (128, 0, 128).

Declaration
public static readonly Color Purple
Field Value
Type Description
Color
API Version
preview

Red

The Red is a predefined Color instance. It's RGB value is (255, 0, 0).

Declaration
public static readonly Color Red
Field Value
Type Description
Color
API Version
preview

Silver

The Silver is a predefined Color instance. It's RGB value is (192, 192, 192).

Declaration
public static readonly Color Silver
Field Value
Type Description
Color
API Version
preview

Teal

The Teal is a predefined Color instance. It's RGB value is (0, 128, 128).

Declaration
public static readonly Color Teal
Field Value
Type Description
Color
API Version
preview

Transparent

The Tansparent is a predefined Color instance. It's RGBA value is (0, 0, 0, 0).

Declaration
public static readonly Color Transparent
Field Value
Type Description
Color
API Version
preview

White

The White is a predefined Color instance. It's RGB value is (255, 255, 255).

Declaration
public static readonly Color White
Field Value
Type Description
Color
API Version
preview

Yellow

The Yellow is a predefined Color instance. It's RGB value is (255, 255, 0).

Declaration
public static readonly Color Yellow
Field Value
Type Description
Color
API Version
preview

Properties

A

Gets the A value of RGBA. A means the Alpha in color.

Declaration
public int A { get; }
Property Value
Type Description
Int32
API Version
preview

B

Gets the B value of RGBA. B means the Blue in color.

Declaration
public int B { get; }
Property Value
Type Description
Int32
API Version
preview

Default

Gets a default Color instance.

Declaration
public static Color Default { get; }
Property Value
Type Description
Color
Remarks

In the default Color instance, the mode type is default with RGBA all set as -1.

API Version
preview

G

Gets the G value of RGBA. G means the Green in color.

Declaration
public int G { get; }
Property Value
Type Description
Int32
API Version
preview

IsDefault

Gets whether the Color instance's mode is default or not. The return type is bool.

Declaration
public bool IsDefault { get; }
Property Value
Type Description
Boolean
API Version
preview

R

Gets the R value of RGBA. R means the Red in color.

Declaration
public int R { get; }
Property Value
Type Description
Int32
API Version
preview

Methods

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

The object to compare with the current instance.
Returns
Type Description
Boolean

true if the object and this instance are of the same type and represent the same value. otherwise, false.
Overrides
API Version
preview

FromHex(String)

Gets a Color instance with a hexadecimal string parameter.

Declaration
public static Color FromHex(string hex)
Parameters
Type Name Description
String hex

Hexadecimal string.
Returns
Type Description
Color

New instance of the Color struct.
API Version
preview

FromRgb(Int32, Int32, Int32)

Gets a Color instance with R,G,B parameters.

Declaration
public static Color FromRgb(int r, int g, int b)
Parameters
Type Name Description
Int32 r

Red of RGB.
Int32 g

Green of RGB.
Int32 b

Blue of RGB.
Returns
Type Description
Color

New instance of the Color struct.
API Version
preview

FromRgba(Int32, Int32, Int32, Int32)

Gets a Color instance with R,G,B,A parameters.

Declaration
public static Color FromRgba(int r, int g, int b, int a)
Parameters
Type Name Description
Int32 r

Red of RGBA.
Int32 g

Green of RGBA.
Int32 b

Blue of RGBA.
Int32 a

Alpha of RGBA.
Returns
Type Description
Color

New instance of the Color struct.
API Version
preview

FromUint(UInt32)

Gets a Color instance with an unsigned integer parameter.

Declaration
public static Color FromUint(uint argb)
Parameters
Type Name Description
UInt32 argb

Unsigned integer indicates RGBA.
Returns
Type Description
Color

New instance of the Color struct.
API Version
preview

GetHashCode()

Returns the hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

A 32-bit signed integer hash code.
Overrides
API Version
preview

ToString()

Returns the fully qualified type name of this instance.

Declaration
public override string ToString()
Returns
Type Description
String

The fully qualified type name.
Overrides
API Version
preview

Operators

Equality(Color, Color)

Compares whether the two Color instances are same or not.

Declaration
public static bool operator ==(Color a, Color b)
Parameters
Type Name Description
Color a

A Color instance.
Color b

A Color instance.
Returns
Type Description
Boolean

The result whether the two instances are the same or not. Return type is bool. If they are same, return true.
API Version
preview

Inequality(Color, Color)

Compares whether the two Color instances are different or not.

Declaration
public static bool operator !=(Color a, Color b)
Parameters
Type Name Description
Color a

A Color instance.
Color b

A Color instance.
Returns
Type Description
Boolean

The result whether the two instances are different or not. Return type is bool. If they are different, return true.
API Version
preview