SpriteBatch.DrawString Method (SpriteFont, StringBuilder, Vector2, Color, Single, Vector2, Single, SpriteEffects, Single)
Adds a mutable sprite string to the batch of sprites to be rendered, specifying the font, output text, screen position, color tint, rotation, origin, scale, and effects.
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)
public void DrawString ( SpriteFont spriteFont, StringBuilder text, Vector2 position, Color color, float rotation, Vector2 origin, float scale, SpriteEffects effects, float layerDepth )
- The sprite font.
- The mutable (read/write) string to draw.
- The location, in screen coordinates, where the text will be drawn.
- The desired color of the text.
- The angle, in radians, to rotate the text around the origin.
- The origin of the string. Specify (0,0) for the upper-left corner.
- Uniform multiple by which to scale the sprite width and height.
- Rotations to apply prior to rendering.
- The sorting depth of the sprite, between 0 (front) and 1 (back).
|ArgumentException||There is a character in text that was not imported by the SpriteFont. You must include all the characters in the character regions in the sprite font file. For more information, see How To: Extend the Font Description Processor to Support Additional Characters.|
|ArgumentNullException||spriteFont or text is null.|
|InvalidOperationException||DrawString was called, but Begin has not yet been called. Begin must be called successfully before DrawString can be called.|
Use a newline character (\n) to draw more than one line of text.