Win32 API 日本語リファレンス
ホームDevices.Display › STROBJ

STROBJ

構造体
サイズx64: 48 バイト / x86: 36 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
cGlyphsDWORD4+0+0STROBJ 内のグリフ数を指定します。
flAccelDWORD4+4+4

アクセラレーターフラグです。このメンバーには次のいずれかの値を指定できます:

SO_BREAK_EXTRA

すべてのブレーク文字に固定幅の間隔が追加されます。

SO_CHARACTER_EXTRA

連続する 2 つのグリフの間ごとに固定幅の間隔が追加されます。

SO_CHAR_INC_EQUAL_BM_BASE

間隔はビットマップのサイズによって決定されます。ここでのビットマップの基準 (base) は、水平方向の場合は cx、垂直方向の場合は cy と定義されます。このビットが設定されている場合、フォント内のすべてのグリフについて、ビットマップ (GDI が GLYPHBITS 構造体で提供します) の基準がそのグリフのアドバンス幅と等しくなります。ただし、これはそのフォントが固定ピッチフォントであることを意味するものではありません。(PATHOBJ では使用されません。)

SO_DO_NOT_SUBSTITUTE_DEVICE_FONT

プリンタードライバーは、GDI が選択したフォントを自身のプリンターフォントで置き換えるべきではありません。

SO_DXDY

グリフは任意の位置に描画されます。

SO_ESC_NOT_ORIENT

グリフの向き (orientation) がエスケープメント方向と異なります。エスケープメントとは、テキストの方向が水平方向となす角度です。向きとは、グリフのベースラインとエスケープメント方向との間の角度です。

SO_FLAG_DEFAULT_PLACEMENT

文字の配置に既定の増分ベクトルが使用されます。

SO_GLYPHINDEX_TEXTOUT

pwszOrg は Unicode 配列ではなく、グリフインデックスの配列を指します。

SO_HORIZONTAL

テキストは水平方向です。SO_REVERSED に応じて、左から右または右から左になります。y 座標は文字列の最初のグリフに対してのみ提供されます。

SO_MAXEXT_EQUAL_BM_SIDE

ビットマップの幅が同一です。ここでのビットマップの辺 (side) は、水平方向の場合は cy、垂直方向の場合は cx と定義されます。このフラグは、フォント内のすべてのグリフが、アセンダーとディセンダーの合計に等しい同じ辺を持つことを保証します。ただし、このビットは辺が一定であること以上のことを示します。水平方向の場合、このビットはさらに、すべてのグリフについて、グリフのビットマップの上端と文字原点との垂直方向の距離がアセンダーと等しいことを示します。垂直方向の場合、このビットは、グリフの原点とグリフのビットマップの「上端」(y 軸の正の方向と負の方向のどちらに向かって描画するかによって、実際には右または左になります) との水平方向の距離がアセンダーと等しいことを示します。いずれの場合も、すべてのグリフビットマップの上端と下端は、描画方向に沿って同一の線上に並びます。(PATHOBJ では使用されません。)

SO_REVERSED

水平方向が右から左、または垂直方向が下から上の場合に設定されます。

SO_VERTICAL

テキストは垂直方向です。SO_REVERSED に応じて、上から下または下から上になります。x 座標は文字列の最初のグリフに対してのみ提供されます。

SO_ZERO_BEARINGS

すべてのグリフの A 間隔および C 間隔が 0 です。このビットは、グリフのブラックボックスが重ならないことを保証します。

ulCharIncDWORD4+8+8フォントが固定ピッチ (等幅) フォントであるかどうかを指定します。固定ピッチである場合、このメンバーはグリフのアドバンス幅 (ピクセル単位) と等しくなります。それ以外の場合は 0 です。このメンバーが 0 以外の場合、GDI は文字列の最初の文字に対してのみ有効な座標を提供します。それ以外のすべての文字位置は、描画方向に沿ってこのメンバーの値を順次加算することによって、ドライバーが生成しなければなりません。
rclBkGroundRECTL16+12+12文字列の境界ボックスを表す RECTL 構造体を指定します。
pgpGLYPHPOS*8/4+32+28文字列全体に対する GLYPHPOS 配列へのポインターです。NULL になる場合があります (後述の 解説 セクションを参照してください)。
pwszOrgLPWSTR8/4+40+32元の Unicode 文字列、または cGlyphs 個の文字へのポインターです。名前とは異なり、この文字列は通常 null 終端されていません。また、この文字列が常に有効であるとは限りません。たとえばプリンターフォントを使用したジャーナリングの場合がそれに当たり、その場合このパラメーターは NULL になります。

公式ドキュメント

STROBJ クラス (テキスト文字列オブジェクト) は、デバイスドライバーのためにグリフハンドルと位置の列挙を保持します。

解説(Remarks)

ドライバーは STROBJ_vEnumStartSTROBJ_bEnum を呼び出すことで、文字列内のグリフの識別情報と位置を取得できます。pgpNULL でない場合、それは文字列全体を表す GLYPHPOS 配列を指しており、STROBJ_bEnum の呼び出しは 1 回だけで済みます。pgpNULL の場合は、文字列のすべてのグリフ位置を取得するために、STROBJ_bEnum をループ内で繰り返し呼び出す必要があります。

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

各言語での定義

#include <windows.h>

// RECTL  (x64 16 / x86 16 バイト)
typedef struct RECTL {
    INT left;
    INT top;
    INT right;
    INT bottom;
} RECTL;

// STROBJ  (x64 48 / x86 36 バイト)
typedef struct STROBJ {
    DWORD cGlyphs;
    DWORD flAccel;
    DWORD ulCharInc;
    RECTL rclBkGround;
    GLYPHPOS* pgp;
    LPWSTR pwszOrg;
} STROBJ;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct RECTL
{
    public int left;
    public int top;
    public int right;
    public int bottom;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct STROBJ
{
    public uint cGlyphs;
    public uint flAccel;
    public uint ulCharInc;
    public RECTL rclBkGround;
    public IntPtr pgp;
    public IntPtr pwszOrg;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure RECTL
    Public left As Integer
    Public top As Integer
    Public right As Integer
    Public bottom As Integer
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure STROBJ
    Public cGlyphs As UInteger
    Public flAccel As UInteger
    Public ulCharInc As UInteger
    Public rclBkGround As RECTL
    Public pgp As IntPtr
    Public pwszOrg As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class RECTL(ctypes.Structure):
    _fields_ = [
        ("left", ctypes.c_int),
        ("top", ctypes.c_int),
        ("right", ctypes.c_int),
        ("bottom", ctypes.c_int),
    ]

class STROBJ(ctypes.Structure):
    _fields_ = [
        ("cGlyphs", wintypes.DWORD),
        ("flAccel", wintypes.DWORD),
        ("ulCharInc", wintypes.DWORD),
        ("rclBkGround", RECTL),
        ("pgp", ctypes.c_void_p),
        ("pwszOrg", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct RECTL {
    pub left: i32,
    pub top: i32,
    pub right: i32,
    pub bottom: i32,
}

#[repr(C)]
pub struct STROBJ {
    pub cGlyphs: u32,
    pub flAccel: u32,
    pub ulCharInc: u32,
    pub rclBkGround: RECTL,
    pub pgp: *mut core::ffi::c_void,
    pub pwszOrg: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type RECTL struct {
	left int32
	top int32
	right int32
	bottom int32
}

type STROBJ struct {
	cGlyphs uint32
	flAccel uint32
	ulCharInc uint32
	rclBkGround RECTL
	pgp uintptr
	pwszOrg uintptr
}
type
  RECTL = record
    left: Integer;
    top: Integer;
    right: Integer;
    bottom: Integer;
  end;

  STROBJ = record
    cGlyphs: DWORD;
    flAccel: DWORD;
    ulCharInc: DWORD;
    rclBkGround: RECTL;
    pgp: Pointer;
    pwszOrg: Pointer;
  end;
const RECTL = extern struct {
    left: i32,
    top: i32,
    right: i32,
    bottom: i32,
};

const STROBJ = extern struct {
    cGlyphs: u32,
    flAccel: u32,
    ulCharInc: u32,
    rclBkGround: RECTL,
    pgp: ?*anyopaque,
    pwszOrg: ?*anyopaque,
};
type
  RECTL {.bycopy.} = object
    left: int32
    top: int32
    right: int32
    bottom: int32

  STROBJ {.bycopy.} = object
    cGlyphs: uint32
    flAccel: uint32
    ulCharInc: uint32
    rclBkGround: RECTL
    pgp: pointer
    pwszOrg: pointer
struct RECTL
{
    int left;
    int top;
    int right;
    int bottom;
}

struct STROBJ
{
    uint cGlyphs;
    uint flAccel;
    uint ulCharInc;
    RECTL rclBkGround;
    void* pgp;
    void* pwszOrg;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; STROBJ サイズ: 36 バイト(x86)
dim st, 9    ; 4byte整数×9(構造体サイズ 36 / 4 切り上げ)
; cGlyphs : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; flAccel : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ulCharInc : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; rclBkGround : RECTL (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; pgp : GLYPHPOS* (+28, 4byte)  varptr(st)+28 を基点に操作(4byte:入れ子/配列)
; pwszOrg : LPWSTR (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; STROBJ サイズ: 48 バイト(x64)
dim st, 12    ; 4byte整数×12(構造体サイズ 48 / 4 切り上げ)
; cGlyphs : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; flAccel : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; ulCharInc : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; rclBkGround : RECTL (+12, 16byte)  varptr(st)+12 を基点に操作(16byte:入れ子/配列)
; pgp : GLYPHPOS* (+32, 8byte)  varptr(st)+32 を基点に操作(8byte:入れ子/配列)
; pwszOrg : LPWSTR (+40, 8byte)  qpoke st,40,値 / qpeek(st,40)  ※IronHSPのみ。3.7/3.8は lpoke st,40,下位 : lpoke st,44,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global RECTL
    #field int left
    #field int top
    #field int right
    #field int bottom
#endstruct

#defstruct global STROBJ
    #field int cGlyphs
    #field int flAccel
    #field int ulCharInc
    #field RECTL rclBkGround
    #field intptr pgp
    #field intptr pwszOrg
#endstruct

stdim st, STROBJ        ; NSTRUCT 変数を確保
st->cGlyphs = 100
mes "cGlyphs=" + st->cGlyphs