
※この Tips は XNA Game Studio 2.0 をベースに説明しています。
XNA で文字を表示させるには「スプライトフォント」というフォントの情報を記述したファイルが必要になります。拡張子は「.spritefont」です。スプライトフォントファイルは XML を拡張させた形式で記述されているので手軽に書き換えることができます。スプライトフォントは以下のようにして作成します。
Content フォルダを右クリックし「追加 - 新しい項目」をクリックします。
「新しい項目の追加」ダイアログが開きます。
テンプレートに「Sprite Font」という項目があるのでそれを選択します。
ファイル名を指定しますが、ここでは「Font.spritefont」という名前にしています。基本的には任意の名前を設定してかまいません。
入力したら「追加」ボタンを押します。
ファイルを作成すると、スプライトフォントが開かれた状態になります。
プロジェクトにも追加されています。
作成したスプライトフォントを下のように書き換えています。各ノードの説明はコメントを参照して下さい。
<!-- 文字の描画に使用するフォントの名前やサイズなどの情報を記述します --> <XnaContent xmlns:Graphics="Microsoft.Xna.Framework.Content.Pipeline.Graphics"> <Asset Type="Graphics:FontDescription"> <!-- 使用するフォント名 --> <FontName>MS ゴシック</FontName> <!-- 文字のサイズ。浮動小数点も可。単位はバックバッファ内でのピクセル単位 --> <Size>24</Size> <!-- 文字間の幅。単位はバックバッファ内でのピクセル単位 --> <Spacing>4</Spacing> <!-- カーニングを使用するか --> <UseKerning>false</UseKerning> <!-- 文字スタイル。通常は"Regular"、ボールドは"Bold", イタリックは"Italic" "Bold, Italic"と記述することで複数のスタイルを指定可能 --> <Style>Regular</Style> <!-- キャラクターリージョン。使う文字の範囲をUnicodeで指定します。 32(ASCIIのスペース)から126('~')の英数字を指定しています。(10進数) --> <CharacterRegions> <CharacterRegion> <Start> </Start> <End>~</End> </CharacterRegion> </CharacterRegions> </Asset> </XnaContent>
続いてテキストを描画するためのプログラムについて説明します。
/// <summary> /// スプライトのバッチ化クラス /// </summary> private SpriteBatch spriteBatch = null; /// <summary> /// スプライトでテキストを描画するためのフォント /// </summary> private SpriteFont font = null;
テキストを描画するには「SpriteBatch」と「SpriteFont」の2つのクラスを使用します。テキストはスプライトとして描画することになります。
/// <summary> /// ゲームが始まるときに一回だけ呼ばれ /// すべてのゲームコンテンツを読み込みます /// </summary> protected override void LoadContent() { // テクスチャーを描画するためのスプライトバッチクラスを作成します this.spriteBatch = new SpriteBatch(this.GraphicsDevice); // フォントをコンテンツパイプラインから読み込む this.font = this.Content.Load<SpriteFont>("Font"); }
LoadGraphicsContent メソッド内でまず「SpriteBatch」クラスを作成します。引数には GraphicsDevice を渡します。
続いて ContentManager.Load メソッドを使用して、先ほど作成したスプライトフォントファイルを読み込むようにします。タイプパラメータには「SpriteFont」クラスを指定して、引数にアセット名を指定します。
| SpriteBatch コンストラクタ | ||
|---|---|---|
| スプライトの描画をバッチ化するクラス「SpriteBatch」のインスタンスを作成します。 | ||
| graphicsDevice | GraphicsDevice | 描画に使用する GraphicsDevice を指定します。 |
| MSDN ライブラリの Web ページへリンク | ||
// スプライトの描画準備 this.spriteBatch.Begin(); // テキストをスプライトとして描画する this.spriteBatch.DrawString(this.font, "Draw Sprite in a screen.", Vector2.Zero, Color.White); // スプライトの一括描画 this.spriteBatch.End();
Draw メソッド内でテキストの描画を行います。
テキスト描画には「SpriteBatch.DrawString」メソッドを使用しますが、テキストはスプライトとして描画されるので、描画前と描画後にそれぞれ「SpriteBatch.Begin」メソッドと「SpriteBatch.End」メソッドを呼ぶようにしています。
SpriteBatch.DrawString メソッドの第1引数に、作成した「SpriteFont」クラスを指定します。これによってスプライトフォントで指定したスタイルで文字を描画することができます。第2引数には表示させる文字列を指定します。
| SpriteBatch.Begin メソッド | ||
|---|---|---|
| スプライトを描画する前に呼び出しておきます。内部ではスプライトの描画に必要な設定を行っています。 | ||
| MSDN ライブラリの Web ページへリンク | ||
| SpriteBatch.DrawString メソッド | ||
|---|---|---|
| 文字列を描画します。 | ||
| spriteFont | SpriteFont | 文字列のイメージが格納されている SpriteFont を指定します。 |
| text | string | 表示するテキストを指定します。 |
| position | Vector2 | テキストを表示する位置。スクリーンの左上を基準にしたスクリーン座標で指定します。テキストの原点は最初の文字の左上になります。 |
| color | Color | テキストの色 |
| MSDN ライブラリの Web ページへリンク | ||
| SpriteBatch.End メソッド | ||
|---|---|---|
| バッチ化したスプライトをすべて描画します。描画順序や描画ステートなどは SpriteBatch.Begin メソッドで指定されたものが使用されます。必要に応じてレンダリングステートが SpriteBatch.Begin メソッドを呼び出す前の状態に戻ります。 | ||
| MSDN ライブラリの Web ページへリンク | ||
パソコンなどで使用するディスプレイなどでは問題ないのですが、Xbox 360 からアナログテレビに出力した場合、左上に表示したテキストが見えない場合があります。この場合は文字の表示位置を調整しなければいけないのですが、それについては別の項目で説明します。
今回のプロジェクトで注意すべき点は、日本語の文字を表示できないことです。SpriteBatch.DrawString メソッドに日本語を指定すると例外が発生してしまいます。今回表示できる文字列は Unicode で指定されている 32~126 番で定義されている英数字と記号だけです。日本語の表示の仕方については別の Tips で紹介したいと思います。
(行の数値×16+列の数値)がコードになります。
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2 | ! | " | # | $ | % | & | ' | ( | ) | * | + | , | - | . | / | |
| 3 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | : | ; | < | = | > | ? |
| 4 | @ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O |
| 5 | P | Q | R | S | T | U | V | W | X | Y | Z | [ | \ | ] | ^ | _ |
| 6 | ` | a | b | c | d | e | f | g | h | i | j | k | l | m | n | o |
| 7 | p | q | r | s | t | u | v | w | x | y | z | { | | | } | ~ | |
| ファイル | サイズ | 対応XNAバージョン | プラットフォーム | 作成日 |
|---|---|---|---|---|
| xna_tips_drawalphameric_3_0_exe.zip | 14.6 KB | 3.0 | Windows (XP SP2 以降, Vista) | 2009/01/04 |
| xna_tips_drawalphameric_2_0_exe.zip | 18.0 KB | 2.0 | Windows (XP SP2, Vista) | 2008/01/01 |
| xna_tips_drawalphameric_1_0_ref_exe.zip | 18.2 KB | 1.0 Refresh | Windows (XP SP2, Vista) | 2007/07/14 |
| ファイル | サイズ | 対応XNAバージョン | プラットフォーム | 作成日 |
|---|---|---|---|---|
| xna_tips_drawalphameric_3_0_project.zip | 15.7 KB | 3.0 | Windows (XP SP2 以降, Vista), Xbox 360 | 2009/01/04 |
| xna_tips_drawalphameric_2_0_project.zip | 14.1 KB | 2.0 | Windows (XP SP2, Vista), Xbox 360 | 2008/01/01 |
| xna_tips_drawalphameric_1_0_ref_project.zip | 14.5 KB | 1.0 Refresh | Windows (XP SP2, Vista), Xbox 360 | 2007/07/14 |
using System; using System.Collections.Generic; using Microsoft.Xna.Framework; using Microsoft.Xna.Framework.Audio; using Microsoft.Xna.Framework.Content; using Microsoft.Xna.Framework.GamerServices; using Microsoft.Xna.Framework.Graphics; using Microsoft.Xna.Framework.Input; using Microsoft.Xna.Framework.Net; using Microsoft.Xna.Framework.Storage; namespace DrawAlphameric { /// <summary> /// ゲームメインクラス /// </summary> public class GameMain : Microsoft.Xna.Framework.Game { /// <summary> /// グラフィックデバイス管理クラス /// </summary> private GraphicsDeviceManager graphics = null; /// <summary> /// スプライトのバッチ化クラス /// </summary> private SpriteBatch spriteBatch = null; /// <summary> /// スプライトでテキストを描画するためのフォント /// </summary> private SpriteFont font = null; /// <summary> /// GameMain コンストラクタ /// </summary> public GameMain() { // グラフィックデバイス管理クラスの作成 this.graphics = new GraphicsDeviceManager(this); // ゲームコンテンツのルートディレクトリを設定 this.Content.RootDirectory = "Content"; } /// <summary> /// ゲームが始まる前の初期化処理を行うメソッド /// グラフィック以外のデータの読み込み、コンポーネントの初期化を行う /// </summary> protected override void Initialize() { // TODO: ここに初期化ロジックを書いてください // コンポーネントの初期化などを行います base.Initialize(); } /// <summary> /// ゲームが始まるときに一回だけ呼ばれ /// すべてのゲームコンテ���ツを読み込みます /// </summary> protected override void LoadContent() { // テクスチャーを描画するためのスプライトバッチクラスを作成します this.spriteBatch = new SpriteBatch(this.GraphicsDevice); // フォントをコンテンツパイプラインから読み込む this.font = this.Content.Load<SpriteFont>("Font"); } /// <summary> /// ゲームが終了するときに一回だけ呼ばれ /// すべてのゲームコンテンツをアンロードします /// </summary> protected override void UnloadContent() { // TODO: ContentManager で管理されていないコンテンツを // ここでアンロードしてください } /// <summary> /// 描画以外のデータ更新等の処理を行うメソッド /// 主に入力処理、衝突判定などの物理計算、オーディオの再生など /// </summary> /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param> protected override void Update(GameTime gameTime) { // Xbox360 コントローラの BACK ボタンを押したときにゲームを終了させます if (GamePad.GetState(PlayerIndex.One).Buttons.Back == ButtonState.Pressed) { this.Exit(); } // TODO: ここに更新処理を記述してください // 登録された GameComponent を更新する base.Update(gameTime); } /// <summary> /// 描画処理を行うメソッド /// </summary> /// <param name="gameTime">このメソッドが呼ばれたときのゲーム時間</param> protected override void Draw(GameTime gameTime) { // 画面を指定した色でクリアします this.GraphicsDevice.Clear(Color.CornflowerBlue); // スプライトの描画準備 this.spriteBatch.Begin(); // テキストをスプライトとして描画する this.spriteBatch.DrawString(this.font, "Draw Sprite in a screen.", Vector2.Zero, Color.White); // スプライトの一括描画 this.spriteBatch.End(); // 登録された DrawableGameComponent を描画する base.Draw(gameTime); } } }
| 更新日時 | 更新内容 |
|---|---|
| 2009/01/04 | XNA Game Studio 3.0 のプロジェクト追加 |
| 2008/05/18 | 文章・プログラムの校正 |
| 2008/01/01 | XNA Game Studio 2.0 用に修正 |
| 2007/07/23 | ページ作成 |