前後関係を指定して文字を描画する

Page updated :

The page you are currently viewing does not support the selected display language.

概要

レイヤーの深度値を使用してテキストの前後関係を指定します。下の画面では塗りつぶした矩形を描画しているように見えますが、テキストの重なりがわかりやすいようにフォントサイズを大きくした「◆」を描画しています。

前後関係を指定して文字を描画する

動作環境

必須環境

対応 XNA バージョン
  • 4.0
対応プラットフォーム
  • Windows (XP SP2 以降, Vista, 7)
  • Xbox 360
  • Windows Phone 7
Windows 必須頂点シェーダ バージョン 2.0
Windows 必須ピクセルシェーダ バージョン 2.0

動作確認環境

プラットフォーム
  • Windows 7
  • Xbox 360
  • Windows Phone 7 エミュレーター

内容

通常テキストを描画すると、後に描画したものが手前に来るように描画されますが、深度値を使ってソートすることによって、SpriteBatch.DrawString メソッドの呼び出し順に関係なく前後関係を明確に表示させることができます。

テキストの深度値でソートさせるには「SpriteBatch.Begin」メソッドの第1引数に「SpriteSortMode.BackToFront」を指定するようにします。第2引数には「BlendState」を指定しますが、ここでは既定の null を指定しています。

// 奥から描画するようにソート
this.spriteBatch.Begin(SpriteSortMode.BackToFront, null);

SpriteBatch.Begin メソッド

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

sortMode SpriteSortMode スプライトを描画する際にどの順番で描画するかを SpriteSortMode 列挙から指定します。ここでは深度値を 0.0 が最も手前、1.0 を最も奥として扱っているため、奥にあるスプライトから描画して手前のスプライトで上描きしていくので SpriteSortMode.BackToFront を指定します。
blendState BlendState 描画を行う時に背景との色のブレンド方法を BlendState で指定します。null を指定すると BlendState.AlphaBlend が使用されます。

そしてテキストを描画するときに、SpriteBatch.DrawString メソッドの第9引数に深度値を指定します。ここに設定できる値は 0.0~1.0 の範囲で、0.0 が最も手前、1.0 が最も奥に描画されます。

// 手前に描画(白)
this.spriteBatch.DrawString(this.font, "◆",
    new Vector2(150.0f, 100.0f), Color.White, 0.0f, Vector2.Zero,
    1.0f, SpriteEffects.None, 0.0f);

// 奥に描画(赤)
this.spriteBatch.DrawString(this.font, "◆",
    new Vector2(150.0f, 140.0f), Color.Red, 0.0f, Vector2.Zero,
    1.0f, SpriteEffects.None, 1.0f);

// 2つの文字の間に描画(青)
this.spriteBatch.DrawString(this.font, "◆",
    new Vector2(190.0f, 115.0f), Color.Blue, 0.0f, Vector2.Zero,
    1.0f, SpriteEffects.None, 0.5f);

SpriteBatch.DrawString メソッド

文字列を描画します。

spriteFont SpriteFont 文字列のイメージが格納されている SpriteFont を指定します。
text string 表示するテキストを指定します。
position Vector2 テキストを表示する位置。スクリーンの左上を基準にしたスクリーン座標で指定します。テキストの原点は最初の文字の左上になります。
color Color テキストの色
rotation float テキストの回転角度。単位は radian で指定する。回転軸はテキストの左上になります。
origin Vector2 テキストを回転させるときの回転軸の位置を指定します。テキストのどの位置を回転軸にするかを指定しますが、実際には回転軸の位置はテキストの左上固定で、テキストの表示位置が -origin 移動します。
scale float テキストの拡大率を指定します。1.0を基準として、縦と横に拡大縮小します。拡大の原点はテキストの左上になります。指定方法は縦横等倍の float 指定と、縦横別々の倍率で指定できる Vector2 の2通りがあります
effects SpriteEffects テキストの表示反転効果を指定します。特に何もしなければ SpriteEffects.None を指定します。
layerDepth float テキストを表示する深度を指定します。主にテキストを手前に表示したり奥に表示するのに使用します。0.0~1.0 の範囲で指定し、0.0が最前面、1.0が最背面になります。

上記のプログラムでは「白」「赤」「青」の順番に SpriteBatch.DrawString メソッドを呼び出していますが、各深度値が「白(0.0)」「赤(1.0)」「青(0.5)」と設定しているので、いちばん奥に赤、いちばん手前に白が描画されていることがわかります。

深度値を使用したテキストの描画

全コード

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 LayerDepthText
{
    /// <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(SpriteSortMode.BackToFront, null);

            // 手前に描画(白)
            this.spriteBatch.DrawString(this.font, "◆",
                new Vector2(150.0f, 100.0f), Color.White, 0.0f, Vector2.Zero,
                1.0f, SpriteEffects.None, 0.0f);

            // 奥に描画(赤)
            this.spriteBatch.DrawString(this.font, "◆",
                new Vector2(150.0f, 140.0f), Color.Red, 0.0f, Vector2.Zero,
                1.0f, SpriteEffects.None, 1.0f);

            // 2つの文字の間に描画(青)
            this.spriteBatch.DrawString(this.font, "◆",
                new Vector2(190.0f, 115.0f), Color.Blue, 0.0f, Vector2.Zero,
                1.0f, SpriteEffects.None, 0.5f);

            // スプライトの一括描画
            this.spriteBatch.End();

            // 登録された DrawableGameComponent を描画する
            base.Draw(gameTime);
        }
    }
}