英数字を表示させる

لا تعتمد الصفحة التي تعرضها حاليًا لغة العرض المحددة. ×

概要

画面上に任意の文字列(英数字)を表示させます。

動作環境

必須環境

動作確認環境

内容

XNA で文字を表示させるには「スプライトフォント」というフォントの情報を記述したファイルが必要になります。拡張子は「.spritefont」です。スプライトフォントファイルは XML を拡張させた形式で記述されているので手軽に書き換えることができます。スプライトフォントは以下のようにして作成します。

Content プロジェクトを右クリックし「追加」→「新しい項目」をクリックします。

「新しい項目の追加」ダイアログが開きます。

インストールされたテンプレートに「Sprite Font」という項目があるのでそれを選択します。

ファイル名を指定しますが、ここでは「Font.spritefont」という名前にしています。基本的には任意の名前を設定してかまいません。

入力したら右下の「追加」ボタンを押します。

ファイルを作成すると、スプライトフォントファイルが開かれた状態になります。

コンテンツプロジェクトにも追加されています。

スプライトフォントの中身はデフォルトのままでも構いませんが、今回は下記のように書き換えています(わかりやすいようにコメントも日本語化しています)。各ノードの説明はコメントを参照して下さい。

また、スプライトフォントの詳しい説明については「フォントスタイルの詳細」の項で説明しています。

<?xml version="1.0" encoding="utf-8"?>
<!-- 文字の描画に使用するフォントの名前やサイズなどの情報を記述します。 -->
<XnaContent xmlns:Graphics="Microsoft.Xna.Framework.Content.Pipeline.Graphics">
  <Asset Type="Graphics:FontDescription">

    <!--
      使用するフォント名。
    -->
    <FontName>メイリオ</FontName>

    <!--
      文字のサイズ。浮動小数点も可。単位はバックバッファ内でのピクセル単位。
    -->
    <Size>18</Size>

    <!--
      文字間の幅。単位はバックバッファ内でのピクセル単位。
    -->
    <Spacing>0</Spacing>

    <!--
      カーニングを使用するかどうか。
    -->
    <UseKerning>true</UseKerning>

    <!--
      文字スタイル。通常は"Regular"、太文字は"Bold", イタリックは"Italic"
      "Bold, Italic"と記述することで複数のスタイルを指定可能。
    -->
    <Style>Regular</Style>

    <!--
      キャラクターリージョンで指定した文字次回の文字が描画されようとしたときに
      代わりに表示する文字を指定します。ASCII 以外の Unicode 文字も可。
    -->
    <DefaultCharacter>*</DefaultCharacter>

    <!--
      キャラクターリージョン。使う文字の範囲をUnicodeで指定します。
      32(ASCIIのスペース)から126('~')の英数字を指定しています。(10進数)
    -->
    <CharacterRegions>
      <CharacterRegion>
        <Start>&#32;</Start>
        <End>&#126;</End>
      </CharacterRegion>
    </CharacterRegions>
  </Asset>
</XnaContent>

続いてテキストを描画するためのプログラムについて説明します。

/// <summary>
/// スプライトのバッチ化クラス
/// </summary>
private SpriteBatch spriteBatch = null;

/// <summary>
/// スプライトでテキストを描画するためのフォント
/// </summary>
private SpriteFont font = null;

テキストを描画するには「SpriteBatch」と「SpriteFont」の２つのクラスを使用します。テキストはスプライトとして描画することになります。

/// <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」のインスタンスを作成します。

// スプライトの描画準備
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 メソッドの第１引数に、作成した「SpriteFont」クラスを指定します。これによってスプライトフォントで指定したスタイルで文字を描画することができます。第２引数には表示させる文字列を指定します。

SpriteBatch.Begin メソッド

スプライトを描画する前に呼び出しておきます。内部ではスプライトの描画に必要な設定を行っています。

SpriteBatch.DrawString メソッド

文字列を描画します。

SpriteBatch.End メソッド

バッチ化したスプライトをすべて描画します。描画順序や描画ステートなどは SpriteBatch.Begin メソッドで指定されたものが使用されます。必要に応じてレンダリングステートが SpriteBatch.Begin メソッドを呼び出す前の状態に戻ります。

パソコンなどで使用するディスプレイなどでは問題ないのですが、Xbox 360 からアナログテレビに出力した場合、左上に表示したテキストが見えない場合があります。この場合は文字の表示位置を調整しなければいけないのですが、それについては「文字を描画する位置を指定」で説明します。

今回のサンプルで注意すべき点は、日本語の文字を表示できないことです。SpriteBatch.DrawString メソッドに日本語を指定すると例外が発生してしまいます。今回表示できる文字列は Unicode で指定されている 32～126 番で定義されている英数字と記号だけです。日本語の表示の仕方については別の Tips で紹介したいと思います。

Unicode 表 (32～127)

(行の数値×16＋列の数値)がコードになります。

全コード

using System;
using System.Collections.Generic;
using System.Linq;
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.Media;
#if WINDOWS_PHONE
using Microsoft.Xna.Framework.Input.Touch;
#endif

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";

#if WINDOWS_PHONE
            // Windows Phone のデフォルトのフレームレートは 30 FPS
            this.TargetElapsedTime = TimeSpan.FromTicks(333333);

            // バックバッファサイズの設定
            this.graphics.PreferredBackBufferWidth = 480;
            this.graphics.PreferredBackBufferHeight = 800;

            // フルスクリーン表示
            this.graphics.IsFullScreen = true;
#endif
        }

        /// <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)
        {
            // Xbox 360 コントローラ、Windows Phone の 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);
        }
    }
}