Click or drag to resize
Ab4d.SharpEngine logo

Color4 Methods

The Color4 type exposes the following members.

Methods
 NameDescription
Public methodStatic memberAdd(Color4, Color4) Adds two colors.
Public methodStatic memberAdd(Color4, Color4, Color4)Obsolete.
Adds two colors.
Public methodStatic memberAdjustContrast(Color4, Single) Adjusts the contrast of a color.
Public methodStatic memberAdjustContrast(Color4, Single, Color4)Obsolete.
Adjusts the contrast of a color.
Public methodStatic memberAdjustSaturation(Color4, Single) Adjusts the saturation of a color.
Public methodStatic memberAdjustSaturation(Color4, Single, Color4)Obsolete.
Adjusts the saturation of a color.
Public methodStatic memberClamp(Color4, Color4, Color4) Restricts a value to be within a specified range.
Public methodStatic memberClamp(Color4, Color4, Color4, Color4)Obsolete.
Restricts a value to be within a specified range.
Public methodDeconstruct Deconstruct Color4 into tuple with red, green, blue and alpha values.
Public methodEquals(Color4) Determines whether the specified Color4 is equal to this instance.
Public methodEquals(Color4) Determines whether the specified Color4 is equal to this instance.
Public methodEquals(Object) Determines whether the specified Object is equal to this instance.
(Overrides ValueTypeEquals(Object))
Public methodStatic memberFromByteRgba Gets Color4 from red, green, blue and alpha values defined as bytes (each value in range from 0 to 255)
Public methodStatic memberFromHsl(Double, Double, Double, Double) Gets Color4 from HSL (hue, saturation, lightness)
Public methodStatic memberFromHsl(Single, Single, Single, Single) Gets Color4 from HSL (hue, saturation, lightness)
Public methodStatic memberFromHsv(Double, Double, Double, Double) Gets Color4 from HSV (hue, saturation, value / brightness)
Public methodStatic memberFromHsv(Single, Single, Single, Single) Gets Color4 from HSV (hue, saturation, value / brightness)
Public methodGetHashCode Returns a hash code for this instance.
(Overrides ValueTypeGetHashCode)
Public methodIsSame Returns true if byte values (each color is in range from 0 to 255) of this color are the same as byte values of the other colors.
Public methodStatic memberLerp(Color4, Color4, Single) Performs a linear interpolation between two colors.
Public methodStatic memberLerp(Color4, Color4, Single, Color4)Obsolete.
Performs a linear interpolation between two colors.
Public methodStatic memberMax(Color4, Color4) Returns a color containing the largest components of the specified colors.
Public methodStatic memberMax(Color4, Color4, Color4)Obsolete.
Returns a color containing the smallest components of the specified colors.
Public methodStatic memberMin(Color4, Color4) Returns a color containing the smallest components of the specified colors.
Public methodStatic memberMin(Color4, Color4, Color4)Obsolete.
Returns a color containing the smallest components of the specified colors.
Public methodStatic memberModulate(Color4, Color4) Modulates two colors.
Public methodStatic memberModulate(Color4, Color4, Color4)Obsolete.
Modulates two colors.
Public methodStatic memberNegate(Color4) Negates a color.
Public methodStatic memberNegate(Color4, Color4)Obsolete.
Negates a color.
Public methodStatic memberParse Parse method returns the color that was parsed from the color text. If the text cannot be parsed a FormatException is thrown (use TryParse(String, Color4) if you do not want to get an exception). When the color text starts with hash character (#), then the color is specified as a hex value in format RRGGBBAA, RGBA, RRGGBB or RGB (for example #FF0000FF for red color). Otherwise the color text should be one of the color names from the known colors defined in the Colors class. The name can be in any case.
Public methodPremultiply Converts the color values to alpha premultiplied values.
Public methodStatic memberPremultiply(Color4) Computes the premultiplied value of the provided color.
Public methodStatic memberPremultiply(Color4, Color4)Obsolete.
Computes the premultiplied value of the provided color.
Public methodSaturate Update the color values to be between 0 and 1.
Public methodStatic memberSaturate(Color4)Obsolete.
Restricts color values to be between 0 and 1.
Public methodSaturateAndPremultiply Update the color values to be between 0 and 1 and premultiplies the values by alpha value.
Public methodStatic memberScale(Color4, Single) Scales a color.
Public methodStatic memberScale(Color4, Single, Color4)Obsolete.
Scales a color.
Public methodSetAlpha Sets the alpha value of this Color4.
Public methodStatic memberSmoothStep(Color4, Color4, Single) Performs a cubic interpolation between two colors.
Public methodStatic memberSmoothStep(Color4, Color4, Single, Color4)Obsolete.
Performs a cubic interpolation between two colors.
Public methodStatic memberSubtract(Color4, Color4) Subtracts two colors.
Public methodStatic memberSubtract(Color4, Color4, Color4)Obsolete.
Subtracts two colors.
Public methodToArgb Converts the color into a packed integer.
Public methodToArray Creates an array containing the elements of the color.
Public methodToBgra Converts the color into a packed integer.
Public methodToHexString Returns a string that represents a hex value of this color in format: RRGGBBAA, for example red color is "FF0000FF"
Public methodToKnownColorString If the color is one of the colors in the known Colors class, then the name of the color is returned. Otherwise a hex string with a hash ('#') prefix is returned.
Public methodToRgba Converts the color into a packed integer.
Public methodToString Returns a String that represents this instance.
(Overrides ValueTypeToString)
Public methodToString(IFormatProvider) Returns a String that represents this instance.
Public methodToString(String) Returns a String that represents this instance.
Public methodToString(String, IFormatProvider) Returns a String that represents this instance.
Public methodToVector3 Converts the color into a three component vector.
Public methodToVector4 Converts the color into a four component vector.
Public methodStatic memberTryParse TryParse method tries to parse the color text and set the color out parameter. When the color text starts with hash character (#), then the color is specified as a hex value in format RRGGBBAA, RGBA, RRGGBB or RGB (for example #FF0000FF for red color). Otherwise the color text should be one of the color names from the known colors defined in the Colors class. The name can be in any case. When the color be parse, the color is set to the color out parameter and the method returns true. Otherwise color is set to Black color and the methods returns false.
Top
Extension Methods
 NameDescription
Public Extension MethodSaturate Ensures that the color components are within 0 and 1 - if smaller than 0 than the value is set to 0; if bigger than 1 the value is set to 1. This is the same as saturate function in HLSL.
(Defined by Extensions)
Public Extension MethodSaturate Ensures that the color components are within 0 and 1 - if smaller than 0 than the value is set to 0; if bigger than 1 the value is set to 1. This is the same as saturate function in HLSL.
(Defined by Extensions)
Public Extension MethodSaturate Ensures that the color components are within 0 and 1 - if smaller than 0 than the value is set to 0; if bigger than 1 the value is set to 1. This is the same as saturate function in HLSL.
(Defined by Extensions)
Public Extension MethodToAvaloniaColor Converts SharpEngine's Color4 to Avalonia color
(Defined by Extensions)
Public Extension MethodToColor3 Converts Color4 to Color3
(Defined by Extensions)
Public Extension MethodToWinUIColor Converts SharpEngine's Color4 to WinUI color
(Defined by Extensions)
Public Extension MethodToWpfColor Converts SharpEngine's Color4 to WPF color
(Defined by Extensions)
Top
See Also