スプライトを表示させる

Page updated :

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

概要

テクスチャー(画像)を読み込んで画面上に表示させます。

スプライトを表示させる

動作環境

必須環境

対応 XNA バージョン
  • 2.0
  • 3.0
  • 3.1
  • 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 エミュレーター

内容

スプライトとは

画像をスクリーン上に描画するための矩形領域です。2Dゲームではこの機能がよく使われていますが、3Dでも擬似的に2D画像描画として使用されることが多いです。

XNA ではすべて3Dポリゴンで描画しないといけないため、スクリーン上に描画する画像はポリゴンを使用した擬似スプライトになります。といってもポリゴンを意識するような操作は必要なく、手軽に描画させることできます。

画像の用意

画像を表示するので画像ファイルを用意しておかなければいけません。サンプルでは下のような画像を使っています。

スプライトとして表示させる画像

サイズが 128×128 の PNG ファイルを使用していますが、大きさは任意で構いません。また、読み込むことができる画像ファイルの形式は標準で下記のファイルになります。

  • .bmp
  • .dds
  • .dib
  • .hdr
  • .jpg
  • .pfm
  • .png
  • .ppm
  • .tga

プロジェクトに画像を追加

サンプルでは「Content」プロジェクトに画像ファイルを入れるようにしています。プロジェクトに画像ファイルを入れる方法については下記のページを参照してください。

プロジェクトに Texture.png を追加

フィールド

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

/// <summary>
/// テクスチャー
/// </summary>
private Texture2D texture = null;

スプライトを描画するには、描画するスプライトをバッチ化する「SpriteBatch」と、2次元画像データを格納する「Texture2D」を用意します。

リソースの作成・読み込み

/// <summary>
/// ゲームが始まるときに一回だけ呼ばれ
/// すべてのゲームコンテンツを読み込みます
/// </summary>
protected override void LoadContent()
{
    // テクスチャーを描画するためのスプライトバッチクラスを作成します
    this.spriteBatch = new SpriteBatch(this.GraphicsDevice);

    // テクスチャーをコンテンツパイプラインから読み込む
    this.texture = this.Content.Load<Texture2D>("Texture");
}

LoadGraphicsContent メソッド内で「SpriteBatch」クラスを作成します。引数には GraphicsDevice を渡します。

続いて ContentManager.Load メソッドを使用して、テクスチャーを読み込んで作成します。タイプパラメータには「Texture2D」クラスを指定して、引数にアセット名を指定します。

SpriteBatch コンストラクタ

スプライトの描画をバッチ化するクラス「SpriteBatch」のインスタンスを作成します。

graphicsDevice GraphicsDevice 描画に使用する GraphicsDevice を指定します。

描画

// スプライトの描画準備
this.spriteBatch.Begin();

// スプライトを描画する
this.spriteBatch.Draw(this.texture, Vector2.Zero, Color.White);

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

Draw メソッド内でテキストの描画を行います。

スプライトを描画には「SpriteBatch.Draw」メソッドを使用しますが、描画前と描画後にそれぞれ「SpriteBatch.Begin」メソッドと「SpriteBatch.End」メソッドを呼ぶ必要があります。

SpriteBatch.Draw メソッドの第1引数に、作成した「Texture2D」クラスを指定します。これによって読み込んだ画像ファイルを表示させることができるようになります。

SpriteBatch.Begin メソッド

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

SpriteBatch.Draw メソッド

スプライトの描画バッチリストにスプライトを追加します。

texture Texture2D スプライトとして表示するテクスチャーを指定します。
position Vector2 スプライトを表示する位置。スクリーンの左上を基準にしたスクリーン座標で指定します。スプライトの原点は左上の位置になります。
color Color スプライトの色を掛け合わせる色を指定します。Color.White を指定した場合は、スプライトの原色で表示されます。Color.Black を指定した場合は、スプライトの色に関係なく完全な黒で表示されます。計算式は「結果 = スプライトの色 * color」になります。

SpriteBatch.End メソッド

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

スクリーンとスプライトの原点

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

全コード

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 DrawSprite
{
    /// <summary>
    /// ゲームメインクラス
    /// </summary>
    public class GameMain : Microsoft.Xna.Framework.Game
    {
        /// <summary>
        /// グラフィックデバイス管理クラス
        /// </summary>
        private GraphicsDeviceManager graphics = null;

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

        /// <summary>
        /// テクスチャー
        /// </summary>
        private Texture2D texture = 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.texture = this.Content.Load<Texture2D>("Texture");
        }

        /// <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.Draw(this.texture, Vector2.Zero, Color.White);

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

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