ID3DX10Font::D rawText メソッド
書式設定されたテキストを描画します。 このメソッドは、ANSI 文字列と Unicode 文字列をサポートしています。
構文
INT DrawText(
[in] LPD3DX10SPRITE pSprite,
[in] LPCTSTR pString,
[in] INT Count,
[in] LPRECT pRect,
[in] UINT Format,
[in] D3DXCOLOR Color
);
パラメーター
-
pSprite [in]
-
種類: LPD3DX10SPRITE
描画する文字列を含む ID3DX10Sprite オブジェクトへのポインター。 NULL を指定できます。この場合、Direct3D は独自のスプライト オブジェクトを使用して文字列をレンダリングします。 効率を向上させるために、ID3DX10Font::D rawText を 1 行に複数回呼び出す場合は、スプライト オブジェクトを指定する必要があります。
-
pString [in]
-
型: LPCTSTR
描画する文字列へのポインター。 UNICODE が定義されている場合、このパラメーター型は LPCWSTR に解決されます。それ以外の場合、型は LPCSTR に解決されます。 Count パラメーターが -1 の場合、文字列は NULL で終了する必要があります。
-
Count [in]
-
型: INT
文字列の文字数。 Count が -1 の場合、pString パラメーターは NULL で終わる文字列を含むスプライトへのポインターであると見なされ、ID3DX10Font::D rawText は文字数を自動的に計算します。
-
pRect [in]
-
型: LPRECT
テキストを書式設定する論理座標の四角形を含む RECT 構造体へのポインター。 RECT オブジェクトと同様に、四角形の右側の座標値は、左側の座標値よりも大きくする必要があります。 同様に、下の座標値は上の座標値よりも大きくする必要があります。
-
書式 [in]
-
型: UINT
テキストの書式設定方法を指定します。 次の値の任意の組み合わせを指定できます。
項目 説明 DT_BOTTOM テキストを四角形の下部に揃える。 この値は、DT_SINGLELINEと組み合わせる必要があります。 DT_CALCRECT 描画するように指定した文字列の長さに基づいて、四角形の幅と高さを自動的に計算するように DrawText に指示します。 複数行のテキストがある場合、ID3DX10Font::D rawText は pRect パラメーターが指す四角形の幅を使用し、四角形の底を拡張してテキストの最後の行を連結します。 テキストが 1 行しかない場合、ID3DX10Font::D rawText は四角形の右側を変更して、行の最後の文字をバインドします。 どちらの場合も、ID3DX10Font::D rawText は書式設定されたテキストの高さを返しますが、テキストは描画しません。 DT_CENTER 四角形内のテキストを水平方向に中央揃えします。 DT_EXPANDTABS タブ文字を展開します。 タブごとの既定の文字数は 8 文字です。 DT_LEFT テキストを左揃えにします。 DT_NOCLIP クリッピングなしで描画します。 ID3DX10Font::D rawText は、DT_NOCLIPを使用するとやや高速になります。 DT_RIGHT テキストを右揃えにします。 DT_RTLREADING ヘブライ語またはアラビア語のフォントが選択されている場合は、双方向テキストのテキストを右から左に読み取る順序で表示します。 すべてのテキストの既定の読み取り順序は左から右です。 DT_SINGLELINE 1 行のみにテキストを表示します。 復帰と改行は改行されません。 DT_TOP テキストを上揃えします。 DT_VCENTER テキストの垂直方向の中央揃え (1 行のみ)。 DT_WORDBREAK 単語を区切ります。 単語が pRect パラメーターで指定された四角形の端を越えると、単語間の線が自動的に分割されます。 復帰/改行シーケンスも改行します。 -
Color [in]
-
種類: D3DXCOLOR
テキストの色。 「D3DXCOLOR」を参照してください。
戻り値
型: INT
関数が成功した場合、戻り値は論理単位でのテキストの高さになります。 DT_VCENTERまたはDT_BOTTOMが指定されている場合、戻り値は描画されたテキストの pRect (上から下) からのオフセットになります。 関数が失敗した場合は、0 を返します。
解説
このメソッドのパラメーターは、 GDI DrawText 関数のパラメーターと非常によく似ています。
このメソッドは、ANSI 文字列と Unicode 文字列の両方をサポートします。
DT_NOCLIP形式を使用しない限り、このメソッドは指定した四角形の外側に表示されないようにテキストをクリップします。 DT_SINGLELINE形式を指定しない限り、すべての書式は複数行であると見なされます。
選択したフォントが四角形に対して大きすぎる場合、このメソッドは小さいフォントを置き換えようとしません。
このメソッドは、エスケープメントと方向の両方が 0 であるフォントのみをサポートします。
要件
要件 | 値 |
---|---|
ヘッダー |
|
ライブラリ |
|
関連項目