PolyDraw

関数

点配列と種別配列から線分やベジェ曲線を一括描画する。

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

シグネチャ

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

BOOL PolyDraw(
    HDC hdc,
    const POINT* apt,
    const BYTE* aj,
    INT cpt
);

パラメーター

名前

型

方向

説明

hdc

HDC

デバイスコンテキストへのハンドル。

apt

POINT*

各線分の端点、および各 Bézier 曲線の端点と制御点を論理単位で格納した POINT 構造体の配列へのポインター。

BYTE*

lppt 配列内の各点をどのように使用するかを指定する配列へのポインター。このパラメーターには、次のいずれかの値を指定できます。

型	意味
PT_MOVETO	この点が独立した図形を開始することを指定します。この点が新しい現在位置になります。
PT_LINETO	現在位置からこの点まで線を描画することを指定します。その後、この点が新しい現在位置になります。
PT_BEZIERTO	この点が Bézier 曲線の制御点または終点であることを指定します。 PT_BEZIERTO 型は常に 3 つ 1 組で出現します。現在位置が Bézier 曲線の開始点を定義します。最初の 2 つの PT_BEZIERTO 点は制御点で、3 つ目の PT_BEZIERTO 点は終点です。終点が新しい現在位置になります。連続する 3 つの PT_BEZIERTO 点が存在しない場合、エラーになります。

PT_LINETO 型または PT_BEZIERTO 型は、ビット単位の OR 演算子を使用して次の値と組み合わせることで、対応する点が図形内の最後の点であり、図形が閉じられていることを示すことができます。

値

意味

PT_CLOSEFIGURE

この点に対する PT_LINETO 型または PT_BEZIERTO 型の処理が完了した後、図形が自動的に閉じられることを指定します。この点から、直近の PT_MOVETO 点または MoveToEx 点まで線が描画されます。

この値は、ビット単位の OR 演算子を使用して、線の場合は PT_LINETO 型と、Bézier 曲線の場合は終点の PT_BEZIERTO 型と組み合わせます。

現在位置は、閉じる線の終点に設定されます。

cpt

INT

lppt 配列内の点の総数。lpbTypes 配列内のバイト数と同じです。

戻り値の型: BOOL

公式ドキュメント

PolyDraw 関数は、一連の線分と Bézier 曲線を描画します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

PolyDraw 関数は、独立した図形を描画するために MoveToEx、LineTo、PolyBezierTo の各関数を連続して呼び出す代わりに使用できます。線と曲線は現在のペンを使用して描画され、図形は塗りつぶされません。BeginPath の呼び出しによって開始されたアクティブなパスがある場合、PolyDraw はそのパスに追加します。

lppt 配列および lpbTypes 配列に含まれる点は、各点が MoveTo、LineTo、PolyBezierTo のいずれの操作の一部であるかを示します。図形を閉じることもできます。

この関数は現在位置を更新します。

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

各言語での呼び出し定義

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

BOOL PolyDraw(
    HDC hdc,
    const POINT* apt,
    const BYTE* aj,
    INT cpt
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool PolyDraw(
    IntPtr hdc,   // HDC
    IntPtr apt,   // POINT*
    IntPtr aj,   // BYTE*
    int cpt   // INT
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function PolyDraw(
    hdc As IntPtr,   ' HDC
    apt As IntPtr,   ' POINT*
    aj As IntPtr,   ' BYTE*
    cpt As Integer   ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' apt : POINT*
' aj : BYTE*
' cpt : INT
Declare PtrSafe Function PolyDraw Lib "gdi32" ( _
    ByVal hdc As LongPtr, _
    ByVal apt As LongPtr, _
    ByVal aj As LongPtr, _
    ByVal cpt As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PolyDraw = ctypes.windll.gdi32.PolyDraw
PolyDraw.restype = wintypes.BOOL
PolyDraw.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # apt : POINT*
    ctypes.POINTER(ctypes.c_ubyte),  # aj : BYTE*
    ctypes.c_int,  # cpt : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
PolyDraw = Fiddle::Function.new(
  lib['PolyDraw'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # apt : POINT*
    Fiddle::TYPE_VOIDP,  # aj : BYTE*
    Fiddle::TYPE_INT,  # cpt : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn PolyDraw(
        hdc: *mut core::ffi::c_void,  // HDC
        apt: *const POINT,  // POINT*
        aj: *const u8,  // BYTE*
        cpt: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll")]
public static extern bool PolyDraw(IntPtr hdc, IntPtr apt, IntPtr aj, int cpt);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_PolyDraw' -Namespace Win32 -PassThru
# $api::PolyDraw(hdc, apt, aj, cpt)

#uselib "GDI32.dll"
#func global PolyDraw "PolyDraw" sptr, sptr, sptr, sptr
; PolyDraw hdc, varptr(apt), varptr(aj), cpt   ; 戻り値は stat
; hdc : HDC -> "sptr"
; apt : POINT* -> "sptr"
; aj : BYTE* -> "sptr"
; cpt : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "GDI32.dll"
#cfunc global PolyDraw "PolyDraw" sptr, var, var, int
; res = PolyDraw(hdc, apt, aj, cpt)
; hdc : HDC -> "sptr"
; apt : POINT* -> "var"
; aj : BYTE* -> "var"
; cpt : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "GDI32.dll"
#cfunc global PolyDraw "PolyDraw" sptr, sptr, sptr, int
; res = PolyDraw(hdc, varptr(apt), varptr(aj), cpt)
; hdc : HDC -> "sptr"
; apt : POINT* -> "sptr"
; aj : BYTE* -> "sptr"
; cpt : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。