Struct APIColour
Use this class to interact with the AntFarm DataSetSetting Colours.
The APIColour class does not provide public
constructors.
Please refer to:
in class
AntFarmAPI.
Inherited Members
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
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)
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 |
|
Declaration
public APIColour(Color color)
Parameters
Type |
Name |
Description |
System.Windows.Media.Color |
color |
|
Fields
A
Declaration
Field Value
Type |
Description |
System.Byte |
Alpha value of colour
|
B
Declaration
Field Value
Type |
Description |
System.Byte |
Blue value of colour
|
G
Declaration
Field Value
Type |
Description |
System.Byte |
Green value of colour
|
R
Declaration
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 |
|
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
Returns
Type |
Description |
System.Boolean |
|
Implicit(APIColour to Color)
Declaration
public static implicit operator Color(APIColour colour)
Parameters
Returns
Type |
Description |
System.Drawing.Color |
|
Declaration
public static implicit operator Color(APIColour colour)
Parameters
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
Declaration
public static implicit operator APIColour(Color color)
Parameters
Type |
Name |
Description |
System.Windows.Media.Color |
color |
|
Returns
Inequality(APIColour, APIColour)
Declaration
public static bool operator !=(APIColour left, APIColour right)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Explicit Interface Implementations
IEquatable<APIColour>.Equals(APIColour)
Declaration
bool IEquatable<APIColour>.Equals(APIColour other)
Parameters
Returns
Type |
Description |
System.Boolean |
|
Implements
System.IEquatable<T>