カウンタ

XNAXNA

ページ更新日 2009/ 1/ 4
広告

レイヤーパラメータを使用してスプライトの前後関係を作る

概要
 レイヤーの深度値を使用してスプライトの前後関係を指定します。
レイヤーパラメータを使用してスプライトの前後関係を作る
動作確認バージョン
対応 XNA バージョン
  • 2.0
  • 3.0
対応プラットフォーム
  • Windows (XP SP2 以降, Vista)
  • Xbox 360
必要な頂点シェーダバージョン
1.1
必要なピクセルシェーダバージョン
1.1
サンプルの操作方法
内容

※この Tips は XNA Game Studio 2.0 をベースに説明しています。

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

 スプライトの深度値でソートさせるには「SpriteBatch.Begin」メソッドの第2引数に「SpriteSortMode.BackToFront」を指定するようにします。

// 奥から描画するようにソート
this.spriteBatch.Begin(
    SpriteBlendMode.AlphaBlend,
    SpriteSortMode.BackToFront,
    SaveStateMode.SaveState);
SpriteBatch.Begin メソッド
スプライトを描画する前に呼び出しておきます。内部ではスプライトの描画に必要な設定を行っています。
blendMode SpriteBlendMode 描画を行う時に背景との色のブレンド方法を SpriteBlendMode 列挙から指定します。今回は「None」でも同様の結果が得られますが、デフォルトの値でもある「AlphaBlend」を設定しています。
sortMode SpriteSortMode スプライトを描画する際にどの順番で描画するかを SpriteSortMode 列挙から指定します。奥から描画させるので SpriteSortMode.BackToFront を指定します。
stateMode SaveStateMode レンダリングステートの状態を一時的に保存するかを SaveStateMode 列挙から指定します。
MSDN ライブラリの Web ページへリンク

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

// 最背面に描画(赤)
this.spriteBatch.Draw(this.texture, new Vector2(200.0f100.0f), null,
    Color.Red, 0.0fVector2.Zero, 1.0fSpriteEffects.None, 1.0f);

// 最前面に描画(緑)
this.spriteBatch.Draw(this.texture, new Vector2(160.0f140.0f), null,
    Color.Green, 0.0fVector2.Zero, 1.0fSpriteEffects.None, 0.0f);

// 2つのスプライトの間に描画(青)
this.spriteBatch.Draw(this.texture, new Vector2(240.0f180.0f), null,
    Color.Blue, 0.0fVector2.Zero, 1.0fSpriteEffects.None, 0.5f);
SpriteBatch.Draw メソッド
スプライトの描画バッチリストにスプライトを追加します。
texture Texture2D スプライトとして表示するテクスチャーを指定します。
position Vector2 スプライトを表示する位置。スクリーンの左上を基準にしたスクリーン座標で指定します。スプライトの原点は左上の位置になります。
sourceRectangle Nullable<Rectangle> テクスチャーの転送領域を指定します。テクスチャー全体をスプライトとして表示させる場合は null を指定できます。このパラメータを指定すると、任意の領域だけをスプライトとして表示させることができます。
color Color スプライトの色を掛け合わせる色を指定します。Color.White を指定した場合は、スプライトの原色で表示されます。Color.Black を指定した場合は、スプライトの色に関係なく完全な黒で表示されます。計算式は「結果 = スプライトの色 * color」になります。
rotation float スプライトの回転角度。単位は radian で指定する。回転軸はスプライトの左上になります。
origin Vector2 スプライトを回転させるときの回転軸の位置を指定します。スプライトのどの位置を回転軸にするかを指定しますが、実際には回転軸の位置はスプライトの左上固定で、スプライトの表示位置が -origin 移動します。
scale float スプライトの拡大率を指定します。1.0 を基準として、縦と横に拡大縮小します。拡大の原点はスプライトの左上になります。
effects SpriteEffects スプライトの表示反転効果を指定します。特に何もしなければ SpriteEffects.None を指定します。
layerDepth float スプライトを表示する深度を指定します。主にスプライトを手前に表示したり奥に表示するのに使用します。0.0~1.0 の範囲で指定し、0.0 が最前面、1.0 が最背面になります。
MSDN ライブラリの Web ページへリンク

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

深度値を使用したスプライトの描画

サンプル実行ファイル (Windows のみ)
ファイル サイズ 対応XNAバージョン プラットフォーム 作成日
xna_tips_layerdepthsprite_3_0_exe.zip 17.8 KB 3.0 Windows (XP SP2 以降, Vista) 2009/01/04
xna_tips_layerdepthsprite_2_0_exe.zip 19.5 KB 2.0 Windows (XP SP2, Vista) 2008/01/01
xna_tips_layerdepthsprite_1_0_ref_exe.zip 19.5 KB 1.0 Refresh Windows (XP SP2, Vista) 2007/08/05
プロジェクト ダウンロード
ファイル サイズ 対応XNAバージョン プラットフォーム 作成日
xna_tips_layerdepthsprite_3_0_project.zip 33.8 KB 3.0 Windows (XP SP2 以降, Vista), Xbox 360 2009/01/04
xna_tips_layerdepthsprite_2_0_project.zip 32.2 KB 2.0 Windows (XP SP2, Vista), Xbox 360 2008/01/01
xna_tips_layerdepthsprite_1_0_ref_project.zip 32.7 KB 1.0 Refresh Windows (XP SP2, Vista), Xbox 360 2007/08/05
全コード
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 LayerDepthSprite
{
    /// <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";
        }

        /// <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)
        {
            // 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(
                SpriteBlendMode.AlphaBlend,
                SpriteSortMode.BackToFront,
                SaveStateMode.SaveState);

            // 最背面に描画(赤)
            this.spriteBatch.Draw(this.texture, new Vector2(200.0f, 100.0f), null,
                Color.Red, 0.0f, Vector2.Zero, 1.0f, SpriteEffects.None, 1.0f);

            // 最前面に描画(緑)
            this.spriteBatch.Draw(this.texture, new Vector2(160.0f, 140.0f), null,
                Color.Green, 0.0f, Vector2.Zero, 1.0f, SpriteEffects.None, 0.0f);

            // 2つのスプライトの間に描画(青)
            this.spriteBatch.Draw(this.texture, new Vector2(240.0f, 180.0f), null,
                Color.Blue, 0.0f, Vector2.Zero, 1.0f, SpriteEffects.None, 0.5f);

            // スプライトの一括描画
            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/08/05 ページ作成
ページトップ▲
Copyright (C) since 2005 Yuichi Onodera (オノデラユウイチ), All rights reserved.