EngPaint

関数

クリップ領域をブラシで塗りつぶす。

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

シグネチャ

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

BOOL EngPaint(
    SURFOBJ* pso,
    CLIPOBJ* pco,
    BRUSHOBJ* pbo,
    POINTL* pptlBrushOrg,
    DWORD mix
);

パラメーター

名前	型	方向	説明
pso	SURFOBJ*	inout	描画対象のサーフェスを記述する SURFOBJ 構造体へのポインターです。
pco	CLIPOBJ*	inout	描画する領域を定義する CLIPOBJ 構造体へのポインターです。CLIPOBJ_Xxx サービスルーチンは、クリップ領域を矩形の集合として列挙するために提供されています。
pbo	BRUSHOBJ*	inout	塗りつぶしに使用するパターンと色を定義する BRUSHOBJ 構造体へのポインターです。
pptlBrushOrg	POINTL*	inout	デバイス上でブラシパターンを揃えるために使用するブラシ原点を定義する POINTL 構造体へのポインターです。
mix	DWORD	in	ブラシに使用する前景および背景のラスター演算を定義します。

戻り値の型: BOOL

公式ドキュメント

EngPaint 関数は、GDI に指定された領域を描画させます。

戻り値

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

解説(Remarks)

ベクターデバイスドライバーは、EngCreatePath および PATHOBJ_Xxx サービスルーチンの助けを借りて、この関数を実装できます。

ミックスモードは、入力されるパターンをデバイスサーフェス上の既存データとどのように混合するかを定義します。MIX データ型は、2 つの ROP2 値を 1 つの ULONG にパックしたものです。下位バイトは前景のラスター演算を、次のバイトは背景のラスター演算を定義します。ラスター演算コードの詳細については、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 EngPaint(
    SURFOBJ* pso,
    CLIPOBJ* pco,
    BRUSHOBJ* pbo,
    POINTL* pptlBrushOrg,
    DWORD mix
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngPaint(
    IntPtr pso,   // SURFOBJ* in/out
    IntPtr pco,   // CLIPOBJ* in/out
    IntPtr pbo,   // BRUSHOBJ* in/out
    IntPtr pptlBrushOrg,   // POINTL* in/out
    uint mix   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngPaint(
    pso As IntPtr,   ' SURFOBJ* in/out
    pco As IntPtr,   ' CLIPOBJ* in/out
    pbo As IntPtr,   ' BRUSHOBJ* in/out
    pptlBrushOrg As IntPtr,   ' POINTL* in/out
    mix As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pso : SURFOBJ* in/out
' pco : CLIPOBJ* in/out
' pbo : BRUSHOBJ* in/out
' pptlBrushOrg : POINTL* in/out
' mix : DWORD
Declare PtrSafe Function EngPaint Lib "gdi32" ( _
    ByVal pso As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal pbo As LongPtr, _
    ByVal pptlBrushOrg As LongPtr, _
    ByVal mix As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EngPaint = ctypes.windll.gdi32.EngPaint
EngPaint.restype = wintypes.BOOL
EngPaint.argtypes = [
    ctypes.c_void_p,  # pso : SURFOBJ* in/out
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
    ctypes.c_void_p,  # pbo : BRUSHOBJ* in/out
    ctypes.c_void_p,  # pptlBrushOrg : POINTL* in/out
    wintypes.DWORD,  # mix : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngPaint = Fiddle::Function.new(
  lib['EngPaint'],
  [
    Fiddle::TYPE_VOIDP,  # pso : SURFOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pbo : BRUSHOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pptlBrushOrg : POINTL* in/out
    -Fiddle::TYPE_INT,  # mix : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngPaint(
        pso: *mut SURFOBJ,  // SURFOBJ* in/out
        pco: *mut CLIPOBJ,  // CLIPOBJ* in/out
        pbo: *mut BRUSHOBJ,  // BRUSHOBJ* in/out
        pptlBrushOrg: *mut POINTL,  // POINTL* in/out
        mix: 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 EngPaint(IntPtr pso, IntPtr pco, IntPtr pbo, IntPtr pptlBrushOrg, uint mix);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngPaint' -Namespace Win32 -PassThru
# $api::EngPaint(pso, pco, pbo, pptlBrushOrg, mix)

#uselib "GDI32.dll"
#func global EngPaint "EngPaint" sptr, sptr, sptr, sptr, sptr
; EngPaint varptr(pso), varptr(pco), varptr(pbo), varptr(pptlBrushOrg), mix   ; 戻り値は stat
; pso : SURFOBJ* in/out -> "sptr"
; pco : CLIPOBJ* in/out -> "sptr"
; pbo : BRUSHOBJ* in/out -> "sptr"
; pptlBrushOrg : POINTL* in/out -> "sptr"
; mix : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global EngPaint "EngPaint" var, var, var, var, int
; res = EngPaint(pso, pco, pbo, pptlBrushOrg, mix)
; pso : SURFOBJ* in/out -> "var"
; pco : CLIPOBJ* in/out -> "var"
; pbo : BRUSHOBJ* in/out -> "var"
; pptlBrushOrg : POINTL* in/out -> "var"
; mix : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global EngPaint "EngPaint" sptr, sptr, sptr, sptr, int
; res = EngPaint(varptr(pso), varptr(pco), varptr(pbo), varptr(pptlBrushOrg), mix)
; pso : SURFOBJ* in/out -> "sptr"
; pco : CLIPOBJ* in/out -> "sptr"
; pbo : BRUSHOBJ* in/out -> "sptr"
; pptlBrushOrg : POINTL* in/out -> "sptr"
; mix : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。