Edit

Share via

ColorRGBToHLS function (shlwapi.h)

  • Article

Converts colors from RGB to hue-luminance-saturation (HLS) format.

Syntax

void ColorRGBToHLS(
        COLORREF clrRGB,
  [out] WORD     *pwHue,
  [out] WORD     *pwLuminance,
  [out] WORD     *pwSaturation
);

Parameters

clrRGB

Type: COLORREF

The original RGB color.

[out] pwHue

Type: WORD*

A pointer to a value that, when this method returns successfully, receives the HLS hue value. Can range from 0 to 240.

[out] pwLuminance

Type: WORD*

A pointer to a value that, when this method returns successfully, receives the HLS luminance value. Can range from 0 to 240.

[out] pwSaturation

Type: WORD*

A pointer to a value that, when this method returns successfully, receives the HLS saturation value. Can range from 0 to 240.

Return value

None

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlwapi.h
Library Shlwapi.lib
DLL Shlwapi.dll (version 5.0 or later)