インデックスバッファを使用したボックスの表示

概要

ポリゴンを多めに使用してボックスを作成しています。その際、頂点データのデータ量を減らすためにインデックスバッファを使用しています。

動作環境

必須環境

動作確認環境

内容

ボックスについて

ボックスは６つの面から成り立っており、ひとつの四角形の面は三角ポリゴン２つで構成されています。ということは三角ポリゴンは合計で「２×６＝１２」枚となります。さらに三角ポリゴンの頂点は３つなので頂点の合計は「１２×３＝３６」個となります。なので、「VertexBuffer」のみで作成する場合は、３６個のデータを箱の形になるように位置情報を決めて書き込めば、箱として表示することは可能です。(TriangleStrip の場合は２４個必要)

しかし、箱をイメージしてください。箱の角は８個です。位置情報としては８個で十分なはずです。頂点データというのは、数が増えてくるとメモリを圧迫します。これを何とか減らすために使用するのが「IndexBuffer」です。

位置情報は８個でいいのですが、ポリゴンの頂点は必ず３６個必要になります。そこで、８個の頂点データを共有してしまいましょうというのが「IndexBuffer」の使用目的になります。

フィールド

/// <summary>
/// インデックスバッファ
/// </summary>
private IndexBuffer indexBuffer = null;

/// <summary>
/// インデックスバッファの各頂点番号配列
/// </summary>
private static readonly Int16[] vertexIndices = new Int16[] {
    2, 0, 1, // １枚目のポリゴン
    1, 3, 2, // ２枚目のポリゴン
    4, 0, 2, // ３枚目のポリゴン
    2, 6, 4, // ４枚目のポリゴン
    5, 1, 0, // ５枚目のポリゴン
    0, 4, 5, // ６枚目のポリゴン
    7, 3, 1, // ７枚目のポリゴン
    1, 5, 7, // ８枚目のポリゴン
    6, 2, 3, // ９枚目のポリゴン
    3, 7, 6, // １０枚目のポリゴン
    4, 6, 7, // １１枚目のポリゴン
    7, 5, 4  // １２枚目のポリゴン
};

フィールドには「IndexBuffer」が宣言されていますが、その下に「頂点番号配列」をあらかじめ作成しています。この配列は３６個の頂点分の配列を確保していますが、各数値の意味は、各三角形ポリゴンの頂点が８個の頂点データのうちの、何番目の頂点データを使用するかという意味になります。よく見るとわかりますが、中身のデータは「０～７」の間のインデックスが書き込まれています。コメントを見るとわかりやすいでしょう。

ちなみに配列の型を「Int16[]」としていますが「short[]」でもかまいません（２バイト）。「int」（４バイト）で配列を作る場合もありますが、これは頂点数が「65535」を超える場合に使用します。頂点数がこの数値を超えることがない場合は、メモリの消費を抑えるために２バイトデータの配列を作成します。

作成

// 頂点の数
int vertexCount = 8;

// 頂点バッファ作成
this.vertexBuffer = new VertexBuffer(this.GraphicsDevice,
    typeof(VertexPositionColor), vertexCount, BufferUsage.None);

// 頂点データを作成する
VertexPositionColor[] vertives = new VertexPositionColor[vertexCount];

vertives[0] = new VertexPositionColor(new Vector3(-2.0f, 2.0f, -2.0f), Color.Yellow);
vertives[1] = new VertexPositionColor(new Vector3(2.0f, 2.0f, -2.0f), Color.Gray);
vertives[2] = new VertexPositionColor(new Vector3(-2.0f, 2.0f, 2.0f), Color.Purple);
vertives[3] = new VertexPositionColor(new Vector3(2.0f, 2.0f, 2.0f), Color.Red);
vertives[4] = new VertexPositionColor(new Vector3(-2.0f, -2.0f, -2.0f), Color.SkyBlue);
vertives[5] = new VertexPositionColor(new Vector3(2.0f, -2.0f, -2.0f), Color.Orange);
vertives[6] = new VertexPositionColor(new Vector3(-2.0f, -2.0f, 2.0f), Color.Green);
vertives[7] = new VertexPositionColor(new Vector3(2.0f, -2.0f, 2.0f), Color.Blue);

// 頂点データを頂点バッファに書き込む
this.vertexBuffer.SetData(vertives);

頂点バッファを作成しています。本来頂点は３６個作成する必要があるのですが、インデックスバッファを使用することにより８個作成するだけでよくなります。

// インデックスバッファを作成
this.indexBuffer = new IndexBuffer(this.GraphicsDevice,
    IndexElementSize.SixteenBits, 3 * 12, BufferUsage.None);

// 頂点インデックスを書き込む
this.indexBuffer.SetData(vertexIndices);

インデックスバッファを作成しています。第２引数には書き込む頂点インデックスのビット数を指定します。１個のインデックスを２バイトにしているので「IndexElementSize.SixteenBits」を指定します。

第３引数にはインデックスの数を指定します。今回はポリゴンを１２枚描画するので「三角形ポリゴンの頂点数×ポリゴン数」である 36 を指定します。もちろんインデックスの配列の要素数をそのまま指定しても問題ありませんが、今回はわかりやすくするためにわざと数値を分けています。

頂点インデックスの配列はすでにフィールドで作成しているので「IndexBuffer.SetData」メソッドで書き込みます。

IndexBuffer コンストラクタ

頂点データを参照するインデックスを管理する IndexBuffer クラスのインスタンスを生成します。

IndexBuffer.SetData メソッド

頂点インデックスの配列をインデックスバッファにコピーする。

描画

// インデックスバッファをセット
this.GraphicsDevice.Indices = this.indexBuffer;

インデックスバッファを使用する場合、ポリゴンを描画する前にデバイスにインデックスバッファをセットします。

// インデックスを使用してポリゴンを描画する
this.GraphicsDevice.DrawIndexedPrimitives(
    PrimitiveType.TriangleList,
    0,
    0,
    8,
    0,
    12
);

インデックスバッファと頂点バッファを使用している場合、ポリゴンの描画には「GraphicsDevice.DrawIndexedPrimitives」メソッドを使用します。

第４引数には作成した頂点の数を指定します。サンプルでは８つの頂点データを共有しているので「8」を指定しています。

第６引数にはプリミティブの数を指定します。三角形ポリゴンを１２枚描画するので「12」です。

その他の数値パラメータは 0 でいいでしょう。

GraphicsDevice.DrawIndexedPrimitives メソッド

指定された頂点インデックスと頂点バッファに基づいてプリミティブを描画します。

全コード

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

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

        /// <summary>
        /// 基本エフェクト
        /// </summary>
        private BasicEffect basicEffect = null;

        /// <summary>
        /// 頂点バッファ
        /// </summary>
        private VertexBuffer vertexBuffer = null;

        /// <summary>
        /// インデックスバッファ
        /// </summary>
        private IndexBuffer indexBuffer = null;

        /// <summary>
        /// インデックスバッファの各頂点番号配列
        /// </summary>
        private static readonly Int16[] vertexIndices = new Int16[] {
            2, 0, 1, // １枚目のポリゴン
            1, 3, 2, // ２枚目のポリゴン
            4, 0, 2, // ３枚目のポリゴン
            2, 6, 4, // ４枚目のポリゴン
            5, 1, 0, // ５枚目のポリゴン
            0, 4, 5, // ６枚目のポリゴン
            7, 3, 1, // ７枚目のポリゴン
            1, 5, 7, // ８枚目のポリゴン
            6, 2, 3, // ９枚目のポリゴン
            3, 7, 6, // １０枚目のポリゴン
            4, 6, 7, // １１枚目のポリゴン
            7, 5, 4  // １２枚目のポリゴン
        };


        /// <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.basicEffect = new BasicEffect(this.GraphicsDevice);

            // エフェクトで頂点カラーを有効にする
            this.basicEffect.VertexColorEnabled = true;

            // ビューマトリックスをあらかじめ設定 ((10, 10, 10) から原点を見る)
            this.basicEffect.View = Matrix.CreateLookAt(
                    new Vector3(10.0f, 10.0f, 10.0f),
                    Vector3.Zero,
                    Vector3.Up
                );

            // プロジェクションマトリックスをあらかじめ設定
            this.basicEffect.Projection = Matrix.CreatePerspectiveFieldOfView(
                    MathHelper.ToRadians(45.0f),
                    (float)this.GraphicsDevice.Viewport.Width /
                        (float)this.GraphicsDevice.Viewport.Height,
                    1.0f,
                    100.0f
                );

            // 頂点の数
            int vertexCount = 8;

            // 頂点バッファ作成
            this.vertexBuffer = new VertexBuffer(this.GraphicsDevice,
                typeof(VertexPositionColor), vertexCount, BufferUsage.None);

            // 頂点データを作成する
            VertexPositionColor[] vertives = new VertexPositionColor[vertexCount];

            vertives[0] = new VertexPositionColor(new Vector3(-2.0f, 2.0f, -2.0f), Color.Yellow);
            vertives[1] = new VertexPositionColor(new Vector3(2.0f, 2.0f, -2.0f), Color.Gray);
            vertives[2] = new VertexPositionColor(new Vector3(-2.0f, 2.0f, 2.0f), Color.Purple);
            vertives[3] = new VertexPositionColor(new Vector3(2.0f, 2.0f, 2.0f), Color.Red);
            vertives[4] = new VertexPositionColor(new Vector3(-2.0f, -2.0f, -2.0f), Color.SkyBlue);
            vertives[5] = new VertexPositionColor(new Vector3(2.0f, -2.0f, -2.0f), Color.Orange);
            vertives[6] = new VertexPositionColor(new Vector3(-2.0f, -2.0f, 2.0f), Color.Green);
            vertives[7] = new VertexPositionColor(new Vector3(2.0f, -2.0f, 2.0f), Color.Blue);

            // 頂点データを頂点バッファに書き込む
            this.vertexBuffer.SetData(vertives);

            // インデックスバッファを作成
            this.indexBuffer = new IndexBuffer(this.GraphicsDevice,
                IndexElementSize.SixteenBits, 3 * 12, BufferUsage.None);

            // 頂点インデックスを書き込む
            this.indexBuffer.SetData(vertexIndices);
        }

        /// <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.GraphicsDevice.SetVertexBuffer(this.vertexBuffer);

            // インデックスバッファをセット
            this.GraphicsDevice.Indices = this.indexBuffer;

            // パスの数だけ繰り替えし描画 (といっても BasicEffect は通常１回)
            foreach (EffectPass pass in this.basicEffect.CurrentTechnique.Passes)
            {
                // パスの開始
                pass.Apply();
                
                // インデックスを使用してポリゴンを描画する
                this.GraphicsDevice.DrawIndexedPrimitives(
                    PrimitiveType.TriangleList,
                    0,
                    0,
                    8,
                    0,
                    12
                );
            }

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