IDWriteTextLayout::HitTestPoint メソッド

アプリケーションは、レイアウト ボックスの左上を基準とした特定のピクセル位置を渡すこの関数を呼び出し、ヒット テストが実行されたテキスト文字列の対応するヒット テスト メトリックに関する情報を取得します。指定されたピクセル位置がテキスト文字列の外部にある場合、関数によって *isInside という出力値が FALSE に設定されます。

構文

virtual HRESULT HitTestPoint(
         FLOAT  pointX,
         FLOAT  pointY,
  [out]  BOOL * isTrailingHit,
  [out]  BOOL * isInside,
  [out]  DWRITE_HIT_TEST_METRICS * hitTestMetrics
) = 0;

パラメーター

• pointX
  レイアウト ボックスの左上を基準とした、ヒット テストを実行するピクセル位置 X。

• pointY
  レイアウト ボックスの左上を基準とした、ヒット テストを実行するピクセル位置 Y。

• isTrailingHit [out]
  ヒット テストの位置が文字の前方または後方であるかどうかを示す出力フラグ。*isInside という出力値が FALSE に設定されている場合、この値は hitTestMetrics->textPosition という出力値に従って設定され、ヒット テストの位置に最も近い端を表します。

• isInside [out]
  ヒット テストの位置がテキスト文字列の内部であるかどうかを示す出力フラグ。FALSE の場合、テキストの端に最も近い位置が返されます。

• hitTestMetrics [out]
  ヒット テストの位置を完全に囲む出力ジオメトリ。*isInside という出力値が FALSE に設定されている場合、この構造体はヒット テストの位置に最も近い端を囲むジオメトリを表します。

戻り値

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

要件

参照

IDWriteTextLayout