EngCopyBits

関数

サーフェス間でビットをコピーする。

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

シグネチャ

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

BOOL EngCopyBits(
    SURFOBJ* psoDest,
    SURFOBJ* psoSrc,
    CLIPOBJ* pco,
    XLATEOBJ* pxlo,
    RECTL* prclDest,
    POINTL* pptlSrc
);

パラメーター

名前	型	方向	説明
psoDest	SURFOBJ*	inout	コピー操作の転送先サーフェスを記述する SURFOBJ 構造体へのポインター。
psoSrc	SURFOBJ*	inout	コピー操作の転送元サーフェスを記述する SURFOBJ 構造体へのポインター。
pco	CLIPOBJ*	inout	影響を受ける転送先サーフェスの領域を制限する CLIPOBJ 構造体へのポインター。このパラメーターは NULL にできます。
pxlo	XLATEOBJ*	inout	転送元サーフェスと転送先サーフェスの間のカラーインデックスの変換を定義する XLATEOBJ 構造体へのポインター。
prclDest	RECTL*	inout	転送先サーフェスの座標系において変更される領域を定義する RECTL 構造体へのポインター。この四角形は右下が排他的(lower-right exclusive)であり、四角形の下端と右端はコピーに含まれません。
pptlSrc	POINTL*	inout	転送元四角形の左上隅を定義する POINTL 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

EngCopyBits 関数は、デバイス管理のラスターサーフェスと GDI 標準形式ビットマップとの間で変換を行います。

戻り値

関数が成功した場合、戻り値は TRUE です。失敗した場合は、エラーをログに記録して FALSE を返します。

解説(Remarks)

標準形式ビットマップは、単一プレーンのパックドピクセル形式です。各走査線は 4 バイト境界に整列されます。これらのビットマップは、1、4、8、16、24、または 32 ビット/ピクセルを持ちます。標準形式の種類の一覧については、EngCreateBitmap 関数を参照してください。

GDI はそのシミュレーションからこの関数を呼び出します。

EngCopyBits は、空の転送先四角形で呼び出してはならず、転送先四角形の 2 つの点は適切に順序付けられている必要があります。つまり、最初の点は四角形の左上の頂点を表し、2 番目の点は右下の頂点を表す必要があります。

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

各言語での呼び出し定義

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

BOOL EngCopyBits(
    SURFOBJ* psoDest,
    SURFOBJ* psoSrc,
    CLIPOBJ* pco,
    XLATEOBJ* pxlo,
    RECTL* prclDest,
    POINTL* pptlSrc
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngCopyBits(
    IntPtr psoDest,   // SURFOBJ* in/out
    IntPtr psoSrc,   // SURFOBJ* in/out
    IntPtr pco,   // CLIPOBJ* in/out
    IntPtr pxlo,   // XLATEOBJ* in/out
    IntPtr prclDest,   // RECTL* in/out
    IntPtr pptlSrc   // POINTL* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngCopyBits(
    psoDest As IntPtr,   ' SURFOBJ* in/out
    psoSrc As IntPtr,   ' SURFOBJ* in/out
    pco As IntPtr,   ' CLIPOBJ* in/out
    pxlo As IntPtr,   ' XLATEOBJ* in/out
    prclDest As IntPtr,   ' RECTL* in/out
    pptlSrc As IntPtr   ' POINTL* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' psoDest : SURFOBJ* in/out
' psoSrc : SURFOBJ* in/out
' pco : CLIPOBJ* in/out
' pxlo : XLATEOBJ* in/out
' prclDest : RECTL* in/out
' pptlSrc : POINTL* in/out
Declare PtrSafe Function EngCopyBits Lib "gdi32" ( _
    ByVal psoDest As LongPtr, _
    ByVal psoSrc As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal pxlo As LongPtr, _
    ByVal prclDest As LongPtr, _
    ByVal pptlSrc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EngCopyBits = ctypes.windll.gdi32.EngCopyBits
EngCopyBits.restype = wintypes.BOOL
EngCopyBits.argtypes = [
    ctypes.c_void_p,  # psoDest : SURFOBJ* in/out
    ctypes.c_void_p,  # psoSrc : SURFOBJ* in/out
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
    ctypes.c_void_p,  # pxlo : XLATEOBJ* in/out
    ctypes.c_void_p,  # prclDest : RECTL* in/out
    ctypes.c_void_p,  # pptlSrc : POINTL* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngCopyBits = Fiddle::Function.new(
  lib['EngCopyBits'],
  [
    Fiddle::TYPE_VOIDP,  # psoDest : SURFOBJ* in/out
    Fiddle::TYPE_VOIDP,  # psoSrc : SURFOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pxlo : XLATEOBJ* in/out
    Fiddle::TYPE_VOIDP,  # prclDest : RECTL* in/out
    Fiddle::TYPE_VOIDP,  # pptlSrc : POINTL* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngCopyBits(
        psoDest: *mut SURFOBJ,  // SURFOBJ* in/out
        psoSrc: *mut SURFOBJ,  // SURFOBJ* in/out
        pco: *mut CLIPOBJ,  // CLIPOBJ* in/out
        pxlo: *mut XLATEOBJ,  // XLATEOBJ* in/out
        prclDest: *mut RECTL,  // RECTL* in/out
        pptlSrc: *mut POINTL  // POINTL* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool EngCopyBits(IntPtr psoDest, IntPtr psoSrc, IntPtr pco, IntPtr pxlo, IntPtr prclDest, IntPtr pptlSrc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngCopyBits' -Namespace Win32 -PassThru
# $api::EngCopyBits(psoDest, psoSrc, pco, pxlo, prclDest, pptlSrc)

#uselib "GDI32.dll"
#func global EngCopyBits "EngCopyBits" sptr, sptr, sptr, sptr, sptr, sptr
; EngCopyBits varptr(psoDest), varptr(psoSrc), varptr(pco), varptr(pxlo), varptr(prclDest), varptr(pptlSrc)   ; 戻り値は stat
; psoDest : SURFOBJ* in/out -> "sptr"
; psoSrc : SURFOBJ* in/out -> "sptr"
; pco : CLIPOBJ* in/out -> "sptr"
; pxlo : XLATEOBJ* in/out -> "sptr"
; prclDest : RECTL* in/out -> "sptr"
; pptlSrc : POINTL* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global EngCopyBits "EngCopyBits" var, var, var, var, var, var
; res = EngCopyBits(psoDest, psoSrc, pco, pxlo, prclDest, pptlSrc)
; psoDest : SURFOBJ* in/out -> "var"
; psoSrc : SURFOBJ* in/out -> "var"
; pco : CLIPOBJ* in/out -> "var"
; pxlo : XLATEOBJ* in/out -> "var"
; prclDest : RECTL* in/out -> "var"
; pptlSrc : POINTL* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global EngCopyBits "EngCopyBits" sptr, sptr, sptr, sptr, sptr, sptr
; res = EngCopyBits(varptr(psoDest), varptr(psoSrc), varptr(pco), varptr(pxlo), varptr(prclDest), varptr(pptlSrc))
; psoDest : SURFOBJ* in/out -> "sptr"
; psoSrc : SURFOBJ* in/out -> "sptr"
; pco : CLIPOBJ* in/out -> "sptr"
; pxlo : XLATEOBJ* in/out -> "sptr"
; prclDest : RECTL* in/out -> "sptr"
; pptlSrc : POINTL* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。