ColorExtensionsGetBrightness(Color64, WorkingColorSpace) Method

Gets the brightness of a Color64 instance as a UInt16 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: 9.1.1

C#

[CLSCompliantAttribute(false)]
public static ushort GetBrightness(
	this Color64 c,
	WorkingColorSpace colorSpace
)

VB

<ExtensionAttribute>
<CLSCompliantAttribute(false)>
Public Shared Function GetBrightness ( 
	c As Color64,
	colorSpace As WorkingColorSpace
) As UShort

C++

public:
[ExtensionAttribute]
[CLSCompliantAttribute(false)]
static unsigned short GetBrightness(
	Color64 c, 
	WorkingColorSpace colorSpace
)

F#

[<ExtensionAttribute>]
[<CLSCompliantAttribute(false)>]
static member GetBrightness : 
        c : Color64 * 
        colorSpace : WorkingColorSpace -> uint16

Parameters

c Color64: The Color64 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

UInt16
A UInt16 value where 0 represents the darkest and 65535 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 Color64. 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.