PlgBlt

関数

平行四辺形領域へビットマップを転送する。

DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL PlgBlt(
    HDC hdcDest,
    const POINT* lpPoint,
    HDC hdcSrc,
    INT xSrc,
    INT ySrc,
    INT width,
    INT height,
    HBITMAP hbmMask,   // optional
    INT xMask,
    INT yMask
);

パラメーター

名前	型	方向	説明
hdcDest	HDC	in	転送先デバイスコンテキストへのハンドル。
lpPoint	POINT*	in	論理空間内の 3 つのポイントの配列へのポインターで、転送先平行四辺形の 3 つの隅を指定します。転送元四角形の左上隅はこの配列の最初のポイントに、右上隅は 2 番目のポイントに、左下隅は 3 番目のポイントにマッピングされます。転送元四角形の右下隅は、平行四辺形の暗黙的な 4 番目のポイントにマッピングされます。
hdcSrc	HDC	in	転送元デバイスコンテキストへのハンドル。
xSrc	INT	in	転送元四角形の左上隅の x 座標(論理単位)。
ySrc	INT	in	転送元四角形の左上隅の y 座標(論理単位)。
width	INT	in	転送元四角形の幅(論理単位)。
height	INT	in	転送元四角形の高さ(論理単位)。
hbmMask	HBITMAP	inoptional	転送元四角形の色をマスクするために使用される、省略可能なモノクロビットマップへのハンドル。
xMask	INT	in	モノクロビットマップの左上隅の x 座標(論理単位)。
yMask	INT	in	モノクロビットマップの左上隅の y 座標(論理単位)。

戻り値の型: BOOL

公式ドキュメント

PlgBlt 関数は、転送元デバイスコンテキスト内の指定された四角形から、転送先デバイスコンテキスト内の指定された平行四辺形へ、色データのビットをビットブロック転送します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

PlgBlt 関数はデバイス依存ビットマップを扱います。

平行四辺形の 4 番目の頂点 (D) は、最初の 3 つのポイント (A、B、C) をベクトルとして扱い、D = B + CA を計算することで定義されます。

ビットマスクが存在する場合、マスク内の値 1 は、転送元ピクセルの色を転送先にコピーすることを示します。マスク内の値 0 は、転送先ピクセルの色を変更しないことを示します。マスク四角形が転送元および転送先の四角形より小さい場合、関数はマスクパターンを反復します。

転送元デバイスコンテキストでは、拡大縮小、平行移動、反転の変換が許可されますが、回転およびせん断の変換は許可されません。マスクビットマップがモノクロビットマップでない場合、エラーが発生します。転送先デバイスコンテキストの拡大縮小モードは、必要に応じてピクセルをどのように拡大または圧縮するかを決定するために使用されます。

拡張メタファイルの記録中に、転送元デバイスコンテキストが拡張メタファイルデバイスコンテキストを識別する場合、エラーが発生します。

転送先座標は転送先デバイスコンテキストに従って変換され、転送元座標は転送元デバイスコンテキストに従って変換されます。転送元の変換に回転またはせん断が含まれる場合、エラーが返されます。

転送先と転送元の四角形が同じ色形式でない場合、PlgBlt は転送元四角形を転送先四角形に一致するように変換します。

すべてのデバイスが PlgBlt 関数をサポートしているわけではありません。詳細については、GetDeviceCaps 関数の RC_BITBLT ラスター機能の説明を参照してください。

転送元と転送先のデバイスコンテキストが互換性のないデバイスを表している場合、PlgBlt はエラーを返します。

マルチモニターシステムで使用する場合、hdcSrc と hdcDest の両方が同じデバイスを参照している必要があり、そうでない場合は関数が失敗します。異なるデバイスの DC 間でデータを転送するには、GetDIBits を呼び出してメモリビットマップを DIB に変換します。DIB を 2 番目のデバイスに表示するには、SetDIBits または StretchDIBits を呼び出します。

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

各言語での呼び出し定義

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

BOOL PlgBlt(
    HDC hdcDest,
    const POINT* lpPoint,
    HDC hdcSrc,
    INT xSrc,
    INT ySrc,
    INT width,
    INT height,
    HBITMAP hbmMask,   // optional
    INT xMask,
    INT yMask
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool PlgBlt(
    IntPtr hdcDest,   // HDC
    IntPtr lpPoint,   // POINT*
    IntPtr hdcSrc,   // HDC
    int xSrc,   // INT
    int ySrc,   // INT
    int width,   // INT
    int height,   // INT
    IntPtr hbmMask,   // HBITMAP optional
    int xMask,   // INT
    int yMask   // INT
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function PlgBlt(
    hdcDest As IntPtr,   ' HDC
    lpPoint As IntPtr,   ' POINT*
    hdcSrc As IntPtr,   ' HDC
    xSrc As Integer,   ' INT
    ySrc As Integer,   ' INT
    width As Integer,   ' INT
    height As Integer,   ' INT
    hbmMask As IntPtr,   ' HBITMAP optional
    xMask As Integer,   ' INT
    yMask As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdcDest : HDC
' lpPoint : POINT*
' hdcSrc : HDC
' xSrc : INT
' ySrc : INT
' width : INT
' height : INT
' hbmMask : HBITMAP optional
' xMask : INT
' yMask : INT
Declare PtrSafe Function PlgBlt Lib "gdi32" ( _
    ByVal hdcDest As LongPtr, _
    ByVal lpPoint As LongPtr, _
    ByVal hdcSrc As LongPtr, _
    ByVal xSrc As Long, _
    ByVal ySrc As Long, _
    ByVal width As Long, _
    ByVal height As Long, _
    ByVal hbmMask As LongPtr, _
    ByVal xMask As Long, _
    ByVal yMask As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PlgBlt = ctypes.windll.gdi32.PlgBlt
PlgBlt.restype = wintypes.BOOL
PlgBlt.argtypes = [
    wintypes.HANDLE,  # hdcDest : HDC
    ctypes.c_void_p,  # lpPoint : POINT*
    wintypes.HANDLE,  # hdcSrc : HDC
    ctypes.c_int,  # xSrc : INT
    ctypes.c_int,  # ySrc : INT
    ctypes.c_int,  # width : INT
    ctypes.c_int,  # height : INT
    wintypes.HANDLE,  # hbmMask : HBITMAP optional
    ctypes.c_int,  # xMask : INT
    ctypes.c_int,  # yMask : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PlgBlt = Fiddle::Function.new(
  lib['PlgBlt'],
  [
    Fiddle::TYPE_VOIDP,  # hdcDest : HDC
    Fiddle::TYPE_VOIDP,  # lpPoint : POINT*
    Fiddle::TYPE_VOIDP,  # hdcSrc : HDC
    Fiddle::TYPE_INT,  # xSrc : INT
    Fiddle::TYPE_INT,  # ySrc : INT
    Fiddle::TYPE_INT,  # width : INT
    Fiddle::TYPE_INT,  # height : INT
    Fiddle::TYPE_VOIDP,  # hbmMask : HBITMAP optional
    Fiddle::TYPE_INT,  # xMask : INT
    Fiddle::TYPE_INT,  # yMask : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn PlgBlt(
        hdcDest: *mut core::ffi::c_void,  // HDC
        lpPoint: *const POINT,  // POINT*
        hdcSrc: *mut core::ffi::c_void,  // HDC
        xSrc: i32,  // INT
        ySrc: i32,  // INT
        width: i32,  // INT
        height: i32,  // INT
        hbmMask: *mut core::ffi::c_void,  // HBITMAP optional
        xMask: i32,  // INT
        yMask: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool PlgBlt(IntPtr hdcDest, IntPtr lpPoint, IntPtr hdcSrc, int xSrc, int ySrc, int width, int height, IntPtr hbmMask, int xMask, int yMask);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PlgBlt' -Namespace Win32 -PassThru
# $api::PlgBlt(hdcDest, lpPoint, hdcSrc, xSrc, ySrc, width, height, hbmMask, xMask, yMask)

#uselib "GDI32.dll"
#func global PlgBlt "PlgBlt" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; PlgBlt hdcDest, varptr(lpPoint), hdcSrc, xSrc, ySrc, width, height, hbmMask, xMask, yMask   ; 戻り値は stat
; hdcDest : HDC -> "sptr"
; lpPoint : POINT* -> "sptr"
; hdcSrc : HDC -> "sptr"
; xSrc : INT -> "sptr"
; ySrc : INT -> "sptr"
; width : INT -> "sptr"
; height : INT -> "sptr"
; hbmMask : HBITMAP optional -> "sptr"
; xMask : INT -> "sptr"
; yMask : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global PlgBlt "PlgBlt" sptr, var, sptr, int, int, int, int, sptr, int, int
; res = PlgBlt(hdcDest, lpPoint, hdcSrc, xSrc, ySrc, width, height, hbmMask, xMask, yMask)
; hdcDest : HDC -> "sptr"
; lpPoint : POINT* -> "var"
; hdcSrc : HDC -> "sptr"
; xSrc : INT -> "int"
; ySrc : INT -> "int"
; width : INT -> "int"
; height : INT -> "int"
; hbmMask : HBITMAP optional -> "sptr"
; xMask : INT -> "int"
; yMask : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global PlgBlt "PlgBlt" sptr, sptr, sptr, int, int, int, int, sptr, int, int
; res = PlgBlt(hdcDest, varptr(lpPoint), hdcSrc, xSrc, ySrc, width, height, hbmMask, xMask, yMask)
; hdcDest : HDC -> "sptr"
; lpPoint : POINT* -> "sptr"
; hdcSrc : HDC -> "sptr"
; xSrc : INT -> "int"
; ySrc : INT -> "int"
; width : INT -> "int"
; height : INT -> "int"
; hbmMask : HBITMAP optional -> "sptr"
; xMask : INT -> "int"
; yMask : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。