ホーム › Devices.Display › PATHOBJ_bEnumClipLines

PATHOBJ_bEnumClipLines

関数

クリップ済みの線分を順に列挙する。

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

シグネチャ

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

BOOL PATHOBJ_bEnumClipLines(
    PATHOBJ* ppo,
    DWORD cb,
    CLIPLINE* pcl
);

パラメーター

名前	型	方向	説明
ppo	PATHOBJ*	inout	列挙対象となるクリップ済みの線分を含む PATHOBJ 構造体へのポインターです。
cb	DWORD	in	出力バッファーのサイズをバイト単位で指定します。GDI はこの位置を超えてバッファーに書き込みません。このパラメーターの値は、少なくとも 1 つの RUN 構造体を含む CLIPLINE 構造体を格納できるだけの大きさが必要です。ドライバーは複数の RUN 構造体のための領域を割り当てる必要があります。
pcl	CLIPLINE*	inout	CLIPLINE 構造体を受け取るバッファーへのポインターです。この構造体には、線分の元のクリップされていない制御点が含まれます。(元の制御点なしには、線の正しいピクセルを計算できません。) クリップで除去されずに残った線上のピクセルの集合を表す RUN 構造体が、このバッファーに書き込まれます。クリップ領域が複雑な場合、1 本の線分が多数の RUN 構造体に分割されることがあります。線分は、そのすべての RUN 構造体を列挙するために必要な回数だけ返されます。 CLIPLINE 構造体には、元のクリップされていない線の始点と終点、およびその線のうちディスプレイに表示される線分 (RUN 構造体) が含まれます。

名前

型

方向

説明

ppo

PATHOBJ*

inout

列挙対象となるクリップ済みの線分を含む PATHOBJ 構造体へのポインターです。

DWORD

出力バッファーのサイズをバイト単位で指定します。GDI はこの位置を超えてバッファーに書き込みません。このパラメーターの値は、少なくとも 1 つの RUN 構造体を含む CLIPLINE 構造体を格納できるだけの大きさが必要です。ドライバーは複数の RUN 構造体のための領域を割り当てる必要があります。

pcl

CLIPLINE*

inout

CLIPLINE 構造体を受け取るバッファーへのポインターです。この構造体には、線分の元のクリップされていない制御点が含まれます。(元の制御点なしには、線の正しいピクセルを計算できません。) クリップで除去されずに残った線上のピクセルの集合を表す RUN 構造体が、このバッファーに書き込まれます。

クリップ領域が複雑な場合、1 本の線分が多数の RUN 構造体に分割されることがあります。線分は、そのすべての RUN 構造体を列挙するために必要な回数だけ返されます。

CLIPLINE 構造体には、元のクリップされていない線の始点と終点、およびその線のうちディスプレイに表示される線分 (RUN 構造体) が含まれます。

戻り値の型: BOOL

公式ドキュメント

PATHOBJ_bEnumClipLines 関数は、指定されたパスからクリップされた線分を列挙します。

戻り値

列挙すべき線分がまだある場合、戻り値は TRUE となり、このサービスを再度呼び出す必要があることを示します。それ以外の場合は FALSE となり、返された線分がパス内の最後の線分であることを示します。

解説(Remarks)

列挙は、ドライバーがこの呼び出しを行う前に PATHOBJ_vEnumStartClipLines で開始しておく必要があります。

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

各言語での呼び出し定義

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

BOOL PATHOBJ_bEnumClipLines(
    PATHOBJ* ppo,
    DWORD cb,
    CLIPLINE* pcl
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool PATHOBJ_bEnumClipLines(
    IntPtr ppo,   // PATHOBJ* in/out
    uint cb,   // DWORD
    IntPtr pcl   // CLIPLINE* in/out
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function PATHOBJ_bEnumClipLines(
    ppo As IntPtr,   ' PATHOBJ* in/out
    cb As UInteger,   ' DWORD
    pcl As IntPtr   ' CLIPLINE* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ppo : PATHOBJ* in/out
' cb : DWORD
' pcl : CLIPLINE* in/out
Declare PtrSafe Function PATHOBJ_bEnumClipLines Lib "gdi32" ( _
    ByVal ppo As LongPtr, _
    ByVal cb As Long, _
    ByVal pcl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PATHOBJ_bEnumClipLines = ctypes.windll.gdi32.PATHOBJ_bEnumClipLines
PATHOBJ_bEnumClipLines.restype = wintypes.BOOL
PATHOBJ_bEnumClipLines.argtypes = [
    ctypes.c_void_p,  # ppo : PATHOBJ* in/out
    wintypes.DWORD,  # cb : DWORD
    ctypes.c_void_p,  # pcl : CLIPLINE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PATHOBJ_bEnumClipLines = Fiddle::Function.new(
  lib['PATHOBJ_bEnumClipLines'],
  [
    Fiddle::TYPE_VOIDP,  # ppo : PATHOBJ* in/out
    -Fiddle::TYPE_INT,  # cb : DWORD
    Fiddle::TYPE_VOIDP,  # pcl : CLIPLINE* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn PATHOBJ_bEnumClipLines(
        ppo: *mut PATHOBJ,  // PATHOBJ* in/out
        cb: u32,  // DWORD
        pcl: *mut CLIPLINE  // CLIPLINE* 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 PATHOBJ_bEnumClipLines(IntPtr ppo, uint cb, IntPtr pcl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PATHOBJ_bEnumClipLines' -Namespace Win32 -PassThru
# $api::PATHOBJ_bEnumClipLines(ppo, cb, pcl)

#uselib "GDI32.dll"
#func global PATHOBJ_bEnumClipLines "PATHOBJ_bEnumClipLines" sptr, sptr, sptr
; PATHOBJ_bEnumClipLines varptr(ppo), cb, varptr(pcl)   ; 戻り値は stat
; ppo : PATHOBJ* in/out -> "sptr"
; cb : DWORD -> "sptr"
; pcl : CLIPLINE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global PATHOBJ_bEnumClipLines "PATHOBJ_bEnumClipLines" var, int, var
; res = PATHOBJ_bEnumClipLines(ppo, cb, pcl)
; ppo : PATHOBJ* in/out -> "var"
; cb : DWORD -> "int"
; pcl : CLIPLINE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global PATHOBJ_bEnumClipLines "PATHOBJ_bEnumClipLines" sptr, int, sptr
; res = PATHOBJ_bEnumClipLines(varptr(ppo), cb, varptr(pcl))
; ppo : PATHOBJ* in/out -> "sptr"
; cb : DWORD -> "int"
; pcl : CLIPLINE* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。