SpriteBatch.DrawString Method (SpriteFont, String, Vector2, Color, Single, Vector2, Single, SpriteEffects, Single)

Adds a sprite string to the batch of sprites to be rendered, specifying the font, output text, screen position, color tint, rotation, origin, scale, and effects.

Namespace: Microsoft.Xna.Framework.Graphics
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

Syntax

public void DrawString (
         SpriteFont spriteFont,
         string text,
         Vector2 position,
         Color color,
         float rotation,
         Vector2 origin,
         float scale,
         SpriteEffects effects,
         float layerDepth
)

Parameters

• spriteFont
  The sprite font.
• text
  The string to draw.
• position
  The location, in screen coordinates, where the text will be drawn.
• color
  The desired color of the text.
• rotation
  The angle, in radians, to rotate the text around the origin.
• origin
  The origin of the string. Specify (0,0) for the upper-left corner.
• scale
  Uniform multiple by which to scale the sprite width and height.
• effects
  Rotations to apply prior to rendering.
• layerDepth
  The sorting depth of the sprite, between 0 (front) and 1 (back).

Exceptions

Exception type	Condition
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.

Remarks

SpriteFont objects are loaded from the Content Manager. See the SpriteFont class for more information.

Before any calls to DrawString, you must call Begin. Once all calls to DrawString are complete, call End.

Use a newline character (\n) to draw more than one line of text.

See Also

Tasks

How to: Draw Text

Concepts

2D Graphics Overview

Reference

SpriteBatch Class
SpriteBatch Members
Microsoft.Xna.Framework.Graphics Namespace

Platforms

Xbox 360, Windows XP SP2, Windows Vista