Struct Color
- Namespace
- Discord
- Assembly
- Discord.Net.Core.dll
Represents a color used in Discord.
public struct Color- Inherited Members
Constructors
Color(byte, byte, byte)
Initializes a Color struct with the given RGB bytes.
public Color(byte r, byte g, byte b)Parameters
rbyteThe byte that represents the red color.
gbyteThe byte that represents the green color.
bbyteThe byte that represents the blue color.
Examples
The following will create a color that has a value of #607D8B.
Color darkGrey = new Color((byte)0b_01100000, (byte)0b_01111101, (byte)0b_10001011);Exceptions
- ArgumentException
Value exceeds MaxDecimalValue.
Color(int, int, int)
Initializes a Color struct with the given RGB value.
public Color(int r, int g, int b)Parameters
rintThe value that represents the red color. Must be within 0~255.
gintThe value that represents the green color. Must be within 0~255.
bintThe value that represents the blue color. Must be within 0~255.
Examples
The following will create a color that has a value of #607D8B.
Color darkGrey = new Color(96, 125, 139);Exceptions
- ArgumentOutOfRangeException
The argument value is not between 0 to 255.
Color(float, float, float)
Initializes a Color struct with the given RGB float value.
public Color(float r, float g, float b)Parameters
rfloatThe value that represents the red color. Must be within 0~1.
gfloatThe value that represents the green color. Must be within 0~1.
bfloatThe value that represents the blue color. Must be within 0~1.
Examples
The following will create a color that has a value of #607c8c.
Color darkGrey = new Color(0.38f, 0.49f, 0.55f);Exceptions
- ArgumentOutOfRangeException
The argument value is not between 0 to 1.
Color(uint)
Initializes a Color struct with the given raw value.
public Color(uint rawValue)Parameters
rawValueuintThe raw value of the color (e.g.
0x607D8B).
Examples
The following will create a color that has a hex value of #607D8B.
Color darkGrey = new Color(0x607D8B);Exceptions
- ArgumentException
Value exceeds MaxDecimalValue.
Fields
Blue
Gets the blue color value.
public static readonly Color BlueField Value
DarkBlue
Gets the dark blue color value.
public static readonly Color DarkBlueField Value
DarkGreen
Gets the dark green color value.
public static readonly Color DarkGreenField Value
DarkGrey
Gets the dark grey color value.
public static readonly Color DarkGreyField Value
DarkMagenta
Gets the dark magenta color value.
public static readonly Color DarkMagentaField Value
DarkOrange
Gets the dark orange color value.
public static readonly Color DarkOrangeField Value
DarkPurple
Gets the dark purple color value.
public static readonly Color DarkPurpleField Value
DarkRed
Gets the dark red color value.
public static readonly Color DarkRedField Value
DarkTeal
Gets the dark teal color value.
public static readonly Color DarkTealField Value
DarkerGrey
Gets the darker grey color value.
public static readonly Color DarkerGreyField Value
Default
Gets the default user color value.
public static readonly Color DefaultField Value
Gold
Gets the gold color value.
public static readonly Color GoldField Value
Green
Gets the green color value.
public static readonly Color GreenField Value
LightGrey
Gets the light grey color value.
public static readonly Color LightGreyField Value
LightOrange
Gets the light orange color value.
public static readonly Color LightOrangeField Value
LighterGrey
Gets the lighter grey color value.
public static readonly Color LighterGreyField Value
Magenta
Gets the magenta color value.
public static readonly Color MagentaField Value
MaxDecimalValue
Gets the max decimal value of color.
public const uint MaxDecimalValue = 16777215Field Value
Orange
Gets the orange color value.
public static readonly Color OrangeField Value
Purple
Gets the purple color value.
public static readonly Color PurpleField Value
Red
Gets the red color value.
public static readonly Color RedField Value
Teal
Gets the teal color value.
public static readonly Color TealField Value
Properties
B
Gets the blue component for this color.
public byte B { get; }Property Value
G
Gets the green component for this color.
public byte G { get; }Property Value
R
Gets the red component for this color.
public byte R { get; }Property Value
RawValue
Gets the encoded value for this color.
public readonly uint RawValue { get; }Property Value
Remarks
This value is encoded as an unsigned integer value. The most-significant 8 bits contain the red value, the middle 8 bits contain the green value, and the least-significant 8 bits contain the blue value.
Methods
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.
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.
ToString()
Gets the hexadecimal representation of the color (e.g. #000ccc).
public override string ToString()Returns
- string
A hexadecimal string of the color.
Operators
operator ==(Color, Color)
public static bool operator ==(Color lhs, Color rhs)Parameters
Returns
explicit operator Color(Color)
public static explicit operator Color(Color color)Parameters
colorColor
Returns
implicit operator Color(Color)
public static implicit operator Color(Color color)Parameters
colorColor
Returns
implicit operator uint(Color)
public static implicit operator uint(Color color)Parameters
colorColor
Returns
implicit operator Color(uint)
public static implicit operator Color(uint rawValue)Parameters
rawValueuint
Returns
operator !=(Color, Color)
public static bool operator !=(Color lhs, Color rhs)