Struct Color
- Namespace
- SimulationFramework
- Assembly
- SimulationFramework.dll
Represents a 32-bit RGBA color.
public readonly struct Color : IEquatable<Color>- Implements
- Inherited Members
- Extension Methods
Constructors
Color()
Creates a new color.
public Color()Color(byte, byte, byte)
Creates a new color with the provided RGB values, and an alpha of 255.
public Color(byte r, byte g, byte b)Parameters
rbyteThe red component of the color.
gbyteThe green component of the color.
bbyteThe blue component of the color.
Color(byte, byte, byte, byte)
Creates a new color with the provided values.
public Color(byte r, byte g, byte b, byte a)Parameters
rbyteThe red component of the color.
gbyteThe green component of the color.
bbyteThe blue component of the color.
abyteThe alpha component of the color.
Color(Vector3)
Creates a new color from the provided RGB values.
public Color(Vector3 values)Parameters
valuesVector3The RGB values of the color. The value of each component should be between 0 and 1.
Color(Vector4)
Creates a new color from the provided RGBA values.
public Color(Vector4 values)Parameters
valuesVector4The RGBA values of the color. The value of each component should be between 0 and 1.
Color(float, float, float)
Creates a new color from the provided RGB values, and an alpha component of 255.
public Color(float r, float g, float b)Parameters
rfloatThe red component of the color. This value should be between 0 and 1.
gfloatThe green component of the color. This value should be between 0 and 1.
bfloatThe blue component of the color. This value should be between 0 and 1.
Color(float, float, float, float)
Creates a new color from the provided RGBA values.
public Color(float r, float g, float b, float a)Parameters
rfloatThe red component of the color. This value should be between 0 and 1.
gfloatThe green component of the color. This value should be between 0 and 1.
bfloatThe blue component of the color. This value should be between 0 and 1.
afloatThe alpha component of the color. This value should be between 0 and 1.
Color(uint)
Creates a color from the provided uint RGBA value.
public Color(uint value)Parameters
valueuintThe RGBA color value, where R is the least significant byte, and A is the most significant byte.
Fields
AliceBlue
An RGBA color with the value #F0F8FFFF.
public static readonly Color AliceBlueField Value
AntiqueWhite
An RGBA color with the value #FAEBD7FF.
public static readonly Color AntiqueWhiteField Value
Aqua
An RGBA color with the value #00FFFFFF.
public static readonly Color AquaField Value
Aquamarine
An RGBA color with the value #7FFFD4FF.
public static readonly Color AquamarineField Value
Azure
An RGBA color with the value #F0FFFFFF.
public static readonly Color AzureField Value
Beige
An RGBA color with the value #F5F5DCFF.
public static readonly Color BeigeField Value
Bisque
An RGBA color with the value #FFE4C4FF.
public static readonly Color BisqueField Value
Black
An RGBA color with the value #000000FF.
public static readonly Color BlackField Value
BlanchedAlmond
An RGBA color with the value #FFEBCDFF.
public static readonly Color BlanchedAlmondField Value
Blue
An RGBA color with the value #0000FFFF.
public static readonly Color BlueField Value
BlueViolet
An RGBA color with the value #8A2BE2FF.
public static readonly Color BlueVioletField Value
Brown
An RGBA color with the value #A52A2AFF.
public static readonly Color BrownField Value
BurlyWood
An RGBA color with the value #DEB887FF.
public static readonly Color BurlyWoodField Value
CadetBlue
An RGBA color with the value #5F9EA0FF.
public static readonly Color CadetBlueField Value
Chartreuse
An RGBA color with the value #7FFF00FF.
public static readonly Color ChartreuseField Value
Chocolate
An RGBA color with the value #D2691EFF.
public static readonly Color ChocolateField Value
Coral
An RGBA color with the value #FF7F50FF.
public static readonly Color CoralField Value
CornflowerBlue
An RGBA color with the value #6495EDFF.
public static readonly Color CornflowerBlueField Value
Cornsilk
An RGBA color with the value #FFF8DCFF.
public static readonly Color CornsilkField Value
Crimson
An RGBA color with the value #DC143CFF.
public static readonly Color CrimsonField Value
Cyan
An RGBA color with the value #00FFFFFF.
public static readonly Color CyanField Value
DarkBlue
An RGBA color with the value #00008BFF.
public static readonly Color DarkBlueField Value
DarkCyan
An RGBA color with the value #008B8BFF.
public static readonly Color DarkCyanField Value
DarkGoldenrod
An RGBA color with the value #B8860BFF.
public static readonly Color DarkGoldenrodField Value
DarkGray
An RGBA color with the value #A9A9A9FF.
public static readonly Color DarkGrayField Value
DarkGreen
An RGBA color with the value #006400FF.
public static readonly Color DarkGreenField Value
DarkKhaki
An RGBA color with the value #BDB76BFF.
public static readonly Color DarkKhakiField Value
DarkMagenta
An RGBA color with the value #8B008BFF.
public static readonly Color DarkMagentaField Value
DarkOliveGreen
An RGBA color with the value #556B2FFF.
public static readonly Color DarkOliveGreenField Value
DarkOrange
An RGBA color with the value #FF8C00FF.
public static readonly Color DarkOrangeField Value
DarkOrchid
An RGBA color with the value #9932CCFF.
public static readonly Color DarkOrchidField Value
DarkRed
An RGBA color with the value #8B0000FF.
public static readonly Color DarkRedField Value
DarkSalmon
An RGBA color with the value #E9967AFF.
public static readonly Color DarkSalmonField Value
DarkSeaGreen
An RGBA color with the value #8FBC8BFF.
public static readonly Color DarkSeaGreenField Value
DarkSlateBlue
An RGBA color with the value #483D8BFF.
public static readonly Color DarkSlateBlueField Value
DarkSlateGray
An RGBA color with the value #2F4F4FFF.
public static readonly Color DarkSlateGrayField Value
DarkTurquoise
An RGBA color with the value #00CED1FF.
public static readonly Color DarkTurquoiseField Value
DarkViolet
An RGBA color with the value #9400D3FF.
public static readonly Color DarkVioletField Value
DeepPink
An RGBA color with the value #FF1493FF.
public static readonly Color DeepPinkField Value
DeepSkyBlue
An RGBA color with the value #00BFFFFF.
public static readonly Color DeepSkyBlueField Value
DimGray
An RGBA color with the value #696969FF.
public static readonly Color DimGrayField Value
DodgerBlue
An RGBA color with the value #1E90FFFF.
public static readonly Color DodgerBlueField Value
Firebrick
An RGBA color with the value #B22222FF.
public static readonly Color FirebrickField Value
FloralWhite
An RGBA color with the value #FFFAF0FF.
public static readonly Color FloralWhiteField Value
ForestGreen
An RGBA color with the value #228B22FF.
public static readonly Color ForestGreenField Value
Fuchsia
An RGBA color with the value #FF00FFFF.
public static readonly Color FuchsiaField Value
Gainsboro
An RGBA color with the value #DCDCDCFF.
public static readonly Color GainsboroField Value
GhostWhite
An RGBA color with the value #F8F8FFFF.
public static readonly Color GhostWhiteField Value
Gold
An RGBA color with the value #FFD700FF.
public static readonly Color GoldField Value
Goldenrod
An RGBA color with the value #DAA520FF.
public static readonly Color GoldenrodField Value
Gray
An RGBA color with the value #808080FF.
public static readonly Color GrayField Value
Green
An RGBA color with the value #008000FF.
public static readonly Color GreenField Value
GreenYellow
An RGBA color with the value #ADFF2FFF.
public static readonly Color GreenYellowField Value
Honeydew
An RGBA color with the value #F0FFF0FF.
public static readonly Color HoneydewField Value
HotPink
An RGBA color with the value #FF69B4FF.
public static readonly Color HotPinkField Value
IndianRed
An RGBA color with the value #CD5C5CFF.
public static readonly Color IndianRedField Value
Indigo
An RGBA color with the value #4B0082FF.
public static readonly Color IndigoField Value
Ivory
An RGBA color with the value #FFFFF0FF.
public static readonly Color IvoryField Value
Khaki
An RGBA color with the value #F0E68CFF.
public static readonly Color KhakiField Value
Lavender
An RGBA color with the value #E6E6FAFF.
public static readonly Color LavenderField Value
LavenderBlush
An RGBA color with the value #FFF0F5FF.
public static readonly Color LavenderBlushField Value
LawnGreen
An RGBA color with the value #7CFC00FF.
public static readonly Color LawnGreenField Value
LemonChiffon
An RGBA color with the value #FFFACDFF.
public static readonly Color LemonChiffonField Value
LightBlue
An RGBA color with the value #ADD8E6FF.
public static readonly Color LightBlueField Value
LightCoral
An RGBA color with the value #F08080FF.
public static readonly Color LightCoralField Value
LightCyan
An RGBA color with the value #E0FFFFFF.
public static readonly Color LightCyanField Value
LightGoldenrodYellow
An RGBA color with the value #FAFAD2FF.
public static readonly Color LightGoldenrodYellowField Value
LightGray
An RGBA color with the value #D3D3D3FF.
public static readonly Color LightGrayField Value
LightGreen
An RGBA color with the value #90EE90FF.
public static readonly Color LightGreenField Value
LightPink
An RGBA color with the value #FFB6C1FF.
public static readonly Color LightPinkField Value
LightSalmon
An RGBA color with the value #FFA07AFF.
public static readonly Color LightSalmonField Value
LightSeaGreen
An RGBA color with the value #20B2AAFF.
public static readonly Color LightSeaGreenField Value
LightSkyBlue
An RGBA color with the value #87CEFAFF.
public static readonly Color LightSkyBlueField Value
LightSlateGray
An RGBA color with the value #778899FF.
public static readonly Color LightSlateGrayField Value
LightSteelBlue
An RGBA color with the value #B0C4DEFF.
public static readonly Color LightSteelBlueField Value
LightYellow
An RGBA color with the value #FFFFE0FF.
public static readonly Color LightYellowField Value
Lime
An RGBA color with the value #00FF00FF.
public static readonly Color LimeField Value
LimeGreen
An RGBA color with the value #32CD32FF.
public static readonly Color LimeGreenField Value
Linen
An RGBA color with the value #FAF0E6FF.
public static readonly Color LinenField Value
Magenta
An RGBA color with the value #FF00FFFF.
public static readonly Color MagentaField Value
Maroon
An RGBA color with the value #800000FF.
public static readonly Color MaroonField Value
MediumAquamarine
An RGBA color with the value #66CDAAFF.
public static readonly Color MediumAquamarineField Value
MediumBlue
An RGBA color with the value #0000CDFF.
public static readonly Color MediumBlueField Value
MediumOrchid
An RGBA color with the value #BA55D3FF.
public static readonly Color MediumOrchidField Value
MediumPurple
An RGBA color with the value #9370DBFF.
public static readonly Color MediumPurpleField Value
MediumSeaGreen
An RGBA color with the value #3CB371FF.
public static readonly Color MediumSeaGreenField Value
MediumSlateBlue
An RGBA color with the value #7B68EEFF.
public static readonly Color MediumSlateBlueField Value
MediumSpringGreen
An RGBA color with the value #00FA9AFF.
public static readonly Color MediumSpringGreenField Value
MediumTurquoise
An RGBA color with the value #48D1CCFF.
public static readonly Color MediumTurquoiseField Value
MediumVioletRed
An RGBA color with the value #C71585FF.
public static readonly Color MediumVioletRedField Value
MidnightBlue
An RGBA color with the value #191970FF.
public static readonly Color MidnightBlueField Value
MintCream
An RGBA color with the value #F5FFFAFF.
public static readonly Color MintCreamField Value
MistyRose
An RGBA color with the value #FFE4E1FF.
public static readonly Color MistyRoseField Value
Moccasin
An RGBA color with the value #FFE4B5FF.
public static readonly Color MoccasinField Value
NavajoWhite
An RGBA color with the value #FFDEADFF.
public static readonly Color NavajoWhiteField Value
Navy
An RGBA color with the value #000080FF.
public static readonly Color NavyField Value
OldLace
An RGBA color with the value #FDF5E6FF.
public static readonly Color OldLaceField Value
Olive
An RGBA color with the value #808000FF.
public static readonly Color OliveField Value
OliveDrab
An RGBA color with the value #6B8E23FF.
public static readonly Color OliveDrabField Value
Orange
An RGBA color with the value #FFA500FF.
public static readonly Color OrangeField Value
OrangeRed
An RGBA color with the value #FF4500FF.
public static readonly Color OrangeRedField Value
Orchid
An RGBA color with the value #DA70D6FF.
public static readonly Color OrchidField Value
PaleGoldenrod
An RGBA color with the value #EEE8AAFF.
public static readonly Color PaleGoldenrodField Value
PaleGreen
An RGBA color with the value #98FB98FF.
public static readonly Color PaleGreenField Value
PaleTurquoise
An RGBA color with the value #AFEEEEFF.
public static readonly Color PaleTurquoiseField Value
PaleVioletRed
An RGBA color with the value #DB7093FF.
public static readonly Color PaleVioletRedField Value
PapayaWhip
An RGBA color with the value #FFEFD5FF.
public static readonly Color PapayaWhipField Value
PeachPuff
An RGBA color with the value #FFDAB9FF.
public static readonly Color PeachPuffField Value
Peru
An RGBA color with the value #CD853FFF.
public static readonly Color PeruField Value
Pink
An RGBA color with the value #FFC0CBFF.
public static readonly Color PinkField Value
Plum
An RGBA color with the value #DDA0DDFF.
public static readonly Color PlumField Value
PowderBlue
An RGBA color with the value #B0E0E6FF.
public static readonly Color PowderBlueField Value
Purple
An RGBA color with the value #800080FF.
public static readonly Color PurpleField Value
RebeccaPurple
An RGBA color with the value #663399FF.
public static readonly Color RebeccaPurpleField Value
Red
An RGBA color with the value #FF0000FF.
public static readonly Color RedField Value
RosyBrown
An RGBA color with the value #BC8F8FFF.
public static readonly Color RosyBrownField Value
RoyalBlue
An RGBA color with the value #4169E1FF.
public static readonly Color RoyalBlueField Value
SaddleBrown
An RGBA color with the value #8B4513FF.
public static readonly Color SaddleBrownField Value
Salmon
An RGBA color with the value #FA8072FF.
public static readonly Color SalmonField Value
SandyBrown
An RGBA color with the value #F4A460FF.
public static readonly Color SandyBrownField Value
SeaGreen
An RGBA color with the value #2E8B57FF.
public static readonly Color SeaGreenField Value
SeaShell
An RGBA color with the value #FFF5EEFF.
public static readonly Color SeaShellField Value
Sienna
An RGBA color with the value #A0522DFF.
public static readonly Color SiennaField Value
Silver
An RGBA color with the value #C0C0C0FF.
public static readonly Color SilverField Value
SkyBlue
An RGBA color with the value #87CEEBFF.
public static readonly Color SkyBlueField Value
SlateBlue
An RGBA color with the value #6A5ACDFF.
public static readonly Color SlateBlueField Value
SlateGray
An RGBA color with the value #708090FF.
public static readonly Color SlateGrayField Value
Snow
An RGBA color with the value #FFFAFAFF.
public static readonly Color SnowField Value
SpringGreen
An RGBA color with the value #00FF7FFF.
public static readonly Color SpringGreenField Value
SteelBlue
An RGBA color with the value #4682B4FF.
public static readonly Color SteelBlueField Value
Tan
An RGBA color with the value #D2B48CFF.
public static readonly Color TanField Value
Teal
An RGBA color with the value #008080FF.
public static readonly Color TealField Value
Thistle
An RGBA color with the value #D8BFD8FF.
public static readonly Color ThistleField Value
Tomato
An RGBA color with the value #FF6347FF.
public static readonly Color TomatoField Value
Transparent
An RGBA color with the value #00000000.
public static readonly Color TransparentField Value
Turquoise
An RGBA color with the value #40E0D0FF.
public static readonly Color TurquoiseField Value
Violet
An RGBA color with the value #EE82EEFF.
public static readonly Color VioletField Value
Wheat
An RGBA color with the value #F5DEB3FF.
public static readonly Color WheatField Value
White
An RGBA color with the value #FFFFFFFF.
public static readonly Color WhiteField Value
WhiteSmoke
An RGBA color with the value #F5F5F5FF.
public static readonly Color WhiteSmokeField Value
Yellow
An RGBA color with the value #FFFF00FF.
public static readonly Color YellowField Value
YellowGreen
An RGBA color with the value #9ACD32FF.
public static readonly Color YellowGreenField Value
Properties
A
The 8-bit value of the alpha component of this color.
public byte A { get; init; }Property Value
B
The 8-bit value of the blue component of this color.
public byte B { get; init; }Property Value
G
The 8-bit value of the green component of this color.
public byte G { get; init; }Property Value
R
The 8-bit value of the red component of this color.
public byte R { get; init; }Property Value
Value
The 32-bit, RGBA value of this color.
public uint Value { get; init; }Property Value
Methods
AsVector3()
public Vector3 AsVector3()Returns
AsVector4()
public Vector4 AsVector4()Returns
Equals(Color)
Indicates that this color is the same as another.
public bool Equals(Color other)Parameters
otherColorThe other color.
Returns
Equals(object?)
Indicates whether this instance and a specified object are equal.
public override bool Equals(object? obj)Parameters
objobjectThe object to compare with the current instance.
Returns
- bool
true if
objand this instance are the same type and represent the same value; otherwise, false.
FromHSV(Vector3)
Creates a color given a hue, saturation, and value.
public static Color FromHSV(Vector3 channels)Parameters
channelsVector3The channels of the color, where X is hue, Y is saturation, and Z is value.
Returns
- Color
The created color.
FromHSV(Vector4)
Creates a color given a hue, saturation, value, and alpha.
public static Color FromHSV(Vector4 channels)Parameters
channelsVector4The channels of the color, where X is hue, Y is saturation, Z is value, and W is alpha.
Returns
- Color
The created color.
FromHSV(float, float, float)
Creates a color given a hue, saturation, and value.
public static Color FromHSV(float hue, float saturation, float value)Parameters
huefloatThe hue of the color. This must be between 0 and 1.
saturationfloatThe saturation of the color. This must be between 0 and 1.
valuefloatThe value (brightness) of the color. This must be between 0 and 1.
Returns
- Color
The created color.
FromHSV(float, float, float, float)
Creates a color given a hue, saturation, value, and alpha.
public static Color FromHSV(float hue, float saturation, float value, float alpha)Parameters
huefloatThe hue of the color. This must be between 0 and 1.
saturationfloatThe saturation of the color. This must be between 0 and 1.
valuefloatThe value (brightness) of the color. This must be between 0 and 1.
alphafloatThe alpha of the color. This must be between 0 and 1.
Returns
- Color
The created color.
GetHashCode()
Returns the hash code for this instance.
public override int GetHashCode()Returns
- int
A 32-bit signed integer that is the hash code for this instance.
Lerp(Color, Color, float)
Linearly interpolates between two Color values in RGBA space.
public static Color Lerp(Color color1, Color color2, float t)Parameters
color1ColorThe first color.
color2ColorThe second color.
tfloatThe interpolation amount, from 0.0 to 1.0.
Returns
- Color
The interpolated color.
LerpHSV(Color, Color, float)
Linearly interpolates between two Color values in HSV space.
public static Color LerpHSV(Color color1, Color color2, float t)Parameters
color1ColorThe first color.
color2ColorThe second color.
tfloatThe interpolation amount, from 0.0 to 1.0.
Returns
- Color
The interpolated color.
Parse(ReadOnlySpan<char>)
Converts to a color from its string representation.
public static Color Parse(ReadOnlySpan<char> value)Parameters
valueReadOnlySpan<char>The string representation of the color.
Returns
- Color
The color that the string represents.
Exceptions
Parse(string)
Converts to a color from its string representation.
public static Color Parse(string value)Parameters
valuestringThe string representation of the color.
Returns
- Color
The color that the string represents.
Exceptions
ToColorF()
public ColorF ToColorF()Returns
ToHSV()
Computes the values of this Color in the HSV color space.
public Vector3 ToHSV()Returns
- Vector3
The computed values, where X is hue, Y is saturation, and Z is value.
ToHSVA()
Computes the values of this Color in the HSV color space.
public Vector4 ToHSVA()Returns
- Vector4
The computed values, where X is hue, Y is saturation, Z is value, and W is alpha.
ToString()
Returns the hexadecimal-formatted value of this color.
public override string ToString()Returns
TryParse(ReadOnlySpan<char>, out Color)
Attempts to converts to a color from its string representation.
public static bool TryParse(ReadOnlySpan<char> value, out Color result)Parameters
valueReadOnlySpan<char>The string representation of the color.
resultColorThe value of the color.
Returns
TryParse(string, out Color)
Attempts to converts to a color from its string representation.
public static bool TryParse(string value, out Color result)Parameters
Returns
Operators
operator ==(Color, Color)
Indicates if two Color objects are equal.
public static bool operator ==(Color left, Color right)Parameters
Returns
explicit operator Color(Color)
public static explicit operator Color(Color value)Parameters
valueColorThe color to convert.
Returns
explicit operator uint(Color)
public static explicit operator uint(Color color)Parameters
colorColorThe color to convert.
Returns
explicit operator Color(Color)
public static explicit operator Color(Color value)Parameters
valueColorThe color to convert.
Returns
explicit operator Color(uint)
public static explicit operator Color(uint value)Parameters
valueuint
Returns
operator !=(Color, Color)
Indicates if two Color objects are not equal.
public static bool operator !=(Color left, Color right)