Win32 API 日本語リファレンス
ホームUI.Shell › ColorRGBToHLS

ColorRGBToHLS

関数
RGB色を色相・輝度・彩度のHLS表現へ変換する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHLWAPI.dll
#include <windows.h>

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

パラメーター

名前方向説明
clrRGBCOLORREFin元の RGB 色。
pwHueWORD*outこのメソッドが正常に返ったとき、HLS の色相値を受け取る値へのポインター。 0 から 240 の範囲を取り得ます。
pwLuminanceWORD*outこのメソッドが正常に返ったとき、HLS の輝度値を受け取る値へのポインター。 0 から 240 の範囲を取り得ます。
pwSaturationWORD*outこのメソッドが正常に返ったとき、HLS の彩度値を受け取る値へのポインター。 0 から 240 の範囲を取り得ます。

戻り値の型: void

公式ドキュメント

色を RGB から色相・輝度・彩度 (HLS) 形式に変換します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// SHLWAPI.dll
#include <windows.h>

void ColorRGBToHLS(
    COLORREF clrRGB,
    WORD* pwHue,
    WORD* pwLuminance,
    WORD* pwSaturation
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern void ColorRGBToHLS(
    uint clrRGB,   // COLORREF
    out ushort pwHue,   // WORD* out
    out ushort pwLuminance,   // WORD* out
    out ushort pwSaturation   // WORD* out
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Sub ColorRGBToHLS(
    clrRGB As UInteger,   ' COLORREF
    <Out> ByRef pwHue As UShort,   ' WORD* out
    <Out> ByRef pwLuminance As UShort,   ' WORD* out
    <Out> ByRef pwSaturation As UShort   ' WORD* out
)
End Sub
' clrRGB : COLORREF
' pwHue : WORD* out
' pwLuminance : WORD* out
' pwSaturation : WORD* out
Declare PtrSafe Sub ColorRGBToHLS Lib "shlwapi" ( _
    ByVal clrRGB As Long, _
    ByRef pwHue As Integer, _
    ByRef pwLuminance As Integer, _
    ByRef pwSaturation As Integer)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ColorRGBToHLS = ctypes.windll.shlwapi.ColorRGBToHLS
ColorRGBToHLS.restype = None
ColorRGBToHLS.argtypes = [
    wintypes.DWORD,  # clrRGB : COLORREF
    ctypes.POINTER(ctypes.c_ushort),  # pwHue : WORD* out
    ctypes.POINTER(ctypes.c_ushort),  # pwLuminance : WORD* out
    ctypes.POINTER(ctypes.c_ushort),  # pwSaturation : WORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
ColorRGBToHLS = Fiddle::Function.new(
  lib['ColorRGBToHLS'],
  [
    -Fiddle::TYPE_INT,  # clrRGB : COLORREF
    Fiddle::TYPE_VOIDP,  # pwHue : WORD* out
    Fiddle::TYPE_VOIDP,  # pwLuminance : WORD* out
    Fiddle::TYPE_VOIDP,  # pwSaturation : WORD* out
  ],
  Fiddle::TYPE_VOID)
#[link(name = "shlwapi")]
extern "system" {
    fn ColorRGBToHLS(
        clrRGB: u32,  // COLORREF
        pwHue: *mut u16,  // WORD* out
        pwLuminance: *mut u16,  // WORD* out
        pwSaturation: *mut u16  // WORD* out
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern void ColorRGBToHLS(uint clrRGB, out ushort pwHue, out ushort pwLuminance, out ushort pwSaturation);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_ColorRGBToHLS' -Namespace Win32 -PassThru
# $api::ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation)
#uselib "SHLWAPI.dll"
#func global ColorRGBToHLS "ColorRGBToHLS" sptr, sptr, sptr, sptr
; ColorRGBToHLS clrRGB, varptr(pwHue), varptr(pwLuminance), varptr(pwSaturation)
; clrRGB : COLORREF -> "sptr"
; pwHue : WORD* out -> "sptr"
; pwLuminance : WORD* out -> "sptr"
; pwSaturation : WORD* out -> "sptr"
出力引数:
#uselib "SHLWAPI.dll"
#func global ColorRGBToHLS "ColorRGBToHLS" int, var, var, var
; ColorRGBToHLS clrRGB, pwHue, pwLuminance, pwSaturation
; clrRGB : COLORREF -> "int"
; pwHue : WORD* out -> "var"
; pwLuminance : WORD* out -> "var"
; pwSaturation : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void ColorRGBToHLS(COLORREF clrRGB, WORD* pwHue, WORD* pwLuminance, WORD* pwSaturation)
#uselib "SHLWAPI.dll"
#func global ColorRGBToHLS "ColorRGBToHLS" int, var, var, var
; ColorRGBToHLS clrRGB, pwHue, pwLuminance, pwSaturation
; clrRGB : COLORREF -> "int"
; pwHue : WORD* out -> "var"
; pwLuminance : WORD* out -> "var"
; pwSaturation : WORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procColorRGBToHLS = shlwapi.NewProc("ColorRGBToHLS")
)

// clrRGB (COLORREF), pwHue (WORD* out), pwLuminance (WORD* out), pwSaturation (WORD* out)
r1, _, err := procColorRGBToHLS.Call(
	uintptr(clrRGB),
	uintptr(pwHue),
	uintptr(pwLuminance),
	uintptr(pwSaturation),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure ColorRGBToHLS(
  clrRGB: DWORD;   // COLORREF
  pwHue: Pointer;   // WORD* out
  pwLuminance: Pointer;   // WORD* out
  pwSaturation: Pointer   // WORD* out
); stdcall;
  external 'SHLWAPI.dll' name 'ColorRGBToHLS';
result := DllCall("SHLWAPI\ColorRGBToHLS"
    , "UInt", clrRGB   ; COLORREF
    , "Ptr", pwHue   ; WORD* out
    , "Ptr", pwLuminance   ; WORD* out
    , "Ptr", pwSaturation   ; WORD* out
    , "Int")   ; return: void
●ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation) = DLL("SHLWAPI.dll", "int ColorRGBToHLS(dword, void*, void*, void*)")
# 呼び出し: ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation)
# clrRGB : COLORREF -> "dword"
# pwHue : WORD* out -> "void*"
# pwLuminance : WORD* out -> "void*"
# pwSaturation : WORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn ColorRGBToHLS(
    clrRGB: u32, // COLORREF
    pwHue: [*c]u16, // WORD* out
    pwLuminance: [*c]u16, // WORD* out
    pwSaturation: [*c]u16 // WORD* out
) callconv(std.os.windows.WINAPI) void;
proc ColorRGBToHLS(
    clrRGB: uint32,  # COLORREF
    pwHue: ptr uint16,  # WORD* out
    pwLuminance: ptr uint16,  # WORD* out
    pwSaturation: ptr uint16  # WORD* out
) {.importc: "ColorRGBToHLS", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
void ColorRGBToHLS(
    uint clrRGB,   // COLORREF
    ushort* pwHue,   // WORD* out
    ushort* pwLuminance,   // WORD* out
    ushort* pwSaturation   // WORD* out
);
ccall((:ColorRGBToHLS, "SHLWAPI.dll"), stdcall, Cvoid,
      (UInt32, Ptr{UInt16}, Ptr{UInt16}, Ptr{UInt16}),
      clrRGB, pwHue, pwLuminance, pwSaturation)
# clrRGB : COLORREF -> UInt32
# pwHue : WORD* out -> Ptr{UInt16}
# pwLuminance : WORD* out -> Ptr{UInt16}
# pwSaturation : WORD* out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void ColorRGBToHLS(
    uint32_t clrRGB,
    uint16_t* pwHue,
    uint16_t* pwLuminance,
    uint16_t* pwSaturation);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation)
-- clrRGB : COLORREF
-- pwHue : WORD* out
-- pwLuminance : WORD* out
-- pwSaturation : WORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const ColorRGBToHLS = lib.func('__stdcall', 'ColorRGBToHLS', 'void', ['uint32_t', 'uint16_t *', 'uint16_t *', 'uint16_t *']);
// ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation)
// clrRGB : COLORREF -> 'uint32_t'
// pwHue : WORD* out -> 'uint16_t *'
// pwLuminance : WORD* out -> 'uint16_t *'
// pwSaturation : WORD* out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  ColorRGBToHLS: { parameters: ["u32", "pointer", "pointer", "pointer"], result: "void" },
});
// lib.symbols.ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation)
// clrRGB : COLORREF -> "u32"
// pwHue : WORD* out -> "pointer"
// pwLuminance : WORD* out -> "pointer"
// pwSaturation : WORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void ColorRGBToHLS(
    uint32_t clrRGB,
    uint16_t* pwHue,
    uint16_t* pwLuminance,
    uint16_t* pwSaturation);
C, "SHLWAPI.dll");
// $ffi->ColorRGBToHLS(clrRGB, pwHue, pwLuminance, pwSaturation);
// clrRGB : COLORREF
// pwHue : WORD* out
// pwLuminance : WORD* out
// pwSaturation : WORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class);
    void ColorRGBToHLS(
        int clrRGB,   // COLORREF
        ShortByReference pwHue,   // WORD* out
        ShortByReference pwLuminance,   // WORD* out
        ShortByReference pwSaturation   // WORD* out
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun ColorRGBToHLS = ColorRGBToHLS(
    clrRGB : UInt32,   # COLORREF
    pwHue : UInt16*,   # WORD* out
    pwLuminance : UInt16*,   # WORD* out
    pwSaturation : UInt16*   # WORD* out
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ColorRGBToHLSNative = Void Function(Uint32, Pointer<Uint16>, Pointer<Uint16>, Pointer<Uint16>);
typedef ColorRGBToHLSDart = void Function(int, Pointer<Uint16>, Pointer<Uint16>, Pointer<Uint16>);
final ColorRGBToHLS = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<ColorRGBToHLSNative, ColorRGBToHLSDart>('ColorRGBToHLS');
// clrRGB : COLORREF -> Uint32
// pwHue : WORD* out -> Pointer<Uint16>
// pwLuminance : WORD* out -> Pointer<Uint16>
// pwSaturation : WORD* out -> Pointer<Uint16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure ColorRGBToHLS(
  clrRGB: DWORD;   // COLORREF
  pwHue: Pointer;   // WORD* out
  pwLuminance: Pointer;   // WORD* out
  pwSaturation: Pointer   // WORD* out
); stdcall;
  external 'SHLWAPI.dll' name 'ColorRGBToHLS';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ColorRGBToHLS"
  c_ColorRGBToHLS :: Word32 -> Ptr Word16 -> Ptr Word16 -> Ptr Word16 -> IO ()
-- clrRGB : COLORREF -> Word32
-- pwHue : WORD* out -> Ptr Word16
-- pwLuminance : WORD* out -> Ptr Word16
-- pwSaturation : WORD* out -> Ptr Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let colorrgbtohls =
  foreign "ColorRGBToHLS"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning void)
(* clrRGB : COLORREF -> uint32_t *)
(* pwHue : WORD* out -> (ptr uint16_t) *)
(* pwLuminance : WORD* out -> (ptr uint16_t) *)
(* pwSaturation : WORD* out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("ColorRGBToHLS" color-rgbto-hls :convention :stdcall) :void
  (clr-rgb :uint32)   ; COLORREF
  (pw-hue :pointer)   ; WORD* out
  (pw-luminance :pointer)   ; WORD* out
  (pw-saturation :pointer))   ; WORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ColorRGBToHLS = Win32::API::More->new('SHLWAPI',
    'void ColorRGBToHLS(DWORD clrRGB, LPVOID pwHue, LPVOID pwLuminance, LPVOID pwSaturation)');
# my $ret = $ColorRGBToHLS->Call($clrRGB, $pwHue, $pwLuminance, $pwSaturation);
# clrRGB : COLORREF -> DWORD
# pwHue : WORD* out -> LPVOID
# pwLuminance : WORD* out -> LPVOID
# pwSaturation : WORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。