IDWriteTextLayout::HitTestPoint メソッド (dwrite.h)
アプリケーションは、レイアウト ボックスの左上の位置を基準にして特定のピクセル位置を渡してこの関数を呼び出し、ヒット テストが発生したテキスト文字列の対応するヒット テスト メトリックに関する情報を取得します。 指定したピクセル位置がテキスト文字列の外側にある場合、関数は出力値 *isInside を FALSE に設定 します。
構文
HRESULT HitTestPoint(
FLOAT pointX,
FLOAT pointY,
[out] BOOL *isTrailingHit,
[out] BOOL *isInside,
[out] DWRITE_HIT_TEST_METRICS *hitTestMetrics
);
パラメーター
pointX
型: FLOAT
ヒット テストするピクセル位置 X。レイアウト ボックスの左上の位置に対する相対位置。
pointY
型: FLOAT
レイアウト ボックスの左上の位置を基準とした、ヒット テストするピクセル位置 Y。
[out] isTrailingHit
種類: BOOL*
ヒット テストの場所が文字の先頭側か末尾側かを示す出力フラグ。 出力 *isInside 値が FALSE に設定されている場合、この値は、ヒット テストの場所に最も近いエッジを表す出力 hitTestMetrics-textPosition> 値に従って設定されます。
[out] isInside
種類: BOOL*
ヒット テストの場所がテキスト文字列内にあるかどうかを示す出力フラグ。 FALSE の場合、テキストの端に最も近い位置が返されます。
[out] hitTestMetrics
ヒット テストの場所を完全に囲む出力ジオメトリ。 出力 *isInside 値が FALSE に設定されている場合、この構造体は、ヒット テストの場所に最も近いエッジを囲むジオメトリを表します。
戻り値
種類: HRESULT
このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 7、Windows Vista SP2 および Windows Vista 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2008 R2、Windows Server 2008 SP2 および Windows Server 2008 用プラットフォーム更新プログラム [デスクトップ アプリ |UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | dwrite.h |
Library | Dwrite.lib |
[DLL] | Dwrite.dll |