EngTextOut

関数

サーフェス上にグリフ列のテキストを描画する。

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

シグネチャ

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

BOOL EngTextOut(
    SURFOBJ* pso,
    STROBJ* pstro,
    FONTOBJ* pfo,
    CLIPOBJ* pco,
    RECTL* prclExtra,
    RECTL* prclOpaque,
    BRUSHOBJ* pboFore,
    BRUSHOBJ* pboOpaque,
    POINTL* pptlOrg,
    DWORD mix
);

パラメーター

名前	型	方向	説明
pso	SURFOBJ*	inout	書き込み先のサーフェスを記述する SURFOBJ 構造体へのポインターです。
pstro	STROBJ*	inout	描画するグリフと、それらを配置する位置を定義する STROBJ 構造体へのポインターです。
pfo	FONTOBJ*	inout	フォントおよびそのグリフに関する情報を取得するために使用される FONTOBJ 構造体へのポインターです。
pco	CLIPOBJ*	inout	描画を行うクリップ領域を定義する CLIPOBJ 構造体へのポインターです。このクリップ領域の外側のピクセルは影響を受けません。
prclExtra	RECTL*	inout	RECTL 構造体へのポインターです。このパラメーターは常に NULL でなければなりません。
prclOpaque	RECTL*	inout	右下を含まない (lower-right exclusive) 単一の不透明な矩形を識別する RECTL 構造体へのポインターです。この矩形内のピクセル (前景でもクリップ対象でもないもの) は、不透明ブラシで描画されます。この矩形は常に描画対象のテキストを境界として囲みます。このパラメーターが NULL の場合、不透明ピクセルは描画されません。
pboFore	BRUSHOBJ*	inout	前景ピクセルに使用するブラシオブジェクトを表す BRUSHOBJ 構造体へのポインターです。このブラシは常に単色ブラシになります。
pboOpaque	BRUSHOBJ*	inout	不透明ピクセルに使用するブラシオブジェクトを表す BRUSHOBJ 構造体へのポインターです。このブラシの前景および背景のミックスモードは、いずれも R2_COPYPEN であると想定されます。ドライバーが DEVINFO 構造体の flGraphicsCaps メンバーに GCAPS_ARBRUSHOPAQUE ケイパビリティビットを設定していない限り、常に単色ブラシで呼び出されます。
pptlOrg	POINTL*	inout	両方のブラシのブラシ原点を定義する POINTL 構造体へのポインターです。EngTextOut の呼び出し時にこのパラメーターが 0 に設定されていると、一部のプリンタードライバーがカラー画像を正しく印刷しない場合があります。詳細については解説を参照してください。
mix	DWORD	in	pboFore に対する前景および背景のラスター操作 (ミックスモード) を指定します。

戻り値の型: BOOL

公式ドキュメント

EngTextOut 関数は、GDI に対して指定された位置に一連のグリフを描画させます。

戻り値

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

解説(Remarks)

ドライバーは、DrvTextOut をフックしていてグリフを描画できない場合に、EngTextOut を呼び出す必要があります。

注意デバイス管理サーフェスに対して DrvTextOut をフックしている場合、ドライバーは EngTextOut に処理を委ねることはできません。

EngTextOut への入力パラメーターは、前景と不透明という 2 種類のピクセルの集合を定義します。ドライバーは、まず不透明ピクセルを不透明ブラシで描画し、次に前景ピクセルを前景ブラシで描画する処理と同一の結果になるように、サーフェスを描画しなければなりません。これらの各操作はクリッピングによって制限されます。

この関数の pptlOrg パラメーターが 0 に設定されている場合、Microsoft Windows Server 2003 (日本語版) では一部のプリンタードライバーがカラー画像を正しく印刷しないことがあります。pptlOrg を 0 (NULL ポインター値) に設定すると、ブラシ原点が定義されていないと解釈されます。この問題を防ぐには、EngTextOut を呼び出す前に、メンバーが (0,0) に設定された POINTL 構造体のアドレスで pptlOrg を初期化してください。

前景および不透明ピクセルは、サーフェス上に色を塗り込むためのスクリーンとみなされます。フォントのグリフ自体は色を持ちません。

EngTextOut への入力パラメーターは、グリフピクセルの集合、追加矩形の集合、不透明矩形、およびクリップ領域を定義します。ドライバーは前景ピクセルと不透明ピクセルの集合を計算し、それを描画する必要があります。

ミックスモードは、入力されるパターンをデバイスサーフェス上に既に存在するデータとどのように混合するかを定義します。MIX データ型は、1 つの ULONG にパックされた 2 つの ROP2 値で構成されます。下位バイトが前景のラスター操作を定義し、次のバイトが背景のラスター操作を定義します。ラスター操作コードの詳細については、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 EngTextOut(
    SURFOBJ* pso,
    STROBJ* pstro,
    FONTOBJ* pfo,
    CLIPOBJ* pco,
    RECTL* prclExtra,
    RECTL* prclOpaque,
    BRUSHOBJ* pboFore,
    BRUSHOBJ* pboOpaque,
    POINTL* pptlOrg,
    DWORD mix
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("GDI32.dll", ExactSpelling = true)]
static extern bool EngTextOut(
    IntPtr pso,   // SURFOBJ* in/out
    IntPtr pstro,   // STROBJ* in/out
    IntPtr pfo,   // FONTOBJ* in/out
    IntPtr pco,   // CLIPOBJ* in/out
    IntPtr prclExtra,   // RECTL* in/out
    IntPtr prclOpaque,   // RECTL* in/out
    IntPtr pboFore,   // BRUSHOBJ* in/out
    IntPtr pboOpaque,   // BRUSHOBJ* in/out
    IntPtr pptlOrg,   // POINTL* in/out
    uint mix   // DWORD
);

<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function EngTextOut(
    pso As IntPtr,   ' SURFOBJ* in/out
    pstro As IntPtr,   ' STROBJ* in/out
    pfo As IntPtr,   ' FONTOBJ* in/out
    pco As IntPtr,   ' CLIPOBJ* in/out
    prclExtra As IntPtr,   ' RECTL* in/out
    prclOpaque As IntPtr,   ' RECTL* in/out
    pboFore As IntPtr,   ' BRUSHOBJ* in/out
    pboOpaque As IntPtr,   ' BRUSHOBJ* in/out
    pptlOrg As IntPtr,   ' POINTL* in/out
    mix As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pso : SURFOBJ* in/out
' pstro : STROBJ* in/out
' pfo : FONTOBJ* in/out
' pco : CLIPOBJ* in/out
' prclExtra : RECTL* in/out
' prclOpaque : RECTL* in/out
' pboFore : BRUSHOBJ* in/out
' pboOpaque : BRUSHOBJ* in/out
' pptlOrg : POINTL* in/out
' mix : DWORD
Declare PtrSafe Function EngTextOut Lib "gdi32" ( _
    ByVal pso As LongPtr, _
    ByVal pstro As LongPtr, _
    ByVal pfo As LongPtr, _
    ByVal pco As LongPtr, _
    ByVal prclExtra As LongPtr, _
    ByVal prclOpaque As LongPtr, _
    ByVal pboFore As LongPtr, _
    ByVal pboOpaque As LongPtr, _
    ByVal pptlOrg 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

EngTextOut = ctypes.windll.gdi32.EngTextOut
EngTextOut.restype = wintypes.BOOL
EngTextOut.argtypes = [
    ctypes.c_void_p,  # pso : SURFOBJ* in/out
    ctypes.c_void_p,  # pstro : STROBJ* in/out
    ctypes.c_void_p,  # pfo : FONTOBJ* in/out
    ctypes.c_void_p,  # pco : CLIPOBJ* in/out
    ctypes.c_void_p,  # prclExtra : RECTL* in/out
    ctypes.c_void_p,  # prclOpaque : RECTL* in/out
    ctypes.c_void_p,  # pboFore : BRUSHOBJ* in/out
    ctypes.c_void_p,  # pboOpaque : BRUSHOBJ* in/out
    ctypes.c_void_p,  # pptlOrg : POINTL* in/out
    wintypes.DWORD,  # mix : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('GDI32.dll')
EngTextOut = Fiddle::Function.new(
  lib['EngTextOut'],
  [
    Fiddle::TYPE_VOIDP,  # pso : SURFOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pstro : STROBJ* in/out
    Fiddle::TYPE_VOIDP,  # pfo : FONTOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pco : CLIPOBJ* in/out
    Fiddle::TYPE_VOIDP,  # prclExtra : RECTL* in/out
    Fiddle::TYPE_VOIDP,  # prclOpaque : RECTL* in/out
    Fiddle::TYPE_VOIDP,  # pboFore : BRUSHOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pboOpaque : BRUSHOBJ* in/out
    Fiddle::TYPE_VOIDP,  # pptlOrg : POINTL* in/out
    -Fiddle::TYPE_INT,  # mix : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "gdi32")]
extern "system" {
    fn EngTextOut(
        pso: *mut SURFOBJ,  // SURFOBJ* in/out
        pstro: *mut STROBJ,  // STROBJ* in/out
        pfo: *mut FONTOBJ,  // FONTOBJ* in/out
        pco: *mut CLIPOBJ,  // CLIPOBJ* in/out
        prclExtra: *mut RECTL,  // RECTL* in/out
        prclOpaque: *mut RECTL,  // RECTL* in/out
        pboFore: *mut BRUSHOBJ,  // BRUSHOBJ* in/out
        pboOpaque: *mut BRUSHOBJ,  // BRUSHOBJ* in/out
        pptlOrg: *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 EngTextOut(IntPtr pso, IntPtr pstro, IntPtr pfo, IntPtr pco, IntPtr prclExtra, IntPtr prclOpaque, IntPtr pboFore, IntPtr pboOpaque, IntPtr pptlOrg, uint mix);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_EngTextOut' -Namespace Win32 -PassThru
# $api::EngTextOut(pso, pstro, pfo, pco, prclExtra, prclOpaque, pboFore, pboOpaque, pptlOrg, mix)

#uselib "GDI32.dll"
#func global EngTextOut "EngTextOut" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EngTextOut varptr(pso), varptr(pstro), varptr(pfo), varptr(pco), varptr(prclExtra), varptr(prclOpaque), varptr(pboFore), varptr(pboOpaque), varptr(pptlOrg), mix   ; 戻り値は stat
; pso : SURFOBJ* in/out -> "sptr"
; pstro : STROBJ* in/out -> "sptr"
; pfo : FONTOBJ* in/out -> "sptr"
; pco : CLIPOBJ* in/out -> "sptr"
; prclExtra : RECTL* in/out -> "sptr"
; prclOpaque : RECTL* in/out -> "sptr"
; pboFore : BRUSHOBJ* in/out -> "sptr"
; pboOpaque : BRUSHOBJ* in/out -> "sptr"
; pptlOrg : POINTL* in/out -> "sptr"
; mix : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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