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

SetLayeredWindowAttributes

関数
レイヤードウィンドウの不透明度や色キーを設定する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetLayeredWindowAttributes(
    HWND hwnd,
    COLORREF crKey,
    BYTE bAlpha,
    LAYERED_WINDOW_ATTRIBUTES_FLAGS dwFlags
);

パラメーター

名前方向説明
hwndHWNDin

レイヤードウィンドウへのハンドルです。レイヤードウィンドウは、CreateWindowEx 関数でウィンドウを作成する際に WS_EX_LAYERED を指定するか、ウィンドウ作成後に SetWindowLong によって WS_EX_LAYERED を設定することで作成されます。

Windows 8: WS_EX_LAYERED スタイルはトップレベルウィンドウと子ウィンドウでサポートされます。これより前の Windows バージョンでは、WS_EX_LAYERED はトップレベルウィンドウでのみサポートされます。

crKeyCOLORREFinレイヤードウィンドウを合成する際に使用する透明色キーを指定する COLORREF 構造体です。ウィンドウがこの色で描画したすべてのピクセルは透明になります。COLORREF を生成するには、RGB マクロを使用します。
bAlphaBYTEinレイヤードウィンドウの不透明度を表すために使用されるアルファ値です。BLENDFUNCTION 構造体の SourceConstantAlpha メンバーと同様です。bAlpha が 0 の場合、ウィンドウは完全に透明になります。bAlpha が 255 の場合、ウィンドウは不透明になります。
dwFlagsLAYERED_WINDOW_ATTRIBUTES_FLAGSin

実行するアクションです。このパラメーターには、次の値を 1 つ以上指定できます。

意味
LWA_ALPHA
0x00000002
bAlpha を使用してレイヤードウィンドウの不透明度を決定します。
LWA_COLORKEY
0x00000001
crKey を透明色として使用します。

戻り値の型: BOOL

公式ドキュメント

レイヤードウィンドウの不透明度と透明色キーを設定します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

レイヤードウィンドウに対して SetLayeredWindowAttributes が一度呼び出されると、レイヤリングスタイルビットがいったんクリアされて再度設定されるまで、以降の UpdateLayeredWindow の呼び出しは失敗することに注意してください。

詳細については、レイヤードウィンドウの使用を参照してください。

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

各言語での呼び出し定義

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

BOOL SetLayeredWindowAttributes(
    HWND hwnd,
    COLORREF crKey,
    BYTE bAlpha,
    LAYERED_WINDOW_ATTRIBUTES_FLAGS dwFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetLayeredWindowAttributes(
    IntPtr hwnd,   // HWND
    uint crKey,   // COLORREF
    byte bAlpha,   // BYTE
    uint dwFlags   // LAYERED_WINDOW_ATTRIBUTES_FLAGS
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetLayeredWindowAttributes(
    hwnd As IntPtr,   ' HWND
    crKey As UInteger,   ' COLORREF
    bAlpha As Byte,   ' BYTE
    dwFlags As UInteger   ' LAYERED_WINDOW_ATTRIBUTES_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hwnd : HWND
' crKey : COLORREF
' bAlpha : BYTE
' dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS
Declare PtrSafe Function SetLayeredWindowAttributes Lib "user32" ( _
    ByVal hwnd As LongPtr, _
    ByVal crKey As Long, _
    ByVal bAlpha As Byte, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetLayeredWindowAttributes = ctypes.windll.user32.SetLayeredWindowAttributes
SetLayeredWindowAttributes.restype = wintypes.BOOL
SetLayeredWindowAttributes.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.DWORD,  # crKey : COLORREF
    ctypes.c_ubyte,  # bAlpha : BYTE
    wintypes.DWORD,  # dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetLayeredWindowAttributes = Fiddle::Function.new(
  lib['SetLayeredWindowAttributes'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    -Fiddle::TYPE_INT,  # crKey : COLORREF
    -Fiddle::TYPE_CHAR,  # bAlpha : BYTE
    -Fiddle::TYPE_INT,  # dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetLayeredWindowAttributes(
        hwnd: *mut core::ffi::c_void,  // HWND
        crKey: u32,  // COLORREF
        bAlpha: u8,  // BYTE
        dwFlags: u32  // LAYERED_WINDOW_ATTRIBUTES_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool SetLayeredWindowAttributes(IntPtr hwnd, uint crKey, byte bAlpha, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetLayeredWindowAttributes' -Namespace Win32 -PassThru
# $api::SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
#uselib "USER32.dll"
#func global SetLayeredWindowAttributes "SetLayeredWindowAttributes" sptr, sptr, sptr, sptr
; SetLayeredWindowAttributes hwnd, crKey, bAlpha, dwFlags   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; crKey : COLORREF -> "sptr"
; bAlpha : BYTE -> "sptr"
; dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetLayeredWindowAttributes "SetLayeredWindowAttributes" sptr, int, int, int
; res = SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
; hwnd : HWND -> "sptr"
; crKey : COLORREF -> "int"
; bAlpha : BYTE -> "int"
; dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> "int"
; BOOL SetLayeredWindowAttributes(HWND hwnd, COLORREF crKey, BYTE bAlpha, LAYERED_WINDOW_ATTRIBUTES_FLAGS dwFlags)
#uselib "USER32.dll"
#cfunc global SetLayeredWindowAttributes "SetLayeredWindowAttributes" intptr, int, int, int
; res = SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
; hwnd : HWND -> "intptr"
; crKey : COLORREF -> "int"
; bAlpha : BYTE -> "int"
; dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetLayeredWindowAttributes = user32.NewProc("SetLayeredWindowAttributes")
)

// hwnd (HWND), crKey (COLORREF), bAlpha (BYTE), dwFlags (LAYERED_WINDOW_ATTRIBUTES_FLAGS)
r1, _, err := procSetLayeredWindowAttributes.Call(
	uintptr(hwnd),
	uintptr(crKey),
	uintptr(bAlpha),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetLayeredWindowAttributes(
  hwnd: THandle;   // HWND
  crKey: DWORD;   // COLORREF
  bAlpha: Byte;   // BYTE
  dwFlags: DWORD   // LAYERED_WINDOW_ATTRIBUTES_FLAGS
): BOOL; stdcall;
  external 'USER32.dll' name 'SetLayeredWindowAttributes';
result := DllCall("USER32\SetLayeredWindowAttributes"
    , "Ptr", hwnd   ; HWND
    , "UInt", crKey   ; COLORREF
    , "UChar", bAlpha   ; BYTE
    , "UInt", dwFlags   ; LAYERED_WINDOW_ATTRIBUTES_FLAGS
    , "Int")   ; return: BOOL
●SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags) = DLL("USER32.dll", "bool SetLayeredWindowAttributes(void*, dword, byte, dword)")
# 呼び出し: SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
# hwnd : HWND -> "void*"
# crKey : COLORREF -> "dword"
# bAlpha : BYTE -> "byte"
# dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn SetLayeredWindowAttributes(
    hwnd: ?*anyopaque, // HWND
    crKey: u32, // COLORREF
    bAlpha: u8, // BYTE
    dwFlags: u32 // LAYERED_WINDOW_ATTRIBUTES_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc SetLayeredWindowAttributes(
    hwnd: pointer,  # HWND
    crKey: uint32,  # COLORREF
    bAlpha: uint8,  # BYTE
    dwFlags: uint32  # LAYERED_WINDOW_ATTRIBUTES_FLAGS
): int32 {.importc: "SetLayeredWindowAttributes", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int SetLayeredWindowAttributes(
    void* hwnd,   // HWND
    uint crKey,   // COLORREF
    ubyte bAlpha,   // BYTE
    uint dwFlags   // LAYERED_WINDOW_ATTRIBUTES_FLAGS
);
ccall((:SetLayeredWindowAttributes, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt8, UInt32),
      hwnd, crKey, bAlpha, dwFlags)
# hwnd : HWND -> Ptr{Cvoid}
# crKey : COLORREF -> UInt32
# bAlpha : BYTE -> UInt8
# dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetLayeredWindowAttributes(
    void* hwnd,
    uint32_t crKey,
    uint8_t bAlpha,
    uint32_t dwFlags);
]]
local user32 = ffi.load("user32")
-- user32.SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
-- hwnd : HWND
-- crKey : COLORREF
-- bAlpha : BYTE
-- dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetLayeredWindowAttributes = lib.func('__stdcall', 'SetLayeredWindowAttributes', 'int32_t', ['void *', 'uint32_t', 'uint8_t', 'uint32_t']);
// SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
// hwnd : HWND -> 'void *'
// crKey : COLORREF -> 'uint32_t'
// bAlpha : BYTE -> 'uint8_t'
// dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetLayeredWindowAttributes: { parameters: ["pointer", "u32", "u8", "u32"], result: "i32" },
});
// lib.symbols.SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags)
// hwnd : HWND -> "pointer"
// crKey : COLORREF -> "u32"
// bAlpha : BYTE -> "u8"
// dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetLayeredWindowAttributes(
    void* hwnd,
    uint32_t crKey,
    uint8_t bAlpha,
    uint32_t dwFlags);
C, "USER32.dll");
// $ffi->SetLayeredWindowAttributes(hwnd, crKey, bAlpha, dwFlags);
// hwnd : HWND
// crKey : COLORREF
// bAlpha : BYTE
// dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS
// 構造体/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 User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    boolean SetLayeredWindowAttributes(
        Pointer hwnd,   // HWND
        int crKey,   // COLORREF
        byte bAlpha,   // BYTE
        int dwFlags   // LAYERED_WINDOW_ATTRIBUTES_FLAGS
    );
}
@[Link("user32")]
lib LibUSER32
  fun SetLayeredWindowAttributes = SetLayeredWindowAttributes(
    hwnd : Void*,   # HWND
    crKey : UInt32,   # COLORREF
    bAlpha : UInt8,   # BYTE
    dwFlags : UInt32   # LAYERED_WINDOW_ATTRIBUTES_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetLayeredWindowAttributesNative = Int32 Function(Pointer<Void>, Uint32, Uint8, Uint32);
typedef SetLayeredWindowAttributesDart = int Function(Pointer<Void>, int, int, int);
final SetLayeredWindowAttributes = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetLayeredWindowAttributesNative, SetLayeredWindowAttributesDart>('SetLayeredWindowAttributes');
// hwnd : HWND -> Pointer<Void>
// crKey : COLORREF -> Uint32
// bAlpha : BYTE -> Uint8
// dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetLayeredWindowAttributes(
  hwnd: THandle;   // HWND
  crKey: DWORD;   // COLORREF
  bAlpha: Byte;   // BYTE
  dwFlags: DWORD   // LAYERED_WINDOW_ATTRIBUTES_FLAGS
): BOOL; stdcall;
  external 'USER32.dll' name 'SetLayeredWindowAttributes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetLayeredWindowAttributes"
  c_SetLayeredWindowAttributes :: Ptr () -> Word32 -> Word8 -> Word32 -> IO CInt
-- hwnd : HWND -> Ptr ()
-- crKey : COLORREF -> Word32
-- bAlpha : BYTE -> Word8
-- dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setlayeredwindowattributes =
  foreign "SetLayeredWindowAttributes"
    ((ptr void) @-> uint32_t @-> uint8_t @-> uint32_t @-> returning int32_t)
(* hwnd : HWND -> (ptr void) *)
(* crKey : COLORREF -> uint32_t *)
(* bAlpha : BYTE -> uint8_t *)
(* dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetLayeredWindowAttributes" set-layered-window-attributes :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND
  (cr-key :uint32)   ; COLORREF
  (b-alpha :uint8)   ; BYTE
  (dw-flags :uint32))   ; LAYERED_WINDOW_ATTRIBUTES_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetLayeredWindowAttributes = Win32::API::More->new('USER32',
    'BOOL SetLayeredWindowAttributes(HANDLE hwnd, DWORD crKey, BYTE bAlpha, DWORD dwFlags)');
# my $ret = $SetLayeredWindowAttributes->Call($hwnd, $crKey, $bAlpha, $dwFlags);
# hwnd : HWND -> HANDLE
# crKey : COLORREF -> DWORD
# bAlpha : BYTE -> BYTE
# dwFlags : LAYERED_WINDOW_ATTRIBUTES_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型