Struct Color
- Namespace
- SixLabors.ImageSharp
- Assembly
- SixLabors.ImageSharp.dll
Represents a color value that is convertible to any IPixel<TSelf> type.
public readonly struct Color : IEquatable<Color>- Implements
- Inherited Members
Remarks
The internal representation and layout of this structure is hidden by intention. It's not serializable, and it should not be considered as part of a contract. Unlike System.Drawing.Color, Color has to be converted to a specific pixel value to query the color components.
Fields
AliceBlue
Represents a
public static readonly Color AliceBlueField Value
AntiqueWhite
Represents a
public static readonly Color AntiqueWhiteField Value
Aqua
Represents a
public static readonly Color AquaField Value
Aquamarine
Represents a
public static readonly Color AquamarineField Value
Azure
Represents a
public static readonly Color AzureField Value
Beige
Represents a
public static readonly Color BeigeField Value
Bisque
Represents a
public static readonly Color BisqueField Value
Black
Represents a
public static readonly Color BlackField Value
BlanchedAlmond
Represents a
public static readonly Color BlanchedAlmondField Value
Blue
Represents a
public static readonly Color BlueField Value
BlueViolet
Represents a
public static readonly Color BlueVioletField Value
Brown
Represents a
public static readonly Color BrownField Value
BurlyWood
Represents a
public static readonly Color BurlyWoodField Value
CadetBlue
Represents a
public static readonly Color CadetBlueField Value
Chartreuse
Represents a
public static readonly Color ChartreuseField Value
Chocolate
Represents a
public static readonly Color ChocolateField Value
Coral
Represents a
public static readonly Color CoralField Value
CornflowerBlue
Represents a
public static readonly Color CornflowerBlueField Value
Cornsilk
Represents a
public static readonly Color CornsilkField Value
Crimson
Represents a
public static readonly Color CrimsonField Value
Cyan
Represents a
public static readonly Color CyanField Value
DarkBlue
Represents a
public static readonly Color DarkBlueField Value
DarkCyan
Represents a
public static readonly Color DarkCyanField Value
DarkGoldenrod
Represents a
public static readonly Color DarkGoldenrodField Value
DarkGray
Represents a
public static readonly Color DarkGrayField Value
DarkGreen
Represents a
public static readonly Color DarkGreenField Value
DarkGrey
Represents a
public static readonly Color DarkGreyField Value
DarkKhaki
Represents a
public static readonly Color DarkKhakiField Value
DarkMagenta
Represents a
public static readonly Color DarkMagentaField Value
DarkOliveGreen
Represents a
public static readonly Color DarkOliveGreenField Value
DarkOrange
Represents a
public static readonly Color DarkOrangeField Value
DarkOrchid
Represents a
public static readonly Color DarkOrchidField Value
DarkRed
Represents a
public static readonly Color DarkRedField Value
DarkSalmon
Represents a
public static readonly Color DarkSalmonField Value
DarkSeaGreen
Represents a
public static readonly Color DarkSeaGreenField Value
DarkSlateBlue
Represents a
public static readonly Color DarkSlateBlueField Value
DarkSlateGray
Represents a
public static readonly Color DarkSlateGrayField Value
DarkSlateGrey
Represents a
public static readonly Color DarkSlateGreyField Value
DarkTurquoise
Represents a
public static readonly Color DarkTurquoiseField Value
DarkViolet
Represents a
public static readonly Color DarkVioletField Value
DeepPink
Represents a
public static readonly Color DeepPinkField Value
DeepSkyBlue
Represents a
public static readonly Color DeepSkyBlueField Value
DimGray
Represents a
public static readonly Color DimGrayField Value
DimGrey
Represents a
public static readonly Color DimGreyField Value
DodgerBlue
Represents a
public static readonly Color DodgerBlueField Value
Firebrick
Represents a
public static readonly Color FirebrickField Value
FloralWhite
Represents a
public static readonly Color FloralWhiteField Value
ForestGreen
Represents a
public static readonly Color ForestGreenField Value
Fuchsia
Represents a
public static readonly Color FuchsiaField Value
Gainsboro
Represents a
public static readonly Color GainsboroField Value
GhostWhite
Represents a
public static readonly Color GhostWhiteField Value
Gold
Represents a
public static readonly Color GoldField Value
Goldenrod
Represents a
public static readonly Color GoldenrodField Value
Gray
Represents a
public static readonly Color GrayField Value
Green
Represents a
public static readonly Color GreenField Value
GreenYellow
Represents a
public static readonly Color GreenYellowField Value
Grey
Represents a
public static readonly Color GreyField Value
Honeydew
Represents a
public static readonly Color HoneydewField Value
HotPink
Represents a
public static readonly Color HotPinkField Value
IndianRed
Represents a
public static readonly Color IndianRedField Value
Indigo
Represents a
public static readonly Color IndigoField Value
Ivory
Represents a
public static readonly Color IvoryField Value
Khaki
Represents a
public static readonly Color KhakiField Value
Lavender
Represents a
public static readonly Color LavenderField Value
LavenderBlush
Represents a
public static readonly Color LavenderBlushField Value
LawnGreen
Represents a
public static readonly Color LawnGreenField Value
LemonChiffon
Represents a
public static readonly Color LemonChiffonField Value
LightBlue
Represents a
public static readonly Color LightBlueField Value
LightCoral
Represents a
public static readonly Color LightCoralField Value
LightCyan
Represents a
public static readonly Color LightCyanField Value
LightGoldenrodYellow
Represents a
public static readonly Color LightGoldenrodYellowField Value
LightGray
Represents a
public static readonly Color LightGrayField Value
LightGreen
Represents a
public static readonly Color LightGreenField Value
LightGrey
Represents a
public static readonly Color LightGreyField Value
LightPink
Represents a
public static readonly Color LightPinkField Value
LightSalmon
Represents a
public static readonly Color LightSalmonField Value
LightSeaGreen
Represents a
public static readonly Color LightSeaGreenField Value
LightSkyBlue
Represents a
public static readonly Color LightSkyBlueField Value
LightSlateGray
Represents a
public static readonly Color LightSlateGrayField Value
LightSlateGrey
Represents a
public static readonly Color LightSlateGreyField Value
LightSteelBlue
Represents a
public static readonly Color LightSteelBlueField Value
LightYellow
Represents a
public static readonly Color LightYellowField Value
Lime
Represents a
public static readonly Color LimeField Value
LimeGreen
Represents a
public static readonly Color LimeGreenField Value
Linen
Represents a
public static readonly Color LinenField Value
Magenta
Represents a
public static readonly Color MagentaField Value
Maroon
Represents a
public static readonly Color MaroonField Value
MediumAquamarine
Represents a
public static readonly Color MediumAquamarineField Value
MediumBlue
Represents a
public static readonly Color MediumBlueField Value
MediumOrchid
Represents a
public static readonly Color MediumOrchidField Value
MediumPurple
Represents a
public static readonly Color MediumPurpleField Value
MediumSeaGreen
Represents a
public static readonly Color MediumSeaGreenField Value
MediumSlateBlue
Represents a
public static readonly Color MediumSlateBlueField Value
MediumSpringGreen
Represents a
public static readonly Color MediumSpringGreenField Value
MediumTurquoise
Represents a
public static readonly Color MediumTurquoiseField Value
MediumVioletRed
Represents a
public static readonly Color MediumVioletRedField Value
MidnightBlue
Represents a
public static readonly Color MidnightBlueField Value
MintCream
Represents a
public static readonly Color MintCreamField Value
MistyRose
Represents a
public static readonly Color MistyRoseField Value
Moccasin
Represents a
public static readonly Color MoccasinField Value
NavajoWhite
Represents a
public static readonly Color NavajoWhiteField Value
Navy
Represents a
public static readonly Color NavyField Value
OldLace
Represents a
public static readonly Color OldLaceField Value
Olive
Represents a
public static readonly Color OliveField Value
OliveDrab
Represents a
public static readonly Color OliveDrabField Value
Orange
Represents a
public static readonly Color OrangeField Value
OrangeRed
Represents a
public static readonly Color OrangeRedField Value
Orchid
Represents a
public static readonly Color OrchidField Value
PaleGoldenrod
Represents a
public static readonly Color PaleGoldenrodField Value
PaleGreen
Represents a
public static readonly Color PaleGreenField Value
PaleTurquoise
Represents a
public static readonly Color PaleTurquoiseField Value
PaleVioletRed
Represents a
public static readonly Color PaleVioletRedField Value
PapayaWhip
Represents a
public static readonly Color PapayaWhipField Value
PeachPuff
Represents a
public static readonly Color PeachPuffField Value
Peru
Represents a
public static readonly Color PeruField Value
Pink
Represents a
public static readonly Color PinkField Value
Plum
Represents a
public static readonly Color PlumField Value
PowderBlue
Represents a
public static readonly Color PowderBlueField Value
Purple
Represents a
public static readonly Color PurpleField Value
RebeccaPurple
Represents a
public static readonly Color RebeccaPurpleField Value
Red
Represents a
public static readonly Color RedField Value
RosyBrown
Represents a
public static readonly Color RosyBrownField Value
RoyalBlue
Represents a
public static readonly Color RoyalBlueField Value
SaddleBrown
Represents a
public static readonly Color SaddleBrownField Value
Salmon
Represents a
public static readonly Color SalmonField Value
SandyBrown
Represents a
public static readonly Color SandyBrownField Value
SeaGreen
Represents a
public static readonly Color SeaGreenField Value
SeaShell
Represents a
public static readonly Color SeaShellField Value
Sienna
Represents a
public static readonly Color SiennaField Value
Silver
Represents a
public static readonly Color SilverField Value
SkyBlue
Represents a
public static readonly Color SkyBlueField Value
SlateBlue
Represents a
public static readonly Color SlateBlueField Value
SlateGray
Represents a
public static readonly Color SlateGrayField Value
SlateGrey
Represents a
public static readonly Color SlateGreyField Value
Snow
Represents a
public static readonly Color SnowField Value
SpringGreen
Represents a
public static readonly Color SpringGreenField Value
SteelBlue
Represents a
public static readonly Color SteelBlueField Value
Tan
Represents a
public static readonly Color TanField Value
Teal
Represents a
public static readonly Color TealField Value
Thistle
Represents a
public static readonly Color ThistleField Value
Tomato
Represents a
public static readonly Color TomatoField Value
Transparent
Represents a
public static readonly Color TransparentField Value
Turquoise
Represents a
public static readonly Color TurquoiseField Value
Violet
Represents a
public static readonly Color VioletField Value
Wheat
Represents a
public static readonly Color WheatField Value
White
Represents a
public static readonly Color WhiteField Value
WhiteSmoke
Represents a
public static readonly Color WhiteSmokeField Value
Yellow
Represents a
public static readonly Color YellowField Value
YellowGreen
Represents a
public static readonly Color YellowGreenField Value
Properties
WebSafePalette
Gets a collection of named, web safe colors as defined in the CSS Color Module Level 4.
public static ReadOnlyMemory<Color> WebSafePalette { get; }Property Value
WernerPalette
Gets a collection of colors as defined in the original second edition of Werner’s Nomenclature of Colours 1821. The hex codes were collected and defined by Nicholas Rougeux https://www.c82.net/werner.
public static ReadOnlyMemory<Color> WernerPalette { get; }Property Value
Methods
Equals(Color)
Indicates whether the current object is equal to another object of the same type.
public bool Equals(Color other)Parameters
otherColorAn object to compare with this object.
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.
FromPixel<TPixel>(ReadOnlySpan<TPixel>, Span<Color>)
Bulk converts a span of a specified TPixel type to a span of Color.
public static void FromPixel<TPixel>(ReadOnlySpan<TPixel> source, Span<Color> destination) where TPixel : unmanaged, IPixel<TPixel>Parameters
sourceReadOnlySpan<TPixel>The source pixel span.
destinationSpan<Color>The destination color span.
Type Parameters
TPixelThe pixel type to convert to.
FromPixel<TPixel>(TPixel)
Creates a Color from the given TPixel.
public static Color FromPixel<TPixel>(TPixel source) where TPixel : unmanaged, IPixel<TPixel>Parameters
sourceTPixelThe pixel to convert from.
Returns
Type Parameters
TPixelThe pixel format.
FromScaledVector(Vector4)
public static Color FromScaledVector(Vector4 source)Parameters
sourceVector4The vector to load the pixel from.
Returns
FromScaledVector(ReadOnlySpan<Vector4>, Span<Color>)
public static void FromScaledVector(ReadOnlySpan<Vector4> source, Span<Color> destination)Parameters
sourceReadOnlySpan<Vector4>The source vector span.
destinationSpan<Color>The destination color span.
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.
Parse(string, ColorHexFormat)
Gets a Color from the given input string.
public static Color Parse(string input, ColorHexFormat format = ColorHexFormat.Rgba)Parameters
inputstringThe name of the color or the hexadecimal representation of the combined color components.
formatColorHexFormatThe format of the hexadecimal string to parse, if applicable. Defaults to Rgba.
Returns
Exceptions
- ArgumentException
Thrown when the
inputis not in the correct format.
ParseHex(string, ColorHexFormat)
Gets a Color from the given hexadecimal string.
public static Color ParseHex(string hex, ColorHexFormat format = ColorHexFormat.Rgba)Parameters
hexstringThe hexadecimal representation of the combined color components.
formatColorHexFormatThe format of the hexadecimal string to parse, if applicable. Defaults to Rgba.
Returns
Exceptions
- ArgumentException
Thrown when the
hexis not in the correct format.
ToHex(ColorHexFormat)
Gets the hexadecimal string representation of the color instance.
public string ToHex(ColorHexFormat format = ColorHexFormat.Rgba)Parameters
formatColorHexFormatThe format of the hexadecimal string to return. Defaults to Rgba.
Returns
- string
A hexadecimal string representation of the value.
Exceptions
- ArgumentOutOfRangeException
Thrown when the
formatis not supported.
ToPixel<TPixel>()
Converts the color instance to a specified TPixel type.
public TPixel ToPixel<TPixel>() where TPixel : unmanaged, IPixel<TPixel>Returns
- TPixel
The
TPixel.
Type Parameters
TPixelThe pixel type to convert to.
ToPixel<TPixel>(ReadOnlySpan<Color>, Span<TPixel>)
Bulk converts a span of Color to a span of a specified TPixel type.
public static void ToPixel<TPixel>(ReadOnlySpan<Color> source, Span<TPixel> destination) where TPixel : unmanaged, IPixel<TPixel>Parameters
sourceReadOnlySpan<Color>The source color span.
destinationSpan<TPixel>The destination pixel span.
Type Parameters
TPixelThe pixel type to convert to.
ToScaledVector4()
Expands the color into a generic ("scaled") Vector4 representation
with values scaled and clamped between
public Vector4 ToScaledVector4()Returns
ToString()
Returns the fully qualified type name of this instance.
public override string ToString()Returns
- string
The fully qualified type name.
TryParse(string, out Color, ColorHexFormat)
Tries to create a new instance of the Color struct from the given input string.
public static bool TryParse(string input, out Color result, ColorHexFormat format = ColorHexFormat.Rgba)Parameters
inputstringThe name of the color or the hexadecimal representation of the combined color components.
resultColorWhen this method returns, contains the Color equivalent of the input string.
formatColorHexFormatThe format of the hexadecimal string to parse, if applicable. Defaults to Rgba.
Returns
TryParseHex(string, out Color, ColorHexFormat)
Gets a Color from the given hexadecimal string.
public static bool TryParseHex(string hex, out Color result, ColorHexFormat format = ColorHexFormat.Rgba)Parameters
hexstringThe hexadecimal representation of the combined color components.
resultColorWhen this method returns, contains the Color equivalent of the hexadecimal input.
formatColorHexFormatThe format of the hexadecimal string to parse, if applicable. Defaults to Rgba.
Returns
WithAlpha(float)
Alters the alpha channel of the color, returning a new instance.
public Color WithAlpha(float alpha)Parameters
alphafloatThe new value of alpha [0..1].
Returns
- Color
The color having it's alpha channel altered.
Operators
operator ==(Color, Color)
Checks whether two Color structures are equal.
public static bool operator ==(Color left, Color right)Parameters
Returns
- bool
True if the
leftparameter is equal to therightparameter; otherwise, false.
operator !=(Color, Color)
Checks whether two Color structures are not equal.
public static bool operator !=(Color left, Color right)Parameters
Returns
- bool
True if the
leftparameter is not equal to therightparameter; otherwise, false.