BeginBufferedPaint

関数

オフスクリーンバッファへの描画を開始しバッファDCを取得する。

DLLUXTHEME.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT_PTR BeginBufferedPaint(
    HDC hdcTarget,
    const RECT* prcTarget,
    BP_BUFFERFORMAT dwFormat,
    BP_PAINTPARAMS* pPaintParams,   // optional
    HDC* phdc
);

パラメーター

名前	型	方向	説明
hdcTarget	HDC	in	バッファの描画先となるターゲット DC のハンドル。
prcTarget	RECT*	in	描画を行うターゲット DC 内の領域を指定する RECT 構造体へのポインター。
dwFormat	BP_BUFFERFORMAT	in	バッファの形式を指定する BP_BUFFERFORMAT 列挙体のメンバー。
pPaintParams	BP_PAINTPARAMS*	inoptional	描画操作のパラメーターを定義する BP_PAINTPARAMS 構造体へのポインター。この値は NULL にできます。
phdc	HDC*	out	この関数が返るときに、新しいデバイスコンテキストのハンドルを指します。

戻り値の型: INT_PTR

公式ドキュメント

バッファリングされた描画操作を開始します。

戻り値

型: HPAINTBUFFER

バッファリングされた描画コンテキストへのハンドル。この関数が失敗した場合、戻り値は NULL となり、phdc も NULL になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

返されたハンドルは、EndBufferedPaint が呼び出されると解放されます。

アプリケーションは、BeginBufferedPaint を呼び出す前に呼び出し元スレッドで BufferedPaintInit を呼び出し、スレッドが終了する前に BufferedPaintUnInit を呼び出す必要があります。BufferedPaintInit を呼び出さないと、バッファリングされた描画操作ごとに内部データが初期化および破棄されるため、パフォーマンスが低下する可能性があります。

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

各言語での呼び出し定義

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

INT_PTR BeginBufferedPaint(
    HDC hdcTarget,
    const RECT* prcTarget,
    BP_BUFFERFORMAT dwFormat,
    BP_PAINTPARAMS* pPaintParams,   // optional
    HDC* phdc
);

[DllImport("UXTHEME.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr BeginBufferedPaint(
    IntPtr hdcTarget,   // HDC
    IntPtr prcTarget,   // RECT*
    int dwFormat,   // BP_BUFFERFORMAT
    IntPtr pPaintParams,   // BP_PAINTPARAMS* optional
    IntPtr phdc   // HDC* out
);

<DllImport("UXTHEME.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BeginBufferedPaint(
    hdcTarget As IntPtr,   ' HDC
    prcTarget As IntPtr,   ' RECT*
    dwFormat As Integer,   ' BP_BUFFERFORMAT
    pPaintParams As IntPtr,   ' BP_PAINTPARAMS* optional
    phdc As IntPtr   ' HDC* out
) As IntPtr
End Function

' hdcTarget : HDC
' prcTarget : RECT*
' dwFormat : BP_BUFFERFORMAT
' pPaintParams : BP_PAINTPARAMS* optional
' phdc : HDC* out
Declare PtrSafe Function BeginBufferedPaint Lib "uxtheme" ( _
    ByVal hdcTarget As LongPtr, _
    ByVal prcTarget As LongPtr, _
    ByVal dwFormat As Long, _
    ByVal pPaintParams As LongPtr, _
    ByVal phdc As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BeginBufferedPaint = ctypes.windll.uxtheme.BeginBufferedPaint
BeginBufferedPaint.restype = ctypes.c_ssize_t
BeginBufferedPaint.argtypes = [
    wintypes.HANDLE,  # hdcTarget : HDC
    ctypes.c_void_p,  # prcTarget : RECT*
    ctypes.c_int,  # dwFormat : BP_BUFFERFORMAT
    ctypes.c_void_p,  # pPaintParams : BP_PAINTPARAMS* optional
    ctypes.c_void_p,  # phdc : HDC* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
BeginBufferedPaint = Fiddle::Function.new(
  lib['BeginBufferedPaint'],
  [
    Fiddle::TYPE_VOIDP,  # hdcTarget : HDC
    Fiddle::TYPE_VOIDP,  # prcTarget : RECT*
    Fiddle::TYPE_INT,  # dwFormat : BP_BUFFERFORMAT
    Fiddle::TYPE_VOIDP,  # pPaintParams : BP_PAINTPARAMS* optional
    Fiddle::TYPE_VOIDP,  # phdc : HDC* out
  ],
  Fiddle::TYPE_INTPTR_T)

#[link(name = "uxtheme")]
extern "system" {
    fn BeginBufferedPaint(
        hdcTarget: *mut core::ffi::c_void,  // HDC
        prcTarget: *const RECT,  // RECT*
        dwFormat: i32,  // BP_BUFFERFORMAT
        pPaintParams: *mut BP_PAINTPARAMS,  // BP_PAINTPARAMS* optional
        phdc: *mut *mut core::ffi::c_void  // HDC* out
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("UXTHEME.dll", SetLastError = true)]
public static extern IntPtr BeginBufferedPaint(IntPtr hdcTarget, IntPtr prcTarget, int dwFormat, IntPtr pPaintParams, IntPtr phdc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_BeginBufferedPaint' -Namespace Win32 -PassThru
# $api::BeginBufferedPaint(hdcTarget, prcTarget, dwFormat, pPaintParams, phdc)

#uselib "UXTHEME.dll"
#func global BeginBufferedPaint "BeginBufferedPaint" sptr, sptr, sptr, sptr, sptr
; BeginBufferedPaint hdcTarget, varptr(prcTarget), dwFormat, varptr(pPaintParams), phdc   ; 戻り値は stat
; hdcTarget : HDC -> "sptr"
; prcTarget : RECT* -> "sptr"
; dwFormat : BP_BUFFERFORMAT -> "sptr"
; pPaintParams : BP_PAINTPARAMS* optional -> "sptr"
; phdc : HDC* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "UXTHEME.dll"
#cfunc global BeginBufferedPaint "BeginBufferedPaint" sptr, var, int, var, sptr
; res = BeginBufferedPaint(hdcTarget, prcTarget, dwFormat, pPaintParams, phdc)
; hdcTarget : HDC -> "sptr"
; prcTarget : RECT* -> "var"
; dwFormat : BP_BUFFERFORMAT -> "int"
; pPaintParams : BP_PAINTPARAMS* optional -> "var"
; phdc : HDC* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "UXTHEME.dll"
#cfunc global BeginBufferedPaint "BeginBufferedPaint" sptr, sptr, int, sptr, sptr
; res = BeginBufferedPaint(hdcTarget, varptr(prcTarget), dwFormat, varptr(pPaintParams), phdc)
; hdcTarget : HDC -> "sptr"
; prcTarget : RECT* -> "sptr"
; dwFormat : BP_BUFFERFORMAT -> "int"
; pPaintParams : BP_PAINTPARAMS* optional -> "sptr"
; phdc : HDC* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。