ID3DX10Font::D rawText, méthode

Article
06/13/2023

Dessinez du texte mis en forme. Cette méthode prend en charge les chaînes ANSI et Unicode.

Syntaxe

INT DrawText(
  [in] LPD3DX10SPRITE pSprite,
  [in] LPCTSTR        pString,
  [in] INT            Count,
  [in] LPRECT         pRect,
  [in] UINT           Format,
  [in] D3DXCOLOR      Color
);

Paramètres

pSprite [in]

Type : LPD3DX10SPRITE

Pointeur vers un objet ID3DX10Sprite qui contient la chaîne que vous souhaitez dessiner. Peut être NULL, auquel cas Direct3D restitue la chaîne avec son propre objet sprite. Pour améliorer l’efficacité, un objet sprite doit être spécifié si ID3DX10Font::D rawText doit être appelé plusieurs fois dans une ligne.

pString [in]

Type : LPCTSTR

Pointeur vers une chaîne à dessiner. Si UNICODE est défini, ce type de paramètre est résolu en LPCWSTR. Sinon, le type est résolu en LPCSTR. Si le paramètre Count a la valeur -1, la chaîne doit être terminée par null .

Count [in]

Type : INT

Nombre de caractères dans la chaîne. Si Count a la valeur -1, le paramètre pString est supposé être un pointeur vers un sprite contenant une chaîne terminée par NULL et ID3DX10Font::D rawText calcule automatiquement le nombre de caractères.

pRect [in]

Type : LPRECT

Pointeur vers une structure RECT qui contient le rectangle, en coordonnées logiques, dans lequel le texte doit être mis en forme. Comme pour tout objet RECT, la valeur de coordonnée du côté droit du rectangle doit être supérieure à celle de son côté gauche. De même, la valeur de coordonnée du bas doit être supérieure à celle du haut.

Format [in]

Type : UINT

Spécifiez la méthode de mise en forme du texte. Il peut s’agir de n’importe quelle combinaison des valeurs suivantes :

Élément	Description
DT_BOTTOM	Justifiez le texte en bas du rectangle. Cette valeur doit être combinée avec DT_SINGLELINE.
DT_CALCRECT	Indiquez à DrawText de calculer automatiquement la largeur et la hauteur du rectangle en fonction de la longueur de la chaîne que vous lui demandez de dessiner. S’il existe plusieurs lignes de texte, ID3DX10Font::D rawText utilise la largeur du rectangle vers laquelle pointe le paramètre pRect et étend la base du rectangle pour lier la dernière ligne de texte. S’il n’y a qu’une seule ligne de texte, ID3DX10Font::D rawText modifie le côté droit du rectangle afin qu’il limite le dernier caractère de la ligne. Dans les deux cas, ID3DX10Font::D rawText retourne la hauteur du texte mis en forme, mais ne dessine pas le texte.
DT_CENTER	Centrer le texte horizontalement dans le rectangle.
DT_EXPANDTABS	Développez les caractères de tabulation. Le nombre par défaut de caractères par tabulation est huit.
DT_LEFT	Aligner le texte à gauche.
DT_NOCLIP	Dessiner sans découpage. ID3DX10Font::D rawText est un peu plus rapide lorsque DT_NOCLIP est utilisé.
DT_RIGHT	Aligner le texte à droite.
DT_RTLREADING	Afficher le texte dans l’ordre de lecture de droite à gauche pour le texte bidirectionnel lorsqu’une police hébraïque ou arabe est sélectionnée. L’ordre de lecture par défaut pour tout le texte est de gauche à droite.
DT_SINGLELINE	Afficher le texte sur une seule ligne uniquement. Les retours chariots et les sauts de ligne n’interrompent pas la ligne.
DT_TOP	Texte de justification supérieure.
DT_VCENTER	Centrer le texte verticalement (une seule ligne uniquement).
DT_WORDBREAK	Casser des mots. Les lignes sont automatiquement rompues entre les mots si un mot dépasse le bord du rectangle spécifié par le paramètre pRect. Une séquence de retour chariot/saut de ligne interrompt également la ligne.

Couleur [in]

Type : D3DXCOLOR

Couleur du texte. Consultez D3DXCOLOR.

Valeur retournée

Type : INT

Si la fonction réussit, la valeur de retour est la hauteur du texte en unités logiques. Si DT_VCENTER ou DT_BOTTOM est spécifié, la valeur de retour est le décalage de pRect (de haut en bas) du texte dessiné. Si la fonction échoue, la valeur de retour est égale à zéro.

Notes

Les paramètres de cette méthode sont très similaires à ceux de la fonction GDI DrawText .

Cette méthode prend en charge les chaînes ANSI et Unicode.

Sauf si le format DT_NOCLIP est utilisé, cette méthode clipse le texte afin qu’il n’apparaisse pas en dehors du rectangle spécifié. Toute mise en forme est supposée avoir plusieurs lignes, sauf si le format DT_SINGLELINE est spécifié.

Si la police sélectionnée est trop grande pour le rectangle, cette méthode ne tente pas de remplacer une police plus petite.

Cette méthode prend uniquement en charge les polices dont l’échappement et l’orientation sont tous deux nuls.

Spécifications

Condition requise	Valeur
En-tête	D3DX10.h
Bibliothèque	D3DX10.lib

Voir aussi

ID3DX10Font
D3DX Interfaces

Partager via