ホーム › Globalization › ScriptPositionSingleGlyph

ScriptPositionSingleGlyph

関数

指定OpenType機能で単一グリフの位置を調整する。

DLLUSP10.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT ScriptPositionSingleGlyph(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    DWORD tagScript,
    DWORD tagLangSys,
    DWORD tagFeature,
    INT lParameter,
    WORD wGlyphId,
    INT iAdvance,
    GOFFSET GOffset,
    INT* piOutAdvance,
    GOFFSET* pOutGoffset
);

パラメーター

名前	型	方向	説明
hdc	HDC	inoptional	デバイスコンテキストへのハンドル。詳細については、キャッシュを参照してください。
psc	void**	inout	スクリプトキャッシュを識別する SCRIPT_CACHE 構造体へのポインター。
psa	SCRIPT_ANALYSIS*	inoptional	以前の ScriptItemizeOpenType の呼び出しで取得した SCRIPT_ANALYSIS 構造体へのポインター。この構造体はシェーピングエンジンを識別するため、送り幅を取得できます。あるいは、フィルター処理されていない結果を取得するために、このパラメーターを NULL に設定することもできます。
tagScript	DWORD	in	シェーピング用のスクリプトタグを定義する OPENTYPE_TAG 構造体。
tagLangSys	DWORD	in	シェーピング用の言語タグを定義する OPENTYPE_TAG 構造体。
tagFeature	DWORD	in	代替グリフのシェーピングに使用する機能タグを定義する OPENTYPE_TAG 構造体。
lParameter	INT	in	wGlyphId で指定された識別子に単一置換を適用するかどうかを指定するフラグ。識別子に単一置換機能を適用するには、アプリケーションはこのパラメーターを 1 に設定します。関数がこの機能を適用しないようにするには、パラメーターを 0 に設定します。
wGlyphId	WORD	in	シェーピングされる元のグリフの識別子。
iAdvance	INT	in	元のグリフの送り幅。
GOffset	GOFFSET	in	元のグリフのオフセット。通常、この値は ScriptPlaceOpenType または ScriptPlace の出力です。
piOutAdvance	INT*	out	代替グリフ用に調整された新しい送り幅を、この関数が取得する場所へのポインター。
pOutGoffset	GOFFSET*	out	代替グリフ用に調整された新しいグリフオフセットを、この関数が取得する場所へのポインター。

戻り値の型: HRESULT

公式ドキュメント

OpenType 処理用にフォントが提供する指定された機能を使用して、単一のグリフを単一の調整で配置します。アプリケーションがこの関数を使用するのは、行頭または行末でグリフを視覚的に揃える場合がほとんどです。

戻り値

成功した場合は 0 を返します。成功しなかった場合、この関数は 0 以外の HRESULT 値を返します。アプリケーションは SUCCEEDED および FAILED マクロで戻り値をテストできます。

解説(Remarks)

この関数は、指定されたグリフの送り幅やオフセットを調整することで、個々のグリフを配置します。この関数は、フォントが調整を 1 回だけ必要とすることを前提としています。

この関数の典型的な用途は、特定の文字が与える視覚的な印象を考慮してマージンをわずかに調整することです。たとえばラテン文字では、行頭において、グリフの左側に垂直線を持たない先頭の大文字("T" や "O" など)を左へわずかに調整するのが一般的です。これを行うと厳密な直線的マージンは崩れますが、目にはマージンがより均等であるように見えます。

次の例はこの効果を示しています。最初の例は厳密な配置を示し、続く 2 つの例は先頭の "T" を左へ調整した様子を示しています。調整はそれぞれ 1 ピクセルと 2 ピクセルです。右側の拡大画像は、それぞれの場合で "T" が左マージンへわずかに深く押し込まれていく様子を示しています。

Illustration showing the same block of text three times, with enlargements of each showing slightly different alignment

重要 Windows 8 以降: Windows 7 上で実行できる状態を維持するには、Uniscribe を使用するモジュールは、ライブラリリスト内で gdi32.lib の前に Usp10.lib を指定する必要があります。

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

各言語での呼び出し定義

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

HRESULT ScriptPositionSingleGlyph(
    HDC hdc,   // optional
    void** psc,
    SCRIPT_ANALYSIS* psa,   // optional
    DWORD tagScript,
    DWORD tagLangSys,
    DWORD tagFeature,
    INT lParameter,
    WORD wGlyphId,
    INT iAdvance,
    GOFFSET GOffset,
    INT* piOutAdvance,
    GOFFSET* pOutGoffset
);

[DllImport("USP10.dll", ExactSpelling = true)]
static extern int ScriptPositionSingleGlyph(
    IntPtr hdc,   // HDC optional
    IntPtr psc,   // void** in/out
    IntPtr psa,   // SCRIPT_ANALYSIS* optional
    uint tagScript,   // DWORD
    uint tagLangSys,   // DWORD
    uint tagFeature,   // DWORD
    int lParameter,   // INT
    ushort wGlyphId,   // WORD
    int iAdvance,   // INT
    GOFFSET GOffset,   // GOFFSET
    out int piOutAdvance,   // INT* out
    IntPtr pOutGoffset   // GOFFSET* out
);

<DllImport("USP10.dll", ExactSpelling:=True)>
Public Shared Function ScriptPositionSingleGlyph(
    hdc As IntPtr,   ' HDC optional
    psc As IntPtr,   ' void** in/out
    psa As IntPtr,   ' SCRIPT_ANALYSIS* optional
    tagScript As UInteger,   ' DWORD
    tagLangSys As UInteger,   ' DWORD
    tagFeature As UInteger,   ' DWORD
    lParameter As Integer,   ' INT
    wGlyphId As UShort,   ' WORD
    iAdvance As Integer,   ' INT
    GOffset As GOFFSET,   ' GOFFSET
    <Out> ByRef piOutAdvance As Integer,   ' INT* out
    pOutGoffset As IntPtr   ' GOFFSET* out
) As Integer
End Function

' hdc : HDC optional
' psc : void** in/out
' psa : SCRIPT_ANALYSIS* optional
' tagScript : DWORD
' tagLangSys : DWORD
' tagFeature : DWORD
' lParameter : INT
' wGlyphId : WORD
' iAdvance : INT
' GOffset : GOFFSET
' piOutAdvance : INT* out
' pOutGoffset : GOFFSET* out
Declare PtrSafe Function ScriptPositionSingleGlyph Lib "usp10" ( _
    ByVal hdc As LongPtr, _
    ByVal psc As LongPtr, _
    ByVal psa As LongPtr, _
    ByVal tagScript As Long, _
    ByVal tagLangSys As Long, _
    ByVal tagFeature As Long, _
    ByVal lParameter As Long, _
    ByVal wGlyphId As Integer, _
    ByVal iAdvance As Long, _
    ByVal GOffset As LongPtr, _
    ByRef piOutAdvance As Long, _
    ByVal pOutGoffset As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ScriptPositionSingleGlyph = ctypes.windll.usp10.ScriptPositionSingleGlyph
ScriptPositionSingleGlyph.restype = ctypes.c_int
ScriptPositionSingleGlyph.argtypes = [
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_void_p,  # psc : void** in/out
    ctypes.c_void_p,  # psa : SCRIPT_ANALYSIS* optional
    wintypes.DWORD,  # tagScript : DWORD
    wintypes.DWORD,  # tagLangSys : DWORD
    wintypes.DWORD,  # tagFeature : DWORD
    ctypes.c_int,  # lParameter : INT
    ctypes.c_ushort,  # wGlyphId : WORD
    ctypes.c_int,  # iAdvance : INT
    GOFFSET,  # GOffset : GOFFSET
    ctypes.POINTER(ctypes.c_int),  # piOutAdvance : INT* out
    ctypes.c_void_p,  # pOutGoffset : GOFFSET* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USP10.dll')
ScriptPositionSingleGlyph = Fiddle::Function.new(
  lib['ScriptPositionSingleGlyph'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # psc : void** in/out
    Fiddle::TYPE_VOIDP,  # psa : SCRIPT_ANALYSIS* optional
    -Fiddle::TYPE_INT,  # tagScript : DWORD
    -Fiddle::TYPE_INT,  # tagLangSys : DWORD
    -Fiddle::TYPE_INT,  # tagFeature : DWORD
    Fiddle::TYPE_INT,  # lParameter : INT
    -Fiddle::TYPE_SHORT,  # wGlyphId : WORD
    Fiddle::TYPE_INT,  # iAdvance : INT
    Fiddle::TYPE_VOIDP,  # GOffset : GOFFSET
    Fiddle::TYPE_VOIDP,  # piOutAdvance : INT* out
    Fiddle::TYPE_VOIDP,  # pOutGoffset : GOFFSET* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "usp10")]
extern "system" {
    fn ScriptPositionSingleGlyph(
        hdc: *mut core::ffi::c_void,  // HDC optional
        psc: *mut *mut (),  // void** in/out
        psa: *mut SCRIPT_ANALYSIS,  // SCRIPT_ANALYSIS* optional
        tagScript: u32,  // DWORD
        tagLangSys: u32,  // DWORD
        tagFeature: u32,  // DWORD
        lParameter: i32,  // INT
        wGlyphId: u16,  // WORD
        iAdvance: i32,  // INT
        GOffset: GOFFSET,  // GOFFSET
        piOutAdvance: *mut i32,  // INT* out
        pOutGoffset: *mut GOFFSET  // GOFFSET* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USP10.dll")]
public static extern int ScriptPositionSingleGlyph(IntPtr hdc, IntPtr psc, IntPtr psa, uint tagScript, uint tagLangSys, uint tagFeature, int lParameter, ushort wGlyphId, int iAdvance, GOFFSET GOffset, out int piOutAdvance, IntPtr pOutGoffset);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USP10_ScriptPositionSingleGlyph' -Namespace Win32 -PassThru
# $api::ScriptPositionSingleGlyph(hdc, psc, psa, tagScript, tagLangSys, tagFeature, lParameter, wGlyphId, iAdvance, GOffset, piOutAdvance, pOutGoffset)

#uselib "USP10.dll"
#func global ScriptPositionSingleGlyph "ScriptPositionSingleGlyph" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; ScriptPositionSingleGlyph hdc, psc, varptr(psa), tagScript, tagLangSys, tagFeature, lParameter, wGlyphId, iAdvance, GOffset, varptr(piOutAdvance), varptr(pOutGoffset)   ; 戻り値は stat
; hdc : HDC optional -> "sptr"
; psc : void** in/out -> "sptr"
; psa : SCRIPT_ANALYSIS* optional -> "sptr"
; tagScript : DWORD -> "sptr"
; tagLangSys : DWORD -> "sptr"
; tagFeature : DWORD -> "sptr"
; lParameter : INT -> "sptr"
; wGlyphId : WORD -> "sptr"
; iAdvance : INT -> "sptr"
; GOffset : GOFFSET -> "sptr"
; piOutAdvance : INT* out -> "sptr"
; pOutGoffset : GOFFSET* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USP10.dll"
#cfunc global ScriptPositionSingleGlyph "ScriptPositionSingleGlyph" sptr, sptr, var, int, int, int, int, int, int, int, var, var
; res = ScriptPositionSingleGlyph(hdc, psc, psa, tagScript, tagLangSys, tagFeature, lParameter, wGlyphId, iAdvance, GOffset, piOutAdvance, pOutGoffset)
; hdc : HDC optional -> "sptr"
; psc : void** in/out -> "sptr"
; psa : SCRIPT_ANALYSIS* optional -> "var"
; tagScript : DWORD -> "int"
; tagLangSys : DWORD -> "int"
; tagFeature : DWORD -> "int"
; lParameter : INT -> "int"
; wGlyphId : WORD -> "int"
; iAdvance : INT -> "int"
; GOffset : GOFFSET -> "int"
; piOutAdvance : INT* out -> "var"
; pOutGoffset : GOFFSET* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USP10.dll"
#cfunc global ScriptPositionSingleGlyph "ScriptPositionSingleGlyph" sptr, sptr, sptr, int, int, int, int, int, int, int, sptr, sptr
; res = ScriptPositionSingleGlyph(hdc, psc, varptr(psa), tagScript, tagLangSys, tagFeature, lParameter, wGlyphId, iAdvance, GOffset, varptr(piOutAdvance), varptr(pOutGoffset))
; hdc : HDC optional -> "sptr"
; psc : void** in/out -> "sptr"
; psa : SCRIPT_ANALYSIS* optional -> "sptr"
; tagScript : DWORD -> "int"
; tagLangSys : DWORD -> "int"
; tagFeature : DWORD -> "int"
; lParameter : INT -> "int"
; wGlyphId : WORD -> "int"
; iAdvance : INT -> "int"
; GOffset : GOFFSET -> "int"
; piOutAdvance : INT* out -> "sptr"
; pOutGoffset : GOFFSET* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。