ColorExtensionsGetBrightnessF(Color32, WorkingColorSpace) Method

Gets the brightness of a Color32 instance as a float value based on human perception. The A component of the specified value is ignored.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0

C#

public static float GetBrightnessF(
	this Color32 c,
	WorkingColorSpace colorSpace
)

VB

<ExtensionAttribute>
Public Shared Function GetBrightnessF ( 
	c As Color32,
	colorSpace As WorkingColorSpace
) As Single

C++

public:
[ExtensionAttribute]
static float GetBrightnessF(
	Color32 c, 
	WorkingColorSpace colorSpace
)

F#

[<ExtensionAttribute>]
static member GetBrightnessF : 
        c : Color32 * 
        colorSpace : WorkingColorSpace -> float32

Parameters

c Color32: The Color32 instance to get the brightness of.
colorSpace WorkingColorSpace: The color space to be used for determining the brightness. If Default, then the sRGB color space will be used. For performance reasons this method does not validate this parameter. For undefined values the sRGB color space will be used as well.

Return Value

Single
A float value where 0 represents the darkest and 1 represents the brightest possible value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Color32. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Note

This method always returns a gamma corrected result, even if colorSpace is Linear. To get the brightness in the linear color space use the GetBrightness(ColorF, WorkingColorSpace) method instead.