Show / Hide Table of Contents

Struct Colour

A four component colour, with RGBA values each within 0 to 1 range

Implements
IEquatable<Colour>
Inherited Members
ValueType.ToString()
object.GetType()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: Yak2D
Assembly: Yak2D.Api.dll
Syntax
public readonly struct Colour : IEquatable<Colour>

Constructors

Colour(float, float, float, float)

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
float r

Colour Component 0 to 1

float g

Colour Component 0 to 1

float b

Colour Component 0 to 1

float a

Colour Component 0 to 1

Properties

A

Declaration
public float A { get; }
Property Value
Type Description
float

AliceBlue

Declaration
public static Colour AliceBlue { get; }
Property Value
Type Description
Colour

AntiqueWhite

Declaration
public static Colour AntiqueWhite { get; }
Property Value
Type Description
Colour

Aqua

Declaration
public static Colour Aqua { get; }
Property Value
Type Description
Colour

Aquamarine

Declaration
public static Colour Aquamarine { get; }
Property Value
Type Description
Colour

Azure

Declaration
public static Colour Azure { get; }
Property Value
Type Description
Colour

B

Declaration
public float B { get; }
Property Value
Type Description
float

Beige

Declaration
public static Colour Beige { get; }
Property Value
Type Description
Colour

Bisque

Declaration
public static Colour Bisque { get; }
Property Value
Type Description
Colour

Black

Declaration
public static Colour Black { get; }
Property Value
Type Description
Colour

BlanchedAlmond

Declaration
public static Colour BlanchedAlmond { get; }
Property Value
Type Description
Colour

Blue

Declaration
public static Colour Blue { get; }
Property Value
Type Description
Colour

BlueViolet

Declaration
public static Colour BlueViolet { get; }
Property Value
Type Description
Colour

Brown

Declaration
public static Colour Brown { get; }
Property Value
Type Description
Colour

Burlywood

Declaration
public static Colour Burlywood { get; }
Property Value
Type Description
Colour

CadetBlue

Declaration
public static Colour CadetBlue { get; }
Property Value
Type Description
Colour

Chartreuse

Declaration
public static Colour Chartreuse { get; }
Property Value
Type Description
Colour

Chocolate

Declaration
public static Colour Chocolate { get; }
Property Value
Type Description
Colour

Clear

Declaration
public static Colour Clear { get; }
Property Value
Type Description
Colour

Coral

Declaration
public static Colour Coral { get; }
Property Value
Type Description
Colour

CornflowerBlue

Declaration
public static Colour CornflowerBlue { get; }
Property Value
Type Description
Colour

Cornsilk

Declaration
public static Colour Cornsilk { get; }
Property Value
Type Description
Colour

Crimson

Declaration
public static Colour Crimson { get; }
Property Value
Type Description
Colour

Cyan

Declaration
public static Colour Cyan { get; }
Property Value
Type Description
Colour

DarkBlue

Declaration
public static Colour DarkBlue { get; }
Property Value
Type Description
Colour

DarkCyan

Declaration
public static Colour DarkCyan { get; }
Property Value
Type Description
Colour

DarkGoldenrod

Declaration
public static Colour DarkGoldenrod { get; }
Property Value
Type Description
Colour

DarkGray

Declaration
public static Colour DarkGray { get; }
Property Value
Type Description
Colour

DarkGreen

Declaration
public static Colour DarkGreen { get; }
Property Value
Type Description
Colour

DarkKhaki

Declaration
public static Colour DarkKhaki { get; }
Property Value
Type Description
Colour

DarkMagenta

Declaration
public static Colour DarkMagenta { get; }
Property Value
Type Description
Colour

DarkOliveGreen

Declaration
public static Colour DarkOliveGreen { get; }
Property Value
Type Description
Colour

DarkOrange

Declaration
public static Colour DarkOrange { get; }
Property Value
Type Description
Colour

DarkOrchid

Declaration
public static Colour DarkOrchid { get; }
Property Value
Type Description
Colour

DarkRed

Declaration
public static Colour DarkRed { get; }
Property Value
Type Description
Colour

DarkSalmon

Declaration
public static Colour DarkSalmon { get; }
Property Value
Type Description
Colour

DarkSeaGreen

Declaration
public static Colour DarkSeaGreen { get; }
Property Value
Type Description
Colour

DarkSlateBlue

Declaration
public static Colour DarkSlateBlue { get; }
Property Value
Type Description
Colour

DarkSlateGray

Declaration
public static Colour DarkSlateGray { get; }
Property Value
Type Description
Colour

DarkTurquoise

Declaration
public static Colour DarkTurquoise { get; }
Property Value
Type Description
Colour

DarkViolet

Declaration
public static Colour DarkViolet { get; }
Property Value
Type Description
Colour

DeepPink

Declaration
public static Colour DeepPink { get; }
Property Value
Type Description
Colour

DeepSkyBlue

Declaration
public static Colour DeepSkyBlue { get; }
Property Value
Type Description
Colour

DimGray

Declaration
public static Colour DimGray { get; }
Property Value
Type Description
Colour

DodgerBlue

Declaration
public static Colour DodgerBlue { get; }
Property Value
Type Description
Colour

Firebrick

Declaration
public static Colour Firebrick { get; }
Property Value
Type Description
Colour

FloralWhite

Declaration
public static Colour FloralWhite { get; }
Property Value
Type Description
Colour

ForestGreen

Declaration
public static Colour ForestGreen { get; }
Property Value
Type Description
Colour

Fuchsia

Declaration
public static Colour Fuchsia { get; }
Property Value
Type Description
Colour

G

Declaration
public float G { get; }
Property Value
Type Description
float

Gainsboro

Declaration
public static Colour Gainsboro { get; }
Property Value
Type Description
Colour

GhostWhite

Declaration
public static Colour GhostWhite { get; }
Property Value
Type Description
Colour

Gold

Declaration
public static Colour Gold { get; }
Property Value
Type Description
Colour

Goldenrod

Declaration
public static Colour Goldenrod { get; }
Property Value
Type Description
Colour

Gray

Declaration
public static Colour Gray { get; }
Property Value
Type Description
Colour

Green

Declaration
public static Colour Green { get; }
Property Value
Type Description
Colour

GreenYellow

Declaration
public static Colour GreenYellow { get; }
Property Value
Type Description
Colour

Honeydew

Declaration
public static Colour Honeydew { get; }
Property Value
Type Description
Colour

HotPink

Declaration
public static Colour HotPink { get; }
Property Value
Type Description
Colour

IndianRed

Declaration
public static Colour IndianRed { get; }
Property Value
Type Description
Colour

Indigo

Declaration
public static Colour Indigo { get; }
Property Value
Type Description
Colour

Ivory

Declaration
public static Colour Ivory { get; }
Property Value
Type Description
Colour

Khaki

Declaration
public static Colour Khaki { get; }
Property Value
Type Description
Colour

Lavender

Declaration
public static Colour Lavender { get; }
Property Value
Type Description
Colour

LavenderBlush

Declaration
public static Colour LavenderBlush { get; }
Property Value
Type Description
Colour

LawnGreen

Declaration
public static Colour LawnGreen { get; }
Property Value
Type Description
Colour

LemonChiffon

Declaration
public static Colour LemonChiffon { get; }
Property Value
Type Description
Colour

LightBlue

Declaration
public static Colour LightBlue { get; }
Property Value
Type Description
Colour

LightCoral

Declaration
public static Colour LightCoral { get; }
Property Value
Type Description
Colour

LightCyan

Declaration
public static Colour LightCyan { get; }
Property Value
Type Description
Colour

LightGoldenrod

Declaration
public static Colour LightGoldenrod { get; }
Property Value
Type Description
Colour

LightGray

Declaration
public static Colour LightGray { get; }
Property Value
Type Description
Colour

LightGreen

Declaration
public static Colour LightGreen { get; }
Property Value
Type Description
Colour

LightPink

Declaration
public static Colour LightPink { get; }
Property Value
Type Description
Colour

LightSalmon

Declaration
public static Colour LightSalmon { get; }
Property Value
Type Description
Colour

LightSeaGreen

Declaration
public static Colour LightSeaGreen { get; }
Property Value
Type Description
Colour

LightSkyBlue

Declaration
public static Colour LightSkyBlue { get; }
Property Value
Type Description
Colour

LightSlateGray

Declaration
public static Colour LightSlateGray { get; }
Property Value
Type Description
Colour

LightSteelBlue

Declaration
public static Colour LightSteelBlue { get; }
Property Value
Type Description
Colour

LightYellow

Declaration
public static Colour LightYellow { get; }
Property Value
Type Description
Colour

Lime

Declaration
public static Colour Lime { get; }
Property Value
Type Description
Colour

LimeGreen

Declaration
public static Colour LimeGreen { get; }
Property Value
Type Description
Colour

Linen

Declaration
public static Colour Linen { get; }
Property Value
Type Description
Colour

Magenta

Declaration
public static Colour Magenta { get; }
Property Value
Type Description
Colour

Maroon

Declaration
public static Colour Maroon { get; }
Property Value
Type Description
Colour

MediumAquamarine

Declaration
public static Colour MediumAquamarine { get; }
Property Value
Type Description
Colour

MediumBlue

Declaration
public static Colour MediumBlue { get; }
Property Value
Type Description
Colour

MediumOrchid

Declaration
public static Colour MediumOrchid { get; }
Property Value
Type Description
Colour

MediumPurple

Declaration
public static Colour MediumPurple { get; }
Property Value
Type Description
Colour

MediumSeaGreen

Declaration
public static Colour MediumSeaGreen { get; }
Property Value
Type Description
Colour

MediumSlateBlue

Declaration
public static Colour MediumSlateBlue { get; }
Property Value
Type Description
Colour

MediumSpringGreen

Declaration
public static Colour MediumSpringGreen { get; }
Property Value
Type Description
Colour

MediumTurquoise

Declaration
public static Colour MediumTurquoise { get; }
Property Value
Type Description
Colour

MediumVioletRed

Declaration
public static Colour MediumVioletRed { get; }
Property Value
Type Description
Colour

MidnightBlue

Declaration
public static Colour MidnightBlue { get; }
Property Value
Type Description
Colour

MintCream

Declaration
public static Colour MintCream { get; }
Property Value
Type Description
Colour

MistyRose

Declaration
public static Colour MistyRose { get; }
Property Value
Type Description
Colour

Moccasin

Declaration
public static Colour Moccasin { get; }
Property Value
Type Description
Colour

NavajoWhite

Declaration
public static Colour NavajoWhite { get; }
Property Value
Type Description
Colour

NavyBlue

Declaration
public static Colour NavyBlue { get; }
Property Value
Type Description
Colour

OldLace

Declaration
public static Colour OldLace { get; }
Property Value
Type Description
Colour

Olive

Declaration
public static Colour Olive { get; }
Property Value
Type Description
Colour

OliveDrab

Declaration
public static Colour OliveDrab { get; }
Property Value
Type Description
Colour

Orange

Declaration
public static Colour Orange { get; }
Property Value
Type Description
Colour

OrangeRed

Declaration
public static Colour OrangeRed { get; }
Property Value
Type Description
Colour

Orchid

Declaration
public static Colour Orchid { get; }
Property Value
Type Description
Colour

PaleGoldenrod

Declaration
public static Colour PaleGoldenrod { get; }
Property Value
Type Description
Colour

PaleGreen

Declaration
public static Colour PaleGreen { get; }
Property Value
Type Description
Colour

PaleTurquoise

Declaration
public static Colour PaleTurquoise { get; }
Property Value
Type Description
Colour

PaleVioletRed

Declaration
public static Colour PaleVioletRed { get; }
Property Value
Type Description
Colour

PapayaWhip

Declaration
public static Colour PapayaWhip { get; }
Property Value
Type Description
Colour

PeachPuff

Declaration
public static Colour PeachPuff { get; }
Property Value
Type Description
Colour

Peru

Declaration
public static Colour Peru { get; }
Property Value
Type Description
Colour

Pink

Declaration
public static Colour Pink { get; }
Property Value
Type Description
Colour

Plum

Declaration
public static Colour Plum { get; }
Property Value
Type Description
Colour

PowderBlue

Declaration
public static Colour PowderBlue { get; }
Property Value
Type Description
Colour

Purple

Declaration
public static Colour Purple { get; }
Property Value
Type Description
Colour

R

Declaration
public float R { get; }
Property Value
Type Description
float

RebeccaPurple

Declaration
public static Colour RebeccaPurple { get; }
Property Value
Type Description
Colour

Red

Declaration
public static Colour Red { get; }
Property Value
Type Description
Colour

RosyBrown

Declaration
public static Colour RosyBrown { get; }
Property Value
Type Description
Colour

RoyalBlue

Declaration
public static Colour RoyalBlue { get; }
Property Value
Type Description
Colour

SaddleBrown

Declaration
public static Colour SaddleBrown { get; }
Property Value
Type Description
Colour

Salmon

Declaration
public static Colour Salmon { get; }
Property Value
Type Description
Colour

SandyBrown

Declaration
public static Colour SandyBrown { get; }
Property Value
Type Description
Colour

SeaGreen

Declaration
public static Colour SeaGreen { get; }
Property Value
Type Description
Colour

Seashell

Declaration
public static Colour Seashell { get; }
Property Value
Type Description
Colour

Sienna

Declaration
public static Colour Sienna { get; }
Property Value
Type Description
Colour

Silver

Declaration
public static Colour Silver { get; }
Property Value
Type Description
Colour

SkyBlue

Declaration
public static Colour SkyBlue { get; }
Property Value
Type Description
Colour

SlateBlue

Declaration
public static Colour SlateBlue { get; }
Property Value
Type Description
Colour

SlateGray

Declaration
public static Colour SlateGray { get; }
Property Value
Type Description
Colour

Snow

Declaration
public static Colour Snow { get; }
Property Value
Type Description
Colour

SpringGreen

Declaration
public static Colour SpringGreen { get; }
Property Value
Type Description
Colour

SteelBlue

Declaration
public static Colour SteelBlue { get; }
Property Value
Type Description
Colour

Tan

Declaration
public static Colour Tan { get; }
Property Value
Type Description
Colour

Teal

Declaration
public static Colour Teal { get; }
Property Value
Type Description
Colour

Thistle

Declaration
public static Colour Thistle { get; }
Property Value
Type Description
Colour

Tomato

Declaration
public static Colour Tomato { get; }
Property Value
Type Description
Colour

Turquoise

Declaration
public static Colour Turquoise { get; }
Property Value
Type Description
Colour

Violet

Declaration
public static Colour Violet { get; }
Property Value
Type Description
Colour

WebGray

Declaration
public static Colour WebGray { get; }
Property Value
Type Description
Colour

WebGreen

Declaration
public static Colour WebGreen { get; }
Property Value
Type Description
Colour

WebMaroon

Declaration
public static Colour WebMaroon { get; }
Property Value
Type Description
Colour

WebPurple

Declaration
public static Colour WebPurple { get; }
Property Value
Type Description
Colour

Wheat

Declaration
public static Colour Wheat { get; }
Property Value
Type Description
Colour

White

Declaration
public static Colour White { get; }
Property Value
Type Description
Colour

WhiteSmoke

Declaration
public static Colour WhiteSmoke { get; }
Property Value
Type Description
Colour

Yellow

Declaration
public static Colour Yellow { get; }
Property Value
Type Description
Colour

YellowGreen

Declaration
public static Colour YellowGreen { get; }
Property Value
Type Description
Colour

Methods

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
ValueType.Equals(object)

Equals(Colour)

Declaration
public bool Equals(Colour other)
Parameters
Type Name Description
Colour other
Returns
Type Description
bool

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
ValueType.GetHashCode()

ToVector3()

Return R, G, B components as Vector3 (A ignored)

Declaration
public Vector3 ToVector3()
Returns
Type Description
Vector3

ToVector4()

Return R, G, B, A as Vector4

Declaration
public Vector4 ToVector4()
Returns
Type Description
Vector4

Operators

operator +(Colour, Colour)

Declaration
public static Colour operator +(Colour c0, Colour c1)
Parameters
Type Name Description
Colour c0
Colour c1
Returns
Type Description
Colour

operator ==(Colour, Colour)

Declaration
public static bool operator ==(Colour left, Colour right)
Parameters
Type Name Description
Colour left
Colour right
Returns
Type Description
bool

operator !=(Colour, Colour)

Declaration
public static bool operator !=(Colour left, Colour right)
Parameters
Type Name Description
Colour left
Colour right
Returns
Type Description
bool

operator *(float, Colour)

Declaration
public static Colour operator *(float f, Colour c)
Parameters
Type Name Description
float f
Colour c
Returns
Type Description
Colour

operator *(Colour, float)

Declaration
public static Colour operator *(Colour c, float f)
Parameters
Type Name Description
Colour c
float f
Returns
Type Description
Colour

operator *(Colour, Colour)

Declaration
public static Colour operator *(Colour c0, Colour c1)
Parameters
Type Name Description
Colour c0
Colour c1
Returns
Type Description
Colour

operator -(Colour, Colour)

Declaration
public static Colour operator -(Colour c0, Colour c1)
Parameters
Type Name Description
Colour c0
Colour c1
Returns
Type Description
Colour

Implements

IEquatable<T>
In this article
Back to top yak2D - Alex Paterson