EngLineTo

関数

サーフェス上に直線を描画する。

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

シグネチャ

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

BOOL EngLineTo(
    SURFOBJ* pso,
    CLIPOBJ* pco,
    BRUSHOBJ* pbo,
    INT x1,
    INT y1,
    INT x2,
    INT y2,
    RECTL* prclBounds,
    DWORD mix
);

パラメーター

名前	型	方向	説明
pso	SURFOBJ*	inout	描画対象のサーフェスを記述する SURFOBJ 構造体へのポインターです。
pco	CLIPOBJ*	inout	レンダリングを行うクリップ領域を定義する CLIPOBJ 構造体へのポインターです。このクリップ領域の外側のピクセルは影響を受けません。
pbo	BRUSHOBJ*	inout	ラインの描画に使用するブラシを指定する BRUSHOBJ 構造体へのポインターです。
x1	INT	in	ラインの始点の整数 x 座標を指定します。
y1	INT	in	ラインの始点の整数 y 座標を指定します。
x2	INT	in	ラインの終点の整数 x 座標を指定します。
y2	INT	in	ラインの終点の整数 x 座標および y 座標を指定します。
prclBounds	RECTL*	inout	クリップされていないラインを囲む四角形を記述する RECTL 構造体へのポインターです。ハードウェアによるライン描画をサポートするドライバーは、この四角形を使用して、ラインがハードウェアでレンダリング可能なほど十分小さい座標空間に収まるかどうかを迅速に判断できます。
mix	DWORD	in	入力されるパターンをデバイスサーフェス上に既に存在するデータとどのように混合するかを定義します。下位バイトはラスター演算を定義します。ラスター演算コードの詳細については、Microsoft Windows SDK のドキュメントを参照してください。

戻り値の型: BOOL

公式ドキュメント

EngLineTo 関数は、整数座標のみを使用する単一の実線コスメティックラインを描画します。

戻り値

EngLineTo は、成功した場合は TRUE を返します。それ以外の場合は FALSE を返します。

解説(Remarks)

DrvLineTo をフックしたドライバーは、レンダリングサーフェスがデバイス非依存ビットマップ (DIB) である場合に EngLineTo を呼び出すことができます。

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

各言語での呼び出し定義

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

BOOL EngLineTo(
    SURFOBJ* pso,
    CLIPOBJ* pco,
    BRUSHOBJ* pbo,
    INT x1,
    INT y1,
    INT x2,
    INT y2,
    RECTL* prclBounds,
    DWORD mix
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngLineTo(
    IntPtr pso,   // SURFOBJ* in/out
    IntPtr pco,   // CLIPOBJ* in/out
    IntPtr pbo,   // BRUSHOBJ* in/out
    int x1,   // INT
    int y1,   // INT
    int x2,   // INT
    int y2,   // INT
    IntPtr prclBounds,   // RECTL* in/out
    uint mix   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngLineTo(
    pso As IntPtr,   ' SURFOBJ* in/out
    pco As IntPtr,   ' CLIPOBJ* in/out
    pbo As IntPtr,   ' BRUSHOBJ* in/out
    x1 As Integer,   ' INT
    y1 As Integer,   ' INT
    x2 As Integer,   ' INT
    y2 As Integer,   ' INT
    prclBounds As IntPtr,   ' RECTL* 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
' x1 : INT
' y1 : INT
' x2 : INT
' y2 : INT
' prclBounds : RECTL* in/out
' mix : DWORD
Declare PtrSafe Function EngLineTo Lib "gdi32" ( _
    ByVal pso As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal pbo As LongPtr, _
    ByVal x1 As Long, _
    ByVal y1 As Long, _
    ByVal x2 As Long, _
    ByVal y2 As Long, _
    ByVal prclBounds 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

EngLineTo = ctypes.windll.gdi32.EngLineTo
EngLineTo.restype = wintypes.BOOL
EngLineTo.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_int,  # x1 : INT
    ctypes.c_int,  # y1 : INT
    ctypes.c_int,  # x2 : INT
    ctypes.c_int,  # y2 : INT
    ctypes.c_void_p,  # prclBounds : RECTL* in/out
    wintypes.DWORD,  # mix : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngLineTo = Fiddle::Function.new(
  lib['EngLineTo'],
  [
    Fiddle::TYPE_VOIDP,  # pso : SURFOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pbo : BRUSHOBJ* in/out
    Fiddle::TYPE_INT,  # x1 : INT
    Fiddle::TYPE_INT,  # y1 : INT
    Fiddle::TYPE_INT,  # x2 : INT
    Fiddle::TYPE_INT,  # y2 : INT
    Fiddle::TYPE_VOIDP,  # prclBounds : RECTL* in/out
    -Fiddle::TYPE_INT,  # mix : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngLineTo(
        pso: *mut SURFOBJ,  // SURFOBJ* in/out
        pco: *mut CLIPOBJ,  // CLIPOBJ* in/out
        pbo: *mut BRUSHOBJ,  // BRUSHOBJ* in/out
        x1: i32,  // INT
        y1: i32,  // INT
        x2: i32,  // INT
        y2: i32,  // INT
        prclBounds: *mut RECTL,  // RECTL* 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 EngLineTo(IntPtr pso, IntPtr pco, IntPtr pbo, int x1, int y1, int x2, int y2, IntPtr prclBounds, uint mix);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngLineTo' -Namespace Win32 -PassThru
# $api::EngLineTo(pso, pco, pbo, x1, y1, x2, y2, prclBounds, mix)

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

出力引数:

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