EngStrokePath

関数

サーフェス上にパスの輪郭線を描画する。

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

シグネチャ

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

BOOL EngStrokePath(
    SURFOBJ* pso,
    PATHOBJ* ppo,
    CLIPOBJ* pco,
    XFORMOBJ* pxo,
    BRUSHOBJ* pbo,
    POINTL* pptlBrushOrg,
    LINEATTRS* plineattrs,
    DWORD mix
);

パラメーター

名前	型	方向	説明
pso	SURFOBJ*	inout	描画先のサーフェスを表す SURFOBJ 構造体へのポインターです。
ppo	PATHOBJ*	inout	PATHOBJ 構造体へのポインターです。パスを構成する直線、ベジエ曲線、その他のデータを列挙するために、PATHOBJ_Xxx サービスルーチンが提供されています。これは何を描画するかを示します。
pco	CLIPOBJ*	inout	CLIPOBJ 構造体へのポインターです。クリップ領域を矩形の集合として列挙するために、CLIPOBJ_Xxx サービスルーチンが提供されています。オプションで、パス内のすべての直線をこの CLIPOBJ によって事前にクリップした状態で列挙できます。これにより、ドライバーは直線のクリッピング計算をすべて代行してもらうことができます。
pxo	XFORMOBJ*	inout	XFORMOBJ 構造体へのポインターです。これはジオメトリックな太線を描画する場合にのみ必要です。ワールド座標をデバイス座標に変換する変換を指定します。パスはデバイス座標で提供されますが、ジオメトリックな太線は実際にはワールド座標で太らせるため、この情報が必要になります。ドライバーは XFORMOBJ_Xxx サービスルーチンを使用して変換を取得できます。
pbo	BRUSHOBJ*	inout	パスの描画時に使用するブラシを指定する BRUSHOBJ 構造体へのポインターです。
pptlBrushOrg	POINTL*	inout	デバイス上でブラシパターンを位置合わせするために使用するブラシ原点を含む POINTL 構造体へのポインターです。
plineattrs	LINEATTRS*	inout	LINEATTRS 構造体へのポインターです。線がスタイル付きの場合、この関数の一部としてこの構造体の elStyleState メンバーを更新する必要があることに注意してください。また、1 ピクセル幅のコスメティックラインを描画する場合は、同じ構造体の ptlLastPel メンバーを更新する必要があることにも注意してください。
mix	DWORD	in	ブラシを描画先とどのように組み合わせるかを指定します。

戻り値の型: BOOL

公式ドキュメント

EngStrokePath 関数は、GDI に対して指定されたパスのストローク描画を要求します。

戻り値

GDI がパスをストローク描画した場合、戻り値は TRUE です。ドライバー側でパスをストローク描画する必要がある場合、戻り値は FALSE となり、エラーは記録されません。GDI でエラーが発生した場合、戻り値は DDI_ERROR となり、エラーコードが記録されます。

解説(Remarks)

ミックスモードは、入力されるパターンを、デバイスサーフェス上に既に存在するデータとどのように混合するかを定義します。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 EngStrokePath(
    SURFOBJ* pso,
    PATHOBJ* ppo,
    CLIPOBJ* pco,
    XFORMOBJ* pxo,
    BRUSHOBJ* pbo,
    POINTL* pptlBrushOrg,
    LINEATTRS* plineattrs,
    DWORD mix
);

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

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

' pso : SURFOBJ* in/out
' ppo : PATHOBJ* in/out
' pco : CLIPOBJ* in/out
' pxo : XFORMOBJ* in/out
' pbo : BRUSHOBJ* in/out
' pptlBrushOrg : POINTL* in/out
' plineattrs : LINEATTRS* in/out
' mix : DWORD
Declare PtrSafe Function EngStrokePath Lib "gdi32" ( _
    ByVal pso As LongPtr, _
    ByVal ppo As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal pxo As LongPtr, _
    ByVal pbo As LongPtr, _
    ByVal pptlBrushOrg As LongPtr, _
    ByVal plineattrs 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

EngStrokePath = ctypes.windll.gdi32.EngStrokePath
EngStrokePath.restype = wintypes.BOOL
EngStrokePath.argtypes = [
    ctypes.c_void_p,  # pso : SURFOBJ* in/out
    ctypes.c_void_p,  # ppo : PATHOBJ* in/out
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
    ctypes.c_void_p,  # pxo : XFORMOBJ* in/out
    ctypes.c_void_p,  # pbo : BRUSHOBJ* in/out
    ctypes.c_void_p,  # pptlBrushOrg : POINTL* in/out
    ctypes.c_void_p,  # plineattrs : LINEATTRS* in/out
    wintypes.DWORD,  # mix : DWORD
]

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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