Struct Colour
A four component colour, with RGBA values each within 0 to 1 range
Namespace: Yak2D
Assembly: Yak2D.Api.dll
Syntax
public readonly struct Colour : IEquatable<Colour>
Constructors
Colour(Single, Single, Single, Single)
A four component colour, with RGBA values each within 0 to 1 range
Declaration
public Colour(float r, float g, float b, float a)
Parameters
| Type |
Name |
Description |
| System.Single |
r |
Colour Component 0 to 1
|
| System.Single |
g |
Colour Component 0 to 1
|
| System.Single |
b |
Colour Component 0 to 1
|
| System.Single |
a |
Colour Component 0 to 1
|
Properties
A
Declaration
public readonly float A { get; }
Property Value
| Type |
Description |
| System.Single |
|
AliceBlue
Declaration
public static readonly Colour AliceBlue { get; }
Property Value
AntiqueWhite
Declaration
public static readonly Colour AntiqueWhite { get; }
Property Value
Aqua
Declaration
public static readonly Colour Aqua { get; }
Property Value
Aquamarine
Declaration
public static readonly Colour Aquamarine { get; }
Property Value
Azure
Declaration
public static readonly Colour Azure { get; }
Property Value
B
Declaration
public readonly float B { get; }
Property Value
| Type |
Description |
| System.Single |
|
Beige
Declaration
public static readonly Colour Beige { get; }
Property Value
Bisque
Declaration
public static readonly Colour Bisque { get; }
Property Value
Black
Declaration
public static readonly Colour Black { get; }
Property Value
BlanchedAlmond
Declaration
public static readonly Colour BlanchedAlmond { get; }
Property Value
Blue
Declaration
public static readonly Colour Blue { get; }
Property Value
BlueViolet
Declaration
public static readonly Colour BlueViolet { get; }
Property Value
Brown
Declaration
public static readonly Colour Brown { get; }
Property Value
Burlywood
Declaration
public static readonly Colour Burlywood { get; }
Property Value
CadetBlue
Declaration
public static readonly Colour CadetBlue { get; }
Property Value
Chartreuse
Declaration
public static readonly Colour Chartreuse { get; }
Property Value
Chocolate
Declaration
public static readonly Colour Chocolate { get; }
Property Value
Clear
Declaration
public static readonly Colour Clear { get; }
Property Value
Coral
Declaration
public static readonly Colour Coral { get; }
Property Value
CornflowerBlue
Declaration
public static readonly Colour CornflowerBlue { get; }
Property Value
Cornsilk
Declaration
public static readonly Colour Cornsilk { get; }
Property Value
Crimson
Declaration
public static readonly Colour Crimson { get; }
Property Value
Cyan
Declaration
public static readonly Colour Cyan { get; }
Property Value
DarkBlue
Declaration
public static readonly Colour DarkBlue { get; }
Property Value
DarkCyan
Declaration
public static readonly Colour DarkCyan { get; }
Property Value
DarkGoldenrod
Declaration
public static readonly Colour DarkGoldenrod { get; }
Property Value
DarkGray
Declaration
public static readonly Colour DarkGray { get; }
Property Value
DarkGreen
Declaration
public static readonly Colour DarkGreen { get; }
Property Value
DarkKhaki
Declaration
public static readonly Colour DarkKhaki { get; }
Property Value
DarkMagenta
Declaration
public static readonly Colour DarkMagenta { get; }
Property Value
DarkOliveGreen
Declaration
public static readonly Colour DarkOliveGreen { get; }
Property Value
DarkOrange
Declaration
public static readonly Colour DarkOrange { get; }
Property Value
DarkOrchid
Declaration
public static readonly Colour DarkOrchid { get; }
Property Value
DarkRed
Declaration
public static readonly Colour DarkRed { get; }
Property Value
DarkSalmon
Declaration
public static readonly Colour DarkSalmon { get; }
Property Value
DarkSeaGreen
Declaration
public static readonly Colour DarkSeaGreen { get; }
Property Value
DarkSlateBlue
Declaration
public static readonly Colour DarkSlateBlue { get; }
Property Value
DarkSlateGray
Declaration
public static readonly Colour DarkSlateGray { get; }
Property Value
DarkTurquoise
Declaration
public static readonly Colour DarkTurquoise { get; }
Property Value
DarkViolet
Declaration
public static readonly Colour DarkViolet { get; }
Property Value
DeepPink
Declaration
public static readonly Colour DeepPink { get; }
Property Value
DeepSkyBlue
Declaration
public static readonly Colour DeepSkyBlue { get; }
Property Value
DimGray
Declaration
public static readonly Colour DimGray { get; }
Property Value
DodgerBlue
Declaration
public static readonly Colour DodgerBlue { get; }
Property Value
Firebrick
Declaration
public static readonly Colour Firebrick { get; }
Property Value
FloralWhite
Declaration
public static readonly Colour FloralWhite { get; }
Property Value
ForestGreen
Declaration
public static readonly Colour ForestGreen { get; }
Property Value
Fuchsia
Declaration
public static readonly Colour Fuchsia { get; }
Property Value
G
Declaration
public readonly float G { get; }
Property Value
| Type |
Description |
| System.Single |
|
Gainsboro
Declaration
public static readonly Colour Gainsboro { get; }
Property Value
GhostWhite
Declaration
public static readonly Colour GhostWhite { get; }
Property Value
Gold
Declaration
public static readonly Colour Gold { get; }
Property Value
Goldenrod
Declaration
public static readonly Colour Goldenrod { get; }
Property Value
Gray
Declaration
public static readonly Colour Gray { get; }
Property Value
Green
Declaration
public static readonly Colour Green { get; }
Property Value
GreenYellow
Declaration
public static readonly Colour GreenYellow { get; }
Property Value
Honeydew
Declaration
public static readonly Colour Honeydew { get; }
Property Value
HotPink
Declaration
public static readonly Colour HotPink { get; }
Property Value
IndianRed
Declaration
public static readonly Colour IndianRed { get; }
Property Value
Indigo
Declaration
public static readonly Colour Indigo { get; }
Property Value
Ivory
Declaration
public static readonly Colour Ivory { get; }
Property Value
Khaki
Declaration
public static readonly Colour Khaki { get; }
Property Value
Lavender
Declaration
public static readonly Colour Lavender { get; }
Property Value
LavenderBlush
Declaration
public static readonly Colour LavenderBlush { get; }
Property Value
LawnGreen
Declaration
public static readonly Colour LawnGreen { get; }
Property Value
LemonChiffon
Declaration
public static readonly Colour LemonChiffon { get; }
Property Value
LightBlue
Declaration
public static readonly Colour LightBlue { get; }
Property Value
LightCoral
Declaration
public static readonly Colour LightCoral { get; }
Property Value
LightCyan
Declaration
public static readonly Colour LightCyan { get; }
Property Value
LightGoldenrod
Declaration
public static readonly Colour LightGoldenrod { get; }
Property Value
LightGray
Declaration
public static readonly Colour LightGray { get; }
Property Value
LightGreen
Declaration
public static readonly Colour LightGreen { get; }
Property Value
LightPink
Declaration
public static readonly Colour LightPink { get; }
Property Value
LightSalmon
Declaration
public static readonly Colour LightSalmon { get; }
Property Value
LightSeaGreen
Declaration
public static readonly Colour LightSeaGreen { get; }
Property Value
LightSkyBlue
Declaration
public static readonly Colour LightSkyBlue { get; }
Property Value
LightSlateGray
Declaration
public static readonly Colour LightSlateGray { get; }
Property Value
LightSteelBlue
Declaration
public static readonly Colour LightSteelBlue { get; }
Property Value
LightYellow
Declaration
public static readonly Colour LightYellow { get; }
Property Value
Lime
Declaration
public static readonly Colour Lime { get; }
Property Value
LimeGreen
Declaration
public static readonly Colour LimeGreen { get; }
Property Value
Linen
Declaration
public static readonly Colour Linen { get; }
Property Value
Magenta
Declaration
public static readonly Colour Magenta { get; }
Property Value
Maroon
Declaration
public static readonly Colour Maroon { get; }
Property Value
MediumAquamarine
Declaration
public static readonly Colour MediumAquamarine { get; }
Property Value
MediumBlue
Declaration
public static readonly Colour MediumBlue { get; }
Property Value
MediumOrchid
Declaration
public static readonly Colour MediumOrchid { get; }
Property Value
MediumPurple
Declaration
public static readonly Colour MediumPurple { get; }
Property Value
MediumSeaGreen
Declaration
public static readonly Colour MediumSeaGreen { get; }
Property Value
MediumSlateBlue
Declaration
public static readonly Colour MediumSlateBlue { get; }
Property Value
MediumSpringGreen
Declaration
public static readonly Colour MediumSpringGreen { get; }
Property Value
MediumTurquoise
Declaration
public static readonly Colour MediumTurquoise { get; }
Property Value
MediumVioletRed
Declaration
public static readonly Colour MediumVioletRed { get; }
Property Value
MidnightBlue
Declaration
public static readonly Colour MidnightBlue { get; }
Property Value
MintCream
Declaration
public static readonly Colour MintCream { get; }
Property Value
MistyRose
Declaration
public static readonly Colour MistyRose { get; }
Property Value
Moccasin
Declaration
public static readonly Colour Moccasin { get; }
Property Value
NavajoWhite
Declaration
public static readonly Colour NavajoWhite { get; }
Property Value
NavyBlue
Declaration
public static readonly Colour NavyBlue { get; }
Property Value
OldLace
Declaration
public static readonly Colour OldLace { get; }
Property Value
Olive
Declaration
public static readonly Colour Olive { get; }
Property Value
OliveDrab
Declaration
public static readonly Colour OliveDrab { get; }
Property Value
Orange
Declaration
public static readonly Colour Orange { get; }
Property Value
OrangeRed
Declaration
public static readonly Colour OrangeRed { get; }
Property Value
Orchid
Declaration
public static readonly Colour Orchid { get; }
Property Value
PaleGoldenrod
Declaration
public static readonly Colour PaleGoldenrod { get; }
Property Value
PaleGreen
Declaration
public static readonly Colour PaleGreen { get; }
Property Value
PaleTurquoise
Declaration
public static readonly Colour PaleTurquoise { get; }
Property Value
PaleVioletRed
Declaration
public static readonly Colour PaleVioletRed { get; }
Property Value
PapayaWhip
Declaration
public static readonly Colour PapayaWhip { get; }
Property Value
PeachPuff
Declaration
public static readonly Colour PeachPuff { get; }
Property Value
Peru
Declaration
public static readonly Colour Peru { get; }
Property Value
Pink
Declaration
public static readonly Colour Pink { get; }
Property Value
Plum
Declaration
public static readonly Colour Plum { get; }
Property Value
PowderBlue
Declaration
public static readonly Colour PowderBlue { get; }
Property Value
Purple
Declaration
public static readonly Colour Purple { get; }
Property Value
R
Declaration
public readonly float R { get; }
Property Value
| Type |
Description |
| System.Single |
|
RebeccaPurple
Declaration
public static readonly Colour RebeccaPurple { get; }
Property Value
Red
Declaration
public static readonly Colour Red { get; }
Property Value
RosyBrown
Declaration
public static readonly Colour RosyBrown { get; }
Property Value
RoyalBlue
Declaration
public static readonly Colour RoyalBlue { get; }
Property Value
SaddleBrown
Declaration
public static readonly Colour SaddleBrown { get; }
Property Value
Salmon
Declaration
public static readonly Colour Salmon { get; }
Property Value
SandyBrown
Declaration
public static readonly Colour SandyBrown { get; }
Property Value
SeaGreen
Declaration
public static readonly Colour SeaGreen { get; }
Property Value
Seashell
Declaration
public static readonly Colour Seashell { get; }
Property Value
Sienna
Declaration
public static readonly Colour Sienna { get; }
Property Value
Silver
Declaration
public static readonly Colour Silver { get; }
Property Value
SkyBlue
Declaration
public static readonly Colour SkyBlue { get; }
Property Value
SlateBlue
Declaration
public static readonly Colour SlateBlue { get; }
Property Value
SlateGray
Declaration
public static readonly Colour SlateGray { get; }
Property Value
Snow
Declaration
public static readonly Colour Snow { get; }
Property Value
SpringGreen
Declaration
public static readonly Colour SpringGreen { get; }
Property Value
SteelBlue
Declaration
public static readonly Colour SteelBlue { get; }
Property Value
Tan
Declaration
public static readonly Colour Tan { get; }
Property Value
Teal
Declaration
public static readonly Colour Teal { get; }
Property Value
Thistle
Declaration
public static readonly Colour Thistle { get; }
Property Value
Tomato
Declaration
public static readonly Colour Tomato { get; }
Property Value
Turquoise
Declaration
public static readonly Colour Turquoise { get; }
Property Value
Violet
Declaration
public static readonly Colour Violet { get; }
Property Value
WebGray
Declaration
public static readonly Colour WebGray { get; }
Property Value
WebGreen
Declaration
public static readonly Colour WebGreen { get; }
Property Value
WebMaroon
Declaration
public static readonly Colour WebMaroon { get; }
Property Value
WebPurple
Declaration
public static readonly Colour WebPurple { get; }
Property Value
Wheat
Declaration
public static readonly Colour Wheat { get; }
Property Value
White
Declaration
public static readonly Colour White { get; }
Property Value
WhiteSmoke
Declaration
public static readonly Colour WhiteSmoke { get; }
Property Value
Yellow
Declaration
public static readonly Colour Yellow { get; }
Property Value
YellowGreen
Declaration
public static readonly Colour YellowGreen { get; }
Property Value
Methods
Equals(Object)
Declaration
public override readonly bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| System.Object |
obj |
|
Returns
| Type |
Description |
| System.Boolean |
|
Equals(Colour)
Declaration
public readonly bool Equals(Colour other)
Parameters
| Type |
Name |
Description |
| Colour |
other |
|
Returns
| Type |
Description |
| System.Boolean |
|
GetHashCode()
Declaration
public override readonly int GetHashCode()
Returns
| Type |
Description |
| System.Int32 |
|
ToVector3()
Return R, G, B components as Vector3 (A ignored)
Declaration
public readonly Vector3 ToVector3()
Returns
ToVector4()
Return R, G, B, A as Vector4
Declaration
public readonly Vector4 ToVector4()
Returns
Operators
Addition(Colour, Colour)
Declaration
public static Colour operator +(Colour c0, Colour c1)
Parameters
Returns
Equality(Colour, Colour)
Declaration
public static bool operator ==(Colour left, Colour right)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Inequality(Colour, Colour)
Declaration
public static bool operator !=(Colour left, Colour right)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
Multiply(Single, Colour)
Declaration
public static Colour operator *(float f, Colour c)
Parameters
| Type |
Name |
Description |
| System.Single |
f |
|
| Colour |
c |
|
Returns
Multiply(Colour, Single)
Declaration
public static Colour operator *(Colour c, float f)
Parameters
| Type |
Name |
Description |
| Colour |
c |
|
| System.Single |
f |
|
Returns
Multiply(Colour, Colour)
Declaration
public static Colour operator *(Colour c0, Colour c1)
Parameters
Returns
Subtraction(Colour, Colour)
Declaration
public static Colour operator -(Colour c0, Colour c1)
Parameters
Returns
Implements
IEquatable<>