ホーム › Devices.Display › EngTransparentBlt

EngTransparentBlt

関数

指定色を透過させてサーフェスを転送する。

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

シグネチャ

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

BOOL EngTransparentBlt(
    SURFOBJ* psoDst,
    SURFOBJ* psoSrc,
    CLIPOBJ* pco,   // optional
    XLATEOBJ* pxlo,   // optional
    RECTL* prclDst,
    RECTL* prclSrc,
    DWORD TransColor,
    DWORD bCalledFromBitBlt
);

パラメーター

名前	型	方向	説明
psoDst	SURFOBJ*	in	描画先の対象サーフェスを識別する SURFOBJ 構造体へのポインターです。
psoSrc	SURFOBJ*	in	ビットブロック転送の転送元サーフェスを識別する SURFOBJ 構造体へのポインターです。
pco	CLIPOBJ*	inoptional	CLIPOBJ 構造体へのポインターです。CLIPOBJ_Xxx サービスルーチンは、クリップ領域を矩形の集合として列挙するために提供されています。この列挙により、変更される描画先の領域が制限されます。可能な場合は常に、GDI がクリッピング処理を簡略化します。
pxlo	XLATEOBJ*	inoptional	転送元のカラーインデックスを対象サーフェスへ書き込むためにどのように変換すべきかを示す XLATEOBJ 構造体へのポインターです。
prclDst	RECTL*	in	変更対象となる矩形領域を定義する RECTL 構造体へのポインターです。この矩形は描画先サーフェスの座標系で指定され、左上と右下の 2 点で定義されます。矩形は右下を含みません。つまり、下端と右端はビットブロック転送の対象に含まれません。矩形を定義する 2 点は常に正しく順序付けられています。ドライバーは、空の描画先矩形を指定して EngTransparentBlt を呼び出してはなりません。
prclSrc	RECTL*	in	コピー対象となる矩形領域を定義する RECTL 構造体へのポインターです。この矩形は転送元サーフェスの座標系で指定され、左上と右下の 2 点で定義されます。矩形を定義する 2 点は常に正しく順序付けられています。転送元矩形が転送元サーフェスの範囲を超えることはなく、したがって転送元サーフェスからはみ出すこともありません。この矩形は、prclDst で定義される描画先矩形にマッピングされます。ドライバーは、空の転送元矩形を指定して EngTransparentBlt を呼び出してはなりません。
TransColor	DWORD	in	転送元サーフェスの形式での物理的な透過色を指定します。これは転送元サーフェスのパレットに変換されたカラーインデックス値です。詳細については Remarks セクションを参照してください。
bCalledFromBitBlt	DWORD	in	予約済みです。このパラメーターはゼロに設定する必要があります。

戻り値の型: BOOL

公式ドキュメント

EngTransparentBlt 関数は、透過機能を備えたビットブロック転送 (bit-block transfer) を提供します。

戻り値

EngTransparentBlt は成功すると TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

ドライバーは、DrvTransparentBlt をフックしており、サポートしていない処理を要求された場合に EngTransparentBlt を呼び出す必要があります。

透過を伴うビットブロック転送は、2 つのデバイス管理サーフェス間、またはデバイス管理サーフェスと GDI 管理の標準形式ビットマップとの間でサポートされます。現在、GDI は BMF_4BPP および BMF_8BPP の転送元サーフェスのみをサポートしています。

転送元サーフェス上で、iTransparentColor によって指定された透過色に一致するピクセルはコピーされません。透過 blt の詳細な説明については、Copying Bitmaps を参照してください。

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

各言語での呼び出し定義

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

BOOL EngTransparentBlt(
    SURFOBJ* psoDst,
    SURFOBJ* psoSrc,
    CLIPOBJ* pco,   // optional
    XLATEOBJ* pxlo,   // optional
    RECTL* prclDst,
    RECTL* prclSrc,
    DWORD TransColor,
    DWORD bCalledFromBitBlt
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngTransparentBlt(
    IntPtr psoDst,   // SURFOBJ*
    IntPtr psoSrc,   // SURFOBJ*
    IntPtr pco,   // CLIPOBJ* optional
    IntPtr pxlo,   // XLATEOBJ* optional
    IntPtr prclDst,   // RECTL*
    IntPtr prclSrc,   // RECTL*
    uint TransColor,   // DWORD
    uint bCalledFromBitBlt   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngTransparentBlt(
    psoDst As IntPtr,   ' SURFOBJ*
    psoSrc As IntPtr,   ' SURFOBJ*
    pco As IntPtr,   ' CLIPOBJ* optional
    pxlo As IntPtr,   ' XLATEOBJ* optional
    prclDst As IntPtr,   ' RECTL*
    prclSrc As IntPtr,   ' RECTL*
    TransColor As UInteger,   ' DWORD
    bCalledFromBitBlt As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' psoDst : SURFOBJ*
' psoSrc : SURFOBJ*
' pco : CLIPOBJ* optional
' pxlo : XLATEOBJ* optional
' prclDst : RECTL*
' prclSrc : RECTL*
' TransColor : DWORD
' bCalledFromBitBlt : DWORD
Declare PtrSafe Function EngTransparentBlt Lib "gdi32" ( _
    ByVal psoDst As LongPtr, _
    ByVal psoSrc As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal pxlo As LongPtr, _
    ByVal prclDst As LongPtr, _
    ByVal prclSrc As LongPtr, _
    ByVal TransColor As Long, _
    ByVal bCalledFromBitBlt As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EngTransparentBlt = ctypes.windll.gdi32.EngTransparentBlt
EngTransparentBlt.restype = wintypes.BOOL
EngTransparentBlt.argtypes = [
    ctypes.c_void_p,  # psoDst : SURFOBJ*
    ctypes.c_void_p,  # psoSrc : SURFOBJ*
    ctypes.c_void_p,  # pco : CLIPOBJ* optional
    ctypes.c_void_p,  # pxlo : XLATEOBJ* optional
    ctypes.c_void_p,  # prclDst : RECTL*
    ctypes.c_void_p,  # prclSrc : RECTL*
    wintypes.DWORD,  # TransColor : DWORD
    wintypes.DWORD,  # bCalledFromBitBlt : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngTransparentBlt = Fiddle::Function.new(
  lib['EngTransparentBlt'],
  [
    Fiddle::TYPE_VOIDP,  # psoDst : SURFOBJ*
    Fiddle::TYPE_VOIDP,  # psoSrc : SURFOBJ*
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ* optional
    Fiddle::TYPE_VOIDP,  # pxlo : XLATEOBJ* optional
    Fiddle::TYPE_VOIDP,  # prclDst : RECTL*
    Fiddle::TYPE_VOIDP,  # prclSrc : RECTL*
    -Fiddle::TYPE_INT,  # TransColor : DWORD
    -Fiddle::TYPE_INT,  # bCalledFromBitBlt : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngTransparentBlt(
        psoDst: *mut SURFOBJ,  // SURFOBJ*
        psoSrc: *mut SURFOBJ,  // SURFOBJ*
        pco: *mut CLIPOBJ,  // CLIPOBJ* optional
        pxlo: *mut XLATEOBJ,  // XLATEOBJ* optional
        prclDst: *mut RECTL,  // RECTL*
        prclSrc: *mut RECTL,  // RECTL*
        TransColor: u32,  // DWORD
        bCalledFromBitBlt: 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 EngTransparentBlt(IntPtr psoDst, IntPtr psoSrc, IntPtr pco, IntPtr pxlo, IntPtr prclDst, IntPtr prclSrc, uint TransColor, uint bCalledFromBitBlt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngTransparentBlt' -Namespace Win32 -PassThru
# $api::EngTransparentBlt(psoDst, psoSrc, pco, pxlo, prclDst, prclSrc, TransColor, bCalledFromBitBlt)

#uselib "GDI32.dll"
#func global EngTransparentBlt "EngTransparentBlt" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EngTransparentBlt varptr(psoDst), varptr(psoSrc), varptr(pco), varptr(pxlo), varptr(prclDst), varptr(prclSrc), TransColor, bCalledFromBitBlt   ; 戻り値は stat
; psoDst : SURFOBJ* -> "sptr"
; psoSrc : SURFOBJ* -> "sptr"
; pco : CLIPOBJ* optional -> "sptr"
; pxlo : XLATEOBJ* optional -> "sptr"
; prclDst : RECTL* -> "sptr"
; prclSrc : RECTL* -> "sptr"
; TransColor : DWORD -> "sptr"
; bCalledFromBitBlt : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global EngTransparentBlt "EngTransparentBlt" var, var, var, var, var, var, int, int
; res = EngTransparentBlt(psoDst, psoSrc, pco, pxlo, prclDst, prclSrc, TransColor, bCalledFromBitBlt)
; psoDst : SURFOBJ* -> "var"
; psoSrc : SURFOBJ* -> "var"
; pco : CLIPOBJ* optional -> "var"
; pxlo : XLATEOBJ* optional -> "var"
; prclDst : RECTL* -> "var"
; prclSrc : RECTL* -> "var"
; TransColor : DWORD -> "int"
; bCalledFromBitBlt : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global EngTransparentBlt "EngTransparentBlt" sptr, sptr, sptr, sptr, sptr, sptr, int, int
; res = EngTransparentBlt(varptr(psoDst), varptr(psoSrc), varptr(pco), varptr(pxlo), varptr(prclDst), varptr(prclSrc), TransColor, bCalledFromBitBlt)
; psoDst : SURFOBJ* -> "sptr"
; psoSrc : SURFOBJ* -> "sptr"
; pco : CLIPOBJ* optional -> "sptr"
; pxlo : XLATEOBJ* optional -> "sptr"
; prclDst : RECTL* -> "sptr"
; prclSrc : RECTL* -> "sptr"
; TransColor : DWORD -> "int"
; bCalledFromBitBlt : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。