ホーム › Graphics.Dwm › DwmEnableBlurBehindWindow

DwmEnableBlurBehindWindow

関数

ウィンドウ背後のぼかし効果を有効化または設定する。

DLLdwmapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT DwmEnableBlurBehindWindow(
    HWND hWnd,
    const DWM_BLURBEHIND* pBlurBehind
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	blur-behind データを適用するウィンドウのハンドル。
pBlurBehind	DWM_BLURBEHIND*	in	blur-behind データを提供する DWM_BLURBEHIND 構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定したウィンドウでぼかし効果を有効にします。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

メモ

Windows 8 以降では、ウィンドウの描画方法に関するスタイルの変更により、この関数を呼び出してもぼかし効果は適用されません。

ぼかしを有効にするには、DWM_BLURBEHIND 構造体の fEnable メンバーを TRUE に設定します。これにより、以降のウィンドウの合成では、その背後にあるコンテンツがぼかされます。効果を速やかに適用するため、この関数は BeginPaint の呼び出しの直前に呼び出してください。

ウィンドウ内のアルファ値は尊重され、ぼかしの上に行われる描画ではこれらのアルファ値が使用されます。ウィンドウ内のすべてのピクセルのアルファ値が正しいことを保証するのは、アプリケーションの責任です。一部の Windows Graphics Device Interface (GDI) の操作はアルファ値を保持しないため、子ウィンドウを表示する際は注意してください。子ウィンドウが与えるアルファ値は予測できません。

DWM_BLURBEHIND 構造体で指定したリージョンは、呼び出し元が所有します。リージョンを解放するのは呼び出し元の責任であり、関数の呼び出しが完了した時点で解放できます。

この関数はトップレベルウィンドウに対してのみ呼び出すことができます。それ以外の種類のウィンドウに対して呼び出すとエラーが発生します。

この関数は、デスクトップウィンドウマネージャー (DWM) による合成が切り替わるたびに呼び出す必要があります。合成の変更通知を受け取るには、WM_DWMCOMPOSITIONCHANGED メッセージを処理してください。

例

次の例は、ウィンドウ全体にぼかしを適用する方法を示しています。

HRESULT EnableBlurBehind(HWND hwnd)
{
   HRESULT hr = S_OK;

   // Blur Behind 構造体を作成して値を設定する
   DWM_BLURBEHIND bb = {0};

   // Blur Behind を有効にし、クライアント領域全体に適用する
   bb.dwFlags = DWM_BB_ENABLE;
   bb.fEnable = true;
   bb.hRgnBlur = NULL;

   // Blur Behind を適用する
   hr = DwmEnableBlurBehindWindow(hwnd, &bb);
   if (SUCCEEDED(hr))
   {
      // ...
   }
   return hr;
}

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

各言語での呼び出し定義

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

HRESULT DwmEnableBlurBehindWindow(
    HWND hWnd,
    const DWM_BLURBEHIND* pBlurBehind
);

[DllImport("dwmapi.dll", ExactSpelling = true)]
static extern int DwmEnableBlurBehindWindow(
    IntPtr hWnd,   // HWND
    IntPtr pBlurBehind   // DWM_BLURBEHIND*
);

<DllImport("dwmapi.dll", ExactSpelling:=True)>
Public Shared Function DwmEnableBlurBehindWindow(
    hWnd As IntPtr,   ' HWND
    pBlurBehind As IntPtr   ' DWM_BLURBEHIND*
) As Integer
End Function

' hWnd : HWND
' pBlurBehind : DWM_BLURBEHIND*
Declare PtrSafe Function DwmEnableBlurBehindWindow Lib "dwmapi" ( _
    ByVal hWnd As LongPtr, _
    ByVal pBlurBehind As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DwmEnableBlurBehindWindow = ctypes.windll.dwmapi.DwmEnableBlurBehindWindow
DwmEnableBlurBehindWindow.restype = ctypes.c_int
DwmEnableBlurBehindWindow.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # pBlurBehind : DWM_BLURBEHIND*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dwmapi.dll')
DwmEnableBlurBehindWindow = Fiddle::Function.new(
  lib['DwmEnableBlurBehindWindow'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # pBlurBehind : DWM_BLURBEHIND*
  ],
  Fiddle::TYPE_INT)

#[link(name = "dwmapi")]
extern "system" {
    fn DwmEnableBlurBehindWindow(
        hWnd: *mut core::ffi::c_void,  // HWND
        pBlurBehind: *const DWM_BLURBEHIND  // DWM_BLURBEHIND*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dwmapi.dll")]
public static extern int DwmEnableBlurBehindWindow(IntPtr hWnd, IntPtr pBlurBehind);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dwmapi_DwmEnableBlurBehindWindow' -Namespace Win32 -PassThru
# $api::DwmEnableBlurBehindWindow(hWnd, pBlurBehind)

#uselib "dwmapi.dll"
#func global DwmEnableBlurBehindWindow "DwmEnableBlurBehindWindow" sptr, sptr
; DwmEnableBlurBehindWindow hWnd, varptr(pBlurBehind)   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; pBlurBehind : DWM_BLURBEHIND* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dwmapi.dll"
#cfunc global DwmEnableBlurBehindWindow "DwmEnableBlurBehindWindow" sptr, var
; res = DwmEnableBlurBehindWindow(hWnd, pBlurBehind)
; hWnd : HWND -> "sptr"
; pBlurBehind : DWM_BLURBEHIND* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dwmapi.dll"
#cfunc global DwmEnableBlurBehindWindow "DwmEnableBlurBehindWindow" sptr, sptr
; res = DwmEnableBlurBehindWindow(hWnd, varptr(pBlurBehind))
; hWnd : HWND -> "sptr"
; pBlurBehind : DWM_BLURBEHIND* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。