Win32 API 日本語リファレンス
ホームGraphics.DirectWrite › IDWriteFontFileStream

IDWriteFontFileStream

COM
IID6d4865fe-0ab8-4d91-8f62-5dd6be34a3e0継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

カスタムフォントファイルローダーからフォントファイルデータを読み込みます。

メソッド 4

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT ReadFileFragment(void** fragmentStart, ULONGLONG fileOffset, ULONGLONG fragmentSize, void** fragmentContext)

フォントファイルからフラグメントを読み取ります。

fragmentStartvoid**outこのメソッドが返るとき、フォントファイルフラグメントの先頭を指すポインターのアドレスが格納されます。このパラメーターは初期化されていない状態で渡されます。
fileOffsetULONGLONGinフォントファイルの先頭からのフラグメントのオフセット(バイト単位)。
fragmentSizeULONGLONGinファイルフラグメントのサイズ(バイト単位)。
fragmentContextvoid**outこのメソッドが返るとき、ReleaseFileFragment に渡されるクライアント定義のコンテキストへのポインターを指すポインターのアドレスが格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

ReadFileFragment の実装では、要求されたフォントファイルフラグメントがファイルの範囲内にあるかどうかを確認する必要があることに注意してください。範囲内にない場合は、ReadFileFragment からエラーを返す必要があります。

DirectWrite は、IDWriteFontFileStream のメソッドを、複数のスレッドから同一オブジェクトに対して同時に呼び出す場合があります。そのため、内部の可変状態に依存する ReadFileFragment の実装では、複数のスレッド間でその状態へのアクセスを直列化する必要があります。たとえば、Seek と Read の各操作を分けてファイルフラグメントを読み取る実装では、Seek と Read の呼び出しを含むコードブロックをロックまたはクリティカルセクションの下に置く必要があります。

vtbl 4 void ReleaseFileFragment(void* fragmentContext)

ファイルからフラグメントを解放します。

fragmentContextvoid*inoutReadFileFragment から返されたフォントフラグメントのクライアント定義コンテキストへのポインター。
vtbl 5 HRESULT GetFileSize(ULONGLONG* fileSize)

ファイルの合計サイズを取得します。

fileSizeULONGLONG*outこのメソッドが返るとき、ファイルの合計サイズが格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

非同期に読み込まれるフォントファイルに対して GetFileSize() を実装する場合、ファイルの全内容をダウンロードする必要が生じることがあります。そのため、このメソッドは、フォントファイル全体の読み込みを必要とする操作(たとえばフォントファイルのコピー)や、ファイルサイズの値に基づいて判断を行う必要がある操作(たとえば保存されたファイルサイズとの検証)にのみ使用してください。

vtbl 6 HRESULT GetLastWriteTime(ULONGLONG* lastWriteTime)

ファイルの最終更新日時を取得します。

lastWriteTimeULONGLONG*outこのメソッドが返るとき、1601 年 1 月 1 日(UTC)からの 100 ナノ秒間隔の数を表す形式で、ファイルの最終更新日時が格納されます。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

「最終更新日時」は、DirectWrite のフォント選択アルゴリズムによって、あるフォントリソースが別のフォントリソースよりも新しいかどうかを判断するために使用されます。

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

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IDWriteFontFileStream "{6D4865FE-0AB8-4D91-8F62-5DD6BE34A3E0}"
#usecom global IDWriteFontFileStream IID_IDWriteFontFileStream "{}"
#comfunc global IDWriteFontFileStream_ReadFileFragment     3 sptr,int64,int64,sptr
#comfunc global IDWriteFontFileStream_ReleaseFileFragment  4 sptr
#comfunc global IDWriteFontFileStream_GetFileSize          5 var
#comfunc global IDWriteFontFileStream_GetLastWriteTime     6 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。