EngBitBlt

関数

サーフェス間でビットブロック転送を行う。

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

シグネチャ

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

BOOL EngBitBlt(
    SURFOBJ* psoTrg,
    SURFOBJ* psoSrc,
    SURFOBJ* psoMask,
    CLIPOBJ* pco,
    XLATEOBJ* pxlo,
    RECTL* prclTrg,
    POINTL* pptlSrc,
    POINTL* pptlMask,
    BRUSHOBJ* pbo,
    POINTL* pptlBrush,
    DWORD rop4
);

パラメーター

名前	型	方向	説明
psoTrg	SURFOBJ*	in	描画先のサーフェスを識別する SURFOBJ 構造体へのポインターです。
psoSrc	SURFOBJ*	in	rop4 が必要とする場合、ビットブロック転送操作の転送元を定義する SURFOBJ 構造体へのポインターです。
psoMask	SURFOBJ*	in	マスクとして使用するサーフェスを定義する SURFOBJ 構造体へのポインターです。マスクは 1 ピクセルあたり 1 ビットのビットマップとして定義されます。通常、マスクは描画先サーフェスで変更される領域を制限します。マスクは値 0xAACC の rop4 によって選択されます。マスクが 0 の場合、描画先サーフェスは影響を受けません。マスクは描画先の矩形を覆うのに十分な大きさを持ちます。このパラメーターの値が NULL で、rop4 がマスクを必要とする場合は、ブラシ内の暗黙のマスクが使用されます。マスクが必要な場合、psoMask はブラシ内の暗黙のマスクをオーバーライドします。
pco	CLIPOBJ*	in	CLIPOBJ 構造体へのポインターです。CLIPOBJ_Xxx サービスルーチンは、クリップ領域を矩形の集合として列挙するために用意されています。この列挙によって、変更される描画先の領域が制限されます。可能な限り、GDI は関与するクリッピングを単純化します。たとえば、この関数が単一のクリッピング矩形で呼び出されることはありません。GDI はこの関数を呼び出す前に描画先の矩形をクリップするため、追加のクリッピングは不要です。
pxlo	XLATEOBJ*	in	転送元サーフェスと転送先サーフェスの間でカラーインデックスをどのように変換すべきかを示す XLATEOBJ 構造体へのポインターです。
prclTrg	RECTL*	in	変更する領域を定義する、描画先サーフェスの座標系における RECTL 構造体へのポインターです。矩形は左上と右下の 2 点で定義されます。この矩形の下端および右端はビットブロック転送に含まれません。つまり矩形は右下が排他的です。 EngBitBlt が空の描画先矩形で呼び出されることはありません。矩形を定義する 2 点は常に正しく順序付けられています。
pptlSrc	POINTL*	in	転送元が存在する場合に、転送元矩形の左上隅を定義する POINTL 構造体へのポインターです。転送元がない場合、ドライバーはこのパラメーターを無視してください。
pptlMask	POINTL*	in	描画先矩形の左上隅に対応するマスク内のピクセルを定義する POINTL 構造体へのポインターです。psoMask でマスクが指定されていない場合、ドライバーはこのパラメーターを無視してください。
pbo	BRUSHOBJ*	in	ビットブロック転送のパターンを定義するために使用する BRUSHOBJ 構造体へのポインターです。GDI の BRUSHOBJ_pvGetRbrush サービスルーチンは、デバイスにおけるブラシの実体を取得します。rop4 パラメーターがパターンを必要としない場合、ドライバーはこのパラメーターを無視できます。
pptlBrush	POINTL*	in	描画先サーフェスにおけるブラシの原点を定義する POINTL 構造体へのポインターです。ブラシの左上ピクセルがこの点に揃えられ、ブラシはその寸法に従って繰り返されます。rop4 パラメーターがパターンを必要としない場合、このパラメーターは無視してください。
rop4	DWORD	in	マスク、パターン、転送元、転送先のピクセルをどのように組み合わせて描画先サーフェスへ出力ピクセルを書き込むかを定義するラスター操作を表します。これは 4 項ラスター操作であり、通常の 3 項 Rop3 操作を自然に拡張したものです。Rop4 には関連する 16 ビットがあり、これは Rop3 を定義する 8 ビットに相当します(Rop3 のその他の冗長なビットは無視されます)。Rop4 を実装する最も簡単な方法は、その 2 バイトを別々に扱うことです。下位バイトは、マスクが 1 である箇所で計算すべき Rop3 を指定します。上位バイトは、マスクが 0 である箇所で計算および適用できる Rop3 を指定します。

戻り値の型: BOOL

公式ドキュメント

EngBitBlt 関数は、デバイス管理サーフェス間、またはデバイス管理サーフェスと GDI 管理の標準フォーマットビットマップとの間で、汎用的なビットブロック転送機能を提供します。

戻り値

関数が成功した場合、戻り値は TRUE です。それ以外の場合は FALSE となり、エラーコードがログに記録されます。

解説(Remarks)

デバイスのサーフェスが標準フォーマットのビットマップとして構成されている場合、ドライバーは EngBitBlt を呼び出すことで GDI にビットブロック転送を実行するよう要求できます。ドライバーがこれを行うのは、単純な転送を高速に処理する専用ハードウェアを備えているが、複雑な転送を伴う呼び出しは自分で処理したくない場合などです。

ラスター操作の詳細については、Microsoft Windows SDK のドキュメントを参照してください。

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

各言語での呼び出し定義

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

BOOL EngBitBlt(
    SURFOBJ* psoTrg,
    SURFOBJ* psoSrc,
    SURFOBJ* psoMask,
    CLIPOBJ* pco,
    XLATEOBJ* pxlo,
    RECTL* prclTrg,
    POINTL* pptlSrc,
    POINTL* pptlMask,
    BRUSHOBJ* pbo,
    POINTL* pptlBrush,
    DWORD rop4
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngBitBlt(
    IntPtr psoTrg,   // SURFOBJ*
    IntPtr psoSrc,   // SURFOBJ*
    IntPtr psoMask,   // SURFOBJ*
    IntPtr pco,   // CLIPOBJ*
    IntPtr pxlo,   // XLATEOBJ*
    IntPtr prclTrg,   // RECTL*
    IntPtr pptlSrc,   // POINTL*
    IntPtr pptlMask,   // POINTL*
    IntPtr pbo,   // BRUSHOBJ*
    IntPtr pptlBrush,   // POINTL*
    uint rop4   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngBitBlt(
    psoTrg As IntPtr,   ' SURFOBJ*
    psoSrc As IntPtr,   ' SURFOBJ*
    psoMask As IntPtr,   ' SURFOBJ*
    pco As IntPtr,   ' CLIPOBJ*
    pxlo As IntPtr,   ' XLATEOBJ*
    prclTrg As IntPtr,   ' RECTL*
    pptlSrc As IntPtr,   ' POINTL*
    pptlMask As IntPtr,   ' POINTL*
    pbo As IntPtr,   ' BRUSHOBJ*
    pptlBrush As IntPtr,   ' POINTL*
    rop4 As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' psoTrg : SURFOBJ*
' psoSrc : SURFOBJ*
' psoMask : SURFOBJ*
' pco : CLIPOBJ*
' pxlo : XLATEOBJ*
' prclTrg : RECTL*
' pptlSrc : POINTL*
' pptlMask : POINTL*
' pbo : BRUSHOBJ*
' pptlBrush : POINTL*
' rop4 : DWORD
Declare PtrSafe Function EngBitBlt Lib "gdi32" ( _
    ByVal psoTrg As LongPtr, _
    ByVal psoSrc As LongPtr, _
    ByVal psoMask As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal pxlo As LongPtr, _
    ByVal prclTrg As LongPtr, _
    ByVal pptlSrc As LongPtr, _
    ByVal pptlMask As LongPtr, _
    ByVal pbo As LongPtr, _
    ByVal pptlBrush As LongPtr, _
    ByVal rop4 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EngBitBlt = ctypes.windll.gdi32.EngBitBlt
EngBitBlt.restype = wintypes.BOOL
EngBitBlt.argtypes = [
    ctypes.c_void_p,  # psoTrg : SURFOBJ*
    ctypes.c_void_p,  # psoSrc : SURFOBJ*
    ctypes.c_void_p,  # psoMask : SURFOBJ*
    ctypes.c_void_p,  # pco : CLIPOBJ*
    ctypes.c_void_p,  # pxlo : XLATEOBJ*
    ctypes.c_void_p,  # prclTrg : RECTL*
    ctypes.c_void_p,  # pptlSrc : POINTL*
    ctypes.c_void_p,  # pptlMask : POINTL*
    ctypes.c_void_p,  # pbo : BRUSHOBJ*
    ctypes.c_void_p,  # pptlBrush : POINTL*
    wintypes.DWORD,  # rop4 : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngBitBlt = Fiddle::Function.new(
  lib['EngBitBlt'],
  [
    Fiddle::TYPE_VOIDP,  # psoTrg : SURFOBJ*
    Fiddle::TYPE_VOIDP,  # psoSrc : SURFOBJ*
    Fiddle::TYPE_VOIDP,  # psoMask : SURFOBJ*
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ*
    Fiddle::TYPE_VOIDP,  # pxlo : XLATEOBJ*
    Fiddle::TYPE_VOIDP,  # prclTrg : RECTL*
    Fiddle::TYPE_VOIDP,  # pptlSrc : POINTL*
    Fiddle::TYPE_VOIDP,  # pptlMask : POINTL*
    Fiddle::TYPE_VOIDP,  # pbo : BRUSHOBJ*
    Fiddle::TYPE_VOIDP,  # pptlBrush : POINTL*
    -Fiddle::TYPE_INT,  # rop4 : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngBitBlt(
        psoTrg: *mut SURFOBJ,  // SURFOBJ*
        psoSrc: *mut SURFOBJ,  // SURFOBJ*
        psoMask: *mut SURFOBJ,  // SURFOBJ*
        pco: *mut CLIPOBJ,  // CLIPOBJ*
        pxlo: *mut XLATEOBJ,  // XLATEOBJ*
        prclTrg: *mut RECTL,  // RECTL*
        pptlSrc: *mut POINTL,  // POINTL*
        pptlMask: *mut POINTL,  // POINTL*
        pbo: *mut BRUSHOBJ,  // BRUSHOBJ*
        pptlBrush: *mut POINTL,  // POINTL*
        rop4: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool EngBitBlt(IntPtr psoTrg, IntPtr psoSrc, IntPtr psoMask, IntPtr pco, IntPtr pxlo, IntPtr prclTrg, IntPtr pptlSrc, IntPtr pptlMask, IntPtr pbo, IntPtr pptlBrush, uint rop4);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngBitBlt' -Namespace Win32 -PassThru
# $api::EngBitBlt(psoTrg, psoSrc, psoMask, pco, pxlo, prclTrg, pptlSrc, pptlMask, pbo, pptlBrush, rop4)

#uselib "GDI32.dll"
#func global EngBitBlt "EngBitBlt" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EngBitBlt varptr(psoTrg), varptr(psoSrc), varptr(psoMask), varptr(pco), varptr(pxlo), varptr(prclTrg), varptr(pptlSrc), varptr(pptlMask), varptr(pbo), varptr(pptlBrush), rop4   ; 戻り値は stat
; psoTrg : SURFOBJ* -> "sptr"
; psoSrc : SURFOBJ* -> "sptr"
; psoMask : SURFOBJ* -> "sptr"
; pco : CLIPOBJ* -> "sptr"
; pxlo : XLATEOBJ* -> "sptr"
; prclTrg : RECTL* -> "sptr"
; pptlSrc : POINTL* -> "sptr"
; pptlMask : POINTL* -> "sptr"
; pbo : BRUSHOBJ* -> "sptr"
; pptlBrush : POINTL* -> "sptr"
; rop4 : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global EngBitBlt "EngBitBlt" var, var, var, var, var, var, var, var, var, var, int
; res = EngBitBlt(psoTrg, psoSrc, psoMask, pco, pxlo, prclTrg, pptlSrc, pptlMask, pbo, pptlBrush, rop4)
; psoTrg : SURFOBJ* -> "var"
; psoSrc : SURFOBJ* -> "var"
; psoMask : SURFOBJ* -> "var"
; pco : CLIPOBJ* -> "var"
; pxlo : XLATEOBJ* -> "var"
; prclTrg : RECTL* -> "var"
; pptlSrc : POINTL* -> "var"
; pptlMask : POINTL* -> "var"
; pbo : BRUSHOBJ* -> "var"
; pptlBrush : POINTL* -> "var"
; rop4 : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global EngBitBlt "EngBitBlt" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, int
; res = EngBitBlt(varptr(psoTrg), varptr(psoSrc), varptr(psoMask), varptr(pco), varptr(pxlo), varptr(prclTrg), varptr(pptlSrc), varptr(pptlMask), varptr(pbo), varptr(pptlBrush), rop4)
; psoTrg : SURFOBJ* -> "sptr"
; psoSrc : SURFOBJ* -> "sptr"
; psoMask : SURFOBJ* -> "sptr"
; pco : CLIPOBJ* -> "sptr"
; pxlo : XLATEOBJ* -> "sptr"
; prclTrg : RECTL* -> "sptr"
; pptlSrc : POINTL* -> "sptr"
; pptlMask : POINTL* -> "sptr"
; pbo : BRUSHOBJ* -> "sptr"
; pptlBrush : POINTL* -> "sptr"
; rop4 : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。