Struct APIColour

Use this class to interact with the AntFarm DataSetSetting Colours.

The APIColour class does not provide public constructors. Please refer to:

• NewColour(Byte, Byte, Byte, Byte),

in class AntFarmAPI.

Implements

System.IEquatable<APIColour>

Inherited Members

System.ValueType.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: AntFarm.API

Assembly: AntFarm.dll

Syntax

[Serializable]
public struct APIColour : IEquatable<APIColour>

Constructors

APIColour(AFColour)

Declaration

public APIColour(AFColour colour)

Parameters

Type	Name	Description
AntFarm.Kernel.Types.AFColour	colour

APIColour(Byte, Byte, Byte, Byte)

Constructor

Declaration

public APIColour(byte a, byte r, byte g, byte b)

Parameters

Type	Name	Description
System.Byte	a	Alpha value of the colour
System.Byte	r	Red value of the colour
System.Byte	g	Green value of the colour
System.Byte	b	Blue value of the colour

APIColour(Color)

Declaration

public APIColour(Color color)

Parameters

Type	Name	Description
System.Drawing.Color	color

APIColour(Color)

Declaration

public APIColour(Color color)

Parameters

Type	Name	Description
System.Windows.Media.Color	color

Fields

A

Declaration

public byte A

Field Value

Type	Description
System.Byte	Alpha value of colour

B

Declaration

public byte B

Field Value

Type	Description
System.Byte	Blue value of colour

G

Declaration

public byte G

Field Value

Type	Description
System.Byte	Green value of colour

R

Declaration

public byte R

Field Value

Type	Description
System.Byte	Red value of colour

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

ToDrawingColor()

Declaration

public Color ToDrawingColor()

Returns

Type	Description
System.Drawing.Color

ToMediaColor()

Declaration

public Color ToMediaColor()

Returns

Type	Description
System.Windows.Media.Color

Operators

Equality(APIColour, APIColour)

Declaration

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

Parameters

Type	Name	Description
APIColour	left
APIColour	right

Returns

Type	Description
System.Boolean

Implicit(APIColour to Color)

Declaration

public static implicit operator Color(APIColour colour)

Parameters

Type	Name	Description
APIColour	colour

Returns

Type	Description
System.Drawing.Color

Implicit(APIColour to Color)

Declaration

public static implicit operator Color(APIColour colour)

Parameters

Type	Name	Description
APIColour	colour

Returns

Type	Description
System.Windows.Media.Color

Implicit(Color to APIColour)

Declaration

public static implicit operator APIColour(Color color)

Parameters

Type	Name	Description
System.Drawing.Color	color

Returns

Type	Description
APIColour

Implicit(Color to APIColour)

Declaration

public static implicit operator APIColour(Color color)

Parameters

Type	Name	Description
System.Windows.Media.Color	color

Returns

Type	Description
APIColour

Inequality(APIColour, APIColour)

Declaration

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

Parameters

Type	Name	Description
APIColour	left
APIColour	right

Returns

Type	Description
System.Boolean

Explicit Interface Implementations

IEquatable<APIColour>.Equals(APIColour)

Declaration

bool IEquatable<APIColour>.Equals(APIColour other)

Parameters

Type	Name	Description
APIColour	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>