ライブラリの作り方

:::::::::::032話　ライブラリの作り方:::::::::::

こんにちは、星姫です。
コンソールアプリのmain関数くらいしか開発の経験がない皆さんは、ライブラリと聞くと
どうやって作るんだろう？って首をかしげると思います。
今回はライブラリの作り方から、丁寧に解説していこうと思います。

というわけで、DirectXをもっと簡単に扱えるようなクラス群を提供するライブラリを作成してみましょう。

ライブラリを作る意味、使う意味って何なんでしょうね。
C++言語を使い始めて3年目に入りましたが、実際にライブラリをメンテナンスしたのは、ついこの前のことでした。
巨大なプログラムを書くようになると必要になるのかな？
正直、興味本位でライブラリに手を出してみようと思ったのが今回のレッスンの始まりです。

さて、ここから本題であるライブラリの作り方です。

ライブラリには2種類あります、スタティックライブラリとダイナミックリンクライブラリ(DLL)です。
どちらも、正体は複数の関数やクラス等の機能群をまとめたファイルのことです。

では、さっそく作り方ですが、次のMSDNのドキュメントを読めば、実は誰でも作れるようになります。

スタティックライブラリ (LIB: Static Library) の作成と使用

ダイナミックリンクライブラリ (DLL: Dynamic Link Library) の作成と使用

ハイ！ということで、みなさんはライブラリを作成することができるようになりました。
（丁寧な解説どころか、講座の意味が無い気が…まぁ出来るようになればよいか。）

ではさっそく、DirectX を簡単に扱えるクラスというものを考えていきましょうか。

ゲームを作る時、最初に考えるのが表示するウィンドウサイズです。
ゲーム中に任意のタイミングで画面解像度を変更でき、フルスクリーンモードにしたり、ウィンドウモードにできると良いよね。
ということで、レンダリングターゲットをいつでも変更できる次のような機能を作ることにします。

レンダリングターゲットの設定（画面解像度、フルスクリーンかどうか）

次に、とても基本的な機能である、三角形を描画する機能を用意します。
三角形を描画するには

①マテリアルごとのエフェクトを用意する（ディスクからシステムメモリに読み込み、ビデオメモリに転送しておく）
②マテリアルごとのテクスチャ（リソース）を用意する（ディスクからシステムメモリに読み込み、ビデオメモリに転送しておく）
③頂点バッファを用意する（ディスクからシステムメモリに読み込み、ビデオメモリに転送しておく）
④インデックスバッファを用意する（ディスクからシステムメモリに読み込み、ビデオメモリに転送しておく）
⑤頂点レイアウトを用意する（ディスクからシステムメモリに読み込み、ビデオメモリに転送しておく）
⑥適用するエフェクトの変数を設定する
⑦適用するテクニックを設定する
⑧適用するテクニックの頂点レイアウトを設定する
⑨インデックスバッファのオフセット（開始位置）とインデックスの数（三角形なら3個）を設定する

必要があります。（三角形1個描画するにしてもやることは多いですね…）
となると、描画用に次のような機能を作ればよいことがわかります。（カッコ）の中身は引数です。

エフェクトの追加（エフェクトが書かれた.fxファイルパス）
エフェクトの削除（削除するインデックス、またはエフェクトファイルパス）
エフェクトリストの解放()
エフェクトの取得（エフェクトのインデックス）
リソースの追加（リソースファイルパス）
リソースの削除（削除するインデックス、またはリソースファイルパス）
リソースリストの解放()
リソースの取得（リソースのインデックス）
頂点バッファの作成（バッファサイズ、システムメモリのバッファポインタ）
頂点バッファの解放()
インデックスバッファの作成（バッファサイズ、システムメモリのバッファのポインタ）
インデックスバッファの解放()
頂点レイアウトの作成（頂点レイアウトフォーマット、エフェクトのインデックス、テクニックのインデックス）
頂点レイアウトリストの解放（）
メッシュの描画（インデックスバッファのオフセットとインデックス数と頂点バッファのストライド、エフェクトのインデックス、テクニックのインデックス）

あとは、カメラの位置とプロジェクション設定ができれば、描画に必要な条件が整います。
これを設定できる次の機能を付けておきましょう。
（よくよく考えてみれば、これらはエフェクトの変数になるので、設定関数ではなく取得関数ということで、目的の行列を返すようにしました。）

カメラの設定（カメラ台の姿勢、注視点）
プロジェクションの設定（画角）

最後に、バックバッファとフロントバッファを切り替える機能を付け加えて完成です。

このほかにも、描画前にレンダリングターゲットと深度ステンシルビューをクリアする機能も必要でした。
なので、次の機能も付け加えておきましょう。

画面のクリア（）

こんなものですね。ということで、次に列挙する機能を持つライブラリを作ってみましょう。

        //------------------------------------------------------------------------

        // Public Functions

        //------------------------------------------------------------------------

    public:

        // インスタンスの取得

        static SimpleDX10& Instance(void);

        // ウィンドウプロシージャ

        static LRESULT CALLBACK WndProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);

        // レンダリングターゲットの設定

        ErrorCode_SetRenderTarget        SetRenderTarget( RESOLUTION_TYPE& resolution, bool bFllScreen = false, 

            HINSTANCE hInstance = NULL, int nCmdShow = SW_SHOWNORMAL);

        // エフェクトの追加

        bool    AppendEffect(const char* pFilePath, unsigned int& outIndex);

        // エフェクトの削除 - インデックス版

        void    EraseEffectByIndex(unsigned int index);

        // エフェクトの削除 - 追加時のファイルパス版

        void    EraseEffectByFilePath(const char* pFilePath);

        // エフェクトリストの解放

        void    ReleaseEffects(void);

        // エフェクトを取得する

        ID3D10Effect*    GetEffect(unsigned int index, ID3D10Effect*& pOutEffect) const;

        // リソースの追加

        bool    AppendResource(const char* pFilePath, unsigned int& outIndex);

        // リソースの削除 - インデックス版

        void    EraseResourceByIndex(unsigned int index);

        // リソースの削除 - 追加時のファイルパス版

        void    EraseResourceByFilePath(const char* pFilePath);

        // リソースリストの解放

        void    ReleaseResources(void);

        // リソースを取得する

        ID3D10ShaderResourceView*    GetResource(unsigned int index, ID3D10ShaderResourceView*& pOutResource) const;

        // 頂点バッファの作成

        bool    CreateVertexBuffer(unsigned int bufferSize, const void* pBuffer);

        // 頂点バッファの解放

        void    ReleaseVertexBuffer(void);

        // インデックスバッファの作成

        bool    CreateIndexBuffer(unsigned int bufferSize, const void* pBuffer);

        // インデックスバッファの解放

        void    ReleaseIndexBuffer(void);

        // 頂点レイアウトの作成

        bool    CreateVertexLayout(SMPLDX10_VERTEX_FORMAT format, unsigned int effectIndex, unsigned int techniqueIndex);

        // 頂点レイアウトの解放

        void    ReleaseVertexLayout(void);

        // カメラの設定

        void    SetCamera(D3DXMATRIX& matWorld, D3DXVECTOR3& vecAt);

        // 画角の設定

        void    SetProjection(float angle);

        // レンダリングターゲットのクリア

        void    ClearTargetView(void);

        // メッシュの描画

        bool    DrawMesh(MESH_INFO_TYPE& meshInfo, unsigned int effectIndex, unsigned int techIndex = 0) const;

        // バックバッファとフロントバッファを切り替える

        void    Present(void);

では実装しながら、みんなの不明点をつぶしていきますね。

今回のライブラリの種類はスタティックライブラリです。このソリューションビューの画像は何もしていない最初の状態です。
プリコンパイル済みヘッダーにチェックを入れると、最初からこんな風に実装されます。
プリコンパイル済みヘッダーって何ですか？という方のために説明すると

STLとかは一回コンパイルすれば、まず変更なんてしないため、再度コンパイルする必要がありません。
ならば以降のコンパイル時はコンパイルするのをスキップしよう。

ということで、コンパイルの高速化のためにプリコンパイル済みヘッダーを使用します。

じゃあさっそく、ファイルを追加しましょう。…と、その前にファイルの置き場所をしっかり決めておかなければなりません。
スタティックライブラリを利用するには、ヘッダーファイルが必要になりますので、ヘッダーファイルだけをまとめた
Includeフォルダを作っておく必要があります。

外部が使用する機能・型などが書かれたヘッダファイルは、全てこのIncludeフォルダの中に置かなければなりません。

そのことを注意しながら実装していきます。

とりあえず、メインとなるクラスSimpleDX10を作成します。
デバイスはマシンに一つですし、アプリケーションにとってウィンドウも一つでしょうから
Singleton パターンを使ってみました。え？シングルトンって何ですかって？

Singleton のイメージは唯一のグローバル変数です。
アプリケーション実行中に、一つしかインスタンスを生成できないクラスをSingleton パターンで作られたクラスと呼びます。

使い方は簡単です。上で書いた静的な機能、Instance() を呼ぶだけで、その唯一のインスタンスを取得できます。
コンストラクタを private に隠しているので、2個以上作ろうとコードを書くとコンパイルが通りません。
とても有名なデザインパターンなので、名前と意味くらいはここで覚えておきましょう。

次にやることは、ここに示される４種類のライブラリをつくるソリューションの構成を作成することです。

ソリューションエクスプローラのソリューションを右クリックして、「プロパティ」を開くと
右上に「構成マネージャ」のボタンがあります。下図の構成マネージャを選択しても同じですが
ここで次に示すような名前で構成を新規に作成します。

UIは直感的なので問題なく追加できるはずです。あとは、それぞれの構成について、次の設定を行います。

①プロジェクトの「プロパティ」→「C++」→「コード生成」の項目を名前に合った種類に設定します。
②「C++」と同列の項目に「ビルドイベント」があると思います。「ビルド後のイベント」→「コマンドライン」
に「copy $(TargetPath) $(ProjectDir)\Dist\lib」と書き込みます。（Distフォルダとlibフォルダは自分で作ります）
③「C++」と同列の項目「ライブラリアン」→「出力」の項目にそれぞれのファイルの種類が分かるような名前を書いてください。
例：「$(OutDir)\$(ProjectName)_md_debug.lib」

あとは、構成を選択してビルドするだけで、次のように libフォルダ内にそれぞれのlibファイルが出力されます。

形だけですが、これらの libファイルと Include フォルダを提供すれば、他のプロジェクトでライブラリを使用することができます。
おや？もしかして、ファイルのアイコンに緑のチェックマークが付いていることが気になります？

緑のチェックマークですが、これは「Subversion」というファイル管理ツールを使っているからです。
ソースコードの管理を考えた時、いつ、どういった目的で、どんな変更を加えたのか確認できるとすばらしいと思いませんか？
そんな望みをかなえてくれる便利なツールがあります。それが「Subversion」です。
GUI中心で作業したいなぁと調べてみたら、次の記事を見つけました。
導入はとても簡単でした。（みんなも、ファイル管理ツールを使ってみましょう。正確に以前のバージョンを参照できるようになりますよ。）

「Subversion を Windows で GUI 中心に使う」

さて、では先ほどの機能一式を実装していきます。

ということで、実装が完了しました。（約1日使ってしまった…）

このソリューションビューのファイルで一番大きいファイルを次に示します。

SimpleDX10.cpp

/**************************************************************************//** @file SimpleDX10.cpp @brief SimpleDX10クラス実装 @author Simplestar @date 2010-11-07 @par [説明] SimpleDX10クラス実装ファイル @note Copyright © 2010 SimpleStar Game @ref http://simplestar.syuriken.jp/ *//***************************************************************************/ //------------------------------------------------------------------------ // File Dependencies //------------------------------------------------------------------------ #include "stdafx.h" #include "SimpleDX10.h" #include "DebugPrint.h" #include "PathUtility.h" //------------------------------------------------------------------------ // Constants Definitions //------------------------------------------------------------------------ namespace { static const wchar_t WND_CLASS_NAME[] = L"SimpleDX10 WindowClass"; // ウィンドウクラス名 static const wchar_t WND_TITLE_NAME[] = L"Simplestar Game"; // ウィンドウタイトル名 static const char EFFECT_PROFILES[] = "fx_4_0"; // エフェクトプロファイル static const int INPUT_SLOT = 0; // 入力スロット static const D3D10_INPUT_ELEMENT_DESC PPSITION_DESC = { "POSITION", 0, DXGI_FORMAT_R32G32B32_FLOAT, INPUT_SLOT, 0, D3D10_INPUT_PER_VERTEX_DATA, 0 }; static const D3D10_INPUT_ELEMENT_DESC COLOR_DESC = { "COLOR", 0, DXGI_FORMAT_R32G32B32A32_FLOAT, INPUT_SLOT, 0, D3D10_INPUT_PER_VERTEX_DATA, 0 }; } //------------------------------------------------------------------------ // namespace Dependencies //------------------------------------------------------------------------ using namespace std; //------------------------------------------------------------------------ // Implements //------------------------------------------------------------------------ namespace Simplestar { /**********************************************************************//** @brief ウィンドウプロシージャ @param[in] hWnd : メッセージが発生したウィンドウのハンドル @param[in] message : メッセージコード @param[in] wParam : メッセージの付加情報（メッセージコードにより異なります） @param[in] lParam : メッセージの付加情報（メッセージコードにより異なります） @author Simplestar @par [説明] ウィンドウに対して何らかのメッセージが送られてきた場合に呼び出されます。 @return DefWindowProc( hWnd, message, wParam, lParam ); *//***********************************************************************/ inline LRESULT CALLBACK SimpleDX10::WndProc( HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam ) { PAINTSTRUCT ps; HDC hdc; switch( message ) { case WM_KEYDOWN: break; case WM_PAINT: hdc = BeginPaint( hWnd, &ps ); EndPaint( hWnd, &ps ); break; case WM_DESTROY: PostQuitMessage( 0 ); break; default: return DefWindowProc( hWnd, message, wParam, lParam ); } return 0; } /**********************************************************************//** @brief コンストラクタ *//***********************************************************************/ SimpleDX10::SimpleDX10(void) : m_hInst(NULL) , m_hWnd(NULL) , m_driverType(D3D10_DRIVER_TYPE_NULL) , m_pd3dDevice(NULL) , m_pSwapChain(NULL) , m_pRenderTargetView(NULL) , m_pDepthStencil(NULL) , m_pDepthStencilView(NULL) , m_pVertexBuffer(NULL) , m_pIndexBuffer(NULL) , m_bInitialized(false) { ZeroMemory(&m_resolution, sizeof(RESOLUTION_TYPE)); D3DXMatrixIdentity(&m_matView); D3DXMatrixIdentity(&m_matProjection); m_effectVector.clear(); m_vertexLayout2Vector.clear(); m_effectPathToIndexMap.clear(); m_resourcePathToIndexMap.clear(); _CleanupDevice(); } /**********************************************************************//** @brief デストラクタ *//***********************************************************************/ SimpleDX10::~SimpleDX10(void) { _CleanupDevice(); } /**********************************************************************//** @brief デバイスに確保した領域を解放 @author Simplestar @par [説明] デバイスに設定したもの一切を削除します。 *//***********************************************************************/ void SimpleDX10::_CleanupDevice( void ) { if(m_pd3dDevice) { m_pd3dDevice->ClearState(); } ReleaseVertexLayout(); ReleaseIndexBuffer(); ReleaseVertexBuffer(); ReleaseResources(); ReleaseEffects(); SAFE_RELEASE(m_pDepthStencilView); SAFE_RELEASE(m_pDepthStencil); SAFE_RELEASE(m_pRenderTargetView); SAFE_RELEASE(m_pSwapChain); SAFE_RELEASE(m_pd3dDevice); } /**********************************************************************//** @brief 入力要素ディスクリプタの配列をフォーマットから取得 @param[in] format : 頂点フォーマット #SMPLDX10_VERTEX_FORMAT @param[out] outInputElementDescArray : 入力要素ディスクリプタ配列 @author Simplestar @attention 第2引数の配列のポインタは @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::_GetInputElementDescArray( SMPLDX10_VERTEX_FORMAT format, InputElementDescVector& outInputElementDescArray ) const { outInputElementDescArray.clear(); D3D10_INPUT_ELEMENT_DESC elementDesc; ZeroMemory(&elementDesc, sizeof(D3D10_INPUT_ELEMENT_DESC)); switch (format) { case SMPL_FORMAT_POS3_COL4: elementDesc = PPSITION_DESC; elementDesc.AlignedByteOffset = 0; outInputElementDescArray.push_back(elementDesc); elementDesc = COLOR_DESC; elementDesc.AlignedByteOffset = 0 + sizeof(float)*3; outInputElementDescArray.push_back(elementDesc); break; default: return false; } return true; } /**********************************************************************//** @brief レンダリングターゲットの設定 @param[in] resolution : 解像度(ウィンドウサイズ) @param[in] bFllScreen : フルスクリーン指定 (ディフォルト = false) @param[in] hInstance : システムがプログラムを実行した時点で作成する識別番号 (ディフォルト = NULL) @param[in] nCmdShow : 起動時のウィンドウの状態 (ディフォルト = SW_SHOWNORMAL) @author Simplestar @par [説明] 解像度とフルスクリーンモードかどうかを指定して、レンダリングターゲットをリサイズします。 @return #ErrorCode_SetRenderTarget *//***********************************************************************/ SimpleDX10::ErrorCode_SetRenderTarget SimpleDX10::SetRenderTarget( RESOLUTION_TYPE& resolution, bool bFllScreen /*= false*/, HINSTANCE hInstance /*= NULL*/, int nCmdShow /*= SW_SHOWNORMAL*/) { // ウィンドウクラスの登録 if (NULL == m_hWnd) { WNDCLASSEX wcex; { wcex.cbSize = sizeof( WNDCLASSEX ); wcex.style = CS_HREDRAW | CS_VREDRAW; wcex.lpfnWndProc = WndProc; wcex.cbClsExtra = 0; wcex.cbWndExtra = 0; wcex.hInstance = hInstance; wcex.hIcon = NULL; wcex.hCursor = NULL; wcex.hbrBackground = ( HBRUSH )( COLOR_WINDOW + 1 ); wcex.lpszMenuName = NULL; wcex.lpszClassName = WND_CLASS_NAME; wcex.hIconSm = NULL; } if( !RegisterClassEx( &wcex ) ) { return ERROR_SETRNDTGT_REGISTER_CLASS; } } // 指定解像度の設定 m_resolution = resolution; // サイズ固定のウィンドウを画面中央に作成 { int wndPosX = (GetSystemMetrics( SM_CXSCREEN ) - m_resolution.x)/2; int wndPosY = (GetSystemMetrics( SM_CYSCREEN ) - m_resolution.y)/2; if (NULL != hInstance) { m_hInst = hInstance; } if (NULL == m_hWnd) { RECT rc = { 0, 0, m_resolution.x, m_resolution.y }; AdjustWindowRect( &rc, WS_OVERLAPPEDWINDOW, FALSE ); m_hWnd = CreateWindow( WND_CLASS_NAME, WND_TITLE_NAME, WS_OVERLAPPEDWINDOW & ~WS_THICKFRAME, wndPosX, wndPosY, m_resolution.x, m_resolution.y, NULL, NULL, hInstance, NULL ); if(NULL == m_hWnd) { return ERROR_SETRNDTGT_CREATE_WINDOW; } // 作成したウィンドウを表示 ShowWindow( m_hWnd, nCmdShow ); } else { if (false == bFllScreen) { // 既にウィンドウが開かれている場合はリサイズ bool res = MoveWindow(m_hWnd, wndPosX, wndPosY, m_resolution.x, m_resolution.y, FALSE); if (false == res) { return ERROR_SETRNDTGT_RESIZE_WND; } } } } // デバイスの初期化 HRESULT hr = S_OK; UINT createDeviceFlags = 0; #ifdef _DEBUG createDeviceFlags |= D3D10_CREATE_DEVICE_DEBUG; #endif // デバイスとスワップチェインの作成 if (NULL == m_pd3dDevice && NULL == m_pSwapChain) { D3D10_DRIVER_TYPE driverTypes[] = { D3D10_DRIVER_TYPE_HARDWARE, D3D10_DRIVER_TYPE_REFERENCE, }; UINT numDriverTypes = sizeof( driverTypes ) / sizeof( driverTypes[0] ); DXGI_SWAP_CHAIN_DESC sd; ZeroMemory( &sd, sizeof( sd ) ); { sd.BufferCount = 1; sd.BufferDesc.Width = m_resolution.x; sd.BufferDesc.Height = m_resolution.y; sd.BufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; sd.BufferDesc.RefreshRate.Numerator = 60; sd.BufferDesc.RefreshRate.Denominator = 1; sd.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT; sd.OutputWindow = m_hWnd; sd.SampleDesc.Count = 1; sd.SampleDesc.Quality = 0; sd.Windowed = TRUE; } for( UINT driverTypeIndex = 0; driverTypeIndex < numDriverTypes; driverTypeIndex++ ) { m_driverType = driverTypes[driverTypeIndex]; hr = D3D10CreateDeviceAndSwapChain( NULL, m_driverType, NULL, createDeviceFlags, D3D10_SDK_VERSION, &sd, &m_pSwapChain, &m_pd3dDevice ); if( SUCCEEDED( hr ) ) { break; } } if( FAILED( hr ) ) { return ERROR_SETRNDTGT_CREATE_DEVICE; } } // レンダリングターゲットの作成 if (NULL == m_pRenderTargetView) { ID3D10Texture2D* pBuffer; hr = m_pSwapChain->GetBuffer( 0, __uuidof( ID3D10Texture2D ), ( LPVOID* )&pBuffer ); if( FAILED( hr ) ) return ERROR_SETRNDTGT_CREATE_RNDTGT; hr = m_pd3dDevice->CreateRenderTargetView( pBuffer, NULL, &m_pRenderTargetView ); pBuffer->Release(); if( FAILED( hr ) ) { return ERROR_SETRNDTGT_CREATE_RNDTGT; } } // 深度ステンシルテクスチャの作成 if (NULL == m_pDepthStencil && NULL == m_pDepthStencilView) { D3D10_TEXTURE2D_DESC descDepth; descDepth.Width = m_resolution.x; descDepth.Height = m_resolution.y; descDepth.MipLevels = 1; descDepth.ArraySize = 1; descDepth.Format = DXGI_FORMAT_D32_FLOAT; descDepth.SampleDesc.Count = 1; descDepth.SampleDesc.Quality = 0; descDepth.Usage = D3D10_USAGE_DEFAULT; descDepth.BindFlags = D3D10_BIND_DEPTH_STENCIL; descDepth.CPUAccessFlags = 0; descDepth.MiscFlags = 0; hr = m_pd3dDevice->CreateTexture2D( &descDepth, NULL, &m_pDepthStencil ); if( FAILED( hr ) ) { return ERROR_SETRNDTGT_CREATE_DEPTH_TEX; } // 深度ステンシルビューの作成 { D3D10_DEPTH_STENCIL_VIEW_DESC descDSV; descDSV.Format = descDepth.Format; descDSV.ViewDimension = D3D10_DSV_DIMENSION_TEXTURE2D; descDSV.Texture2D.MipSlice = 0; hr = m_pd3dDevice->CreateDepthStencilView( m_pDepthStencil, &descDSV, &m_pDepthStencilView ); } if( FAILED( hr ) ) { return ERROR_SETRNDTGT_CREATE_DEPTH_VIEW; } } if (false == m_bInitialized) { // 出力結合ステージに作成した描画用ビューと深度ビューを設定 m_pd3dDevice->OMSetRenderTargets( 1, &m_pRenderTargetView, m_pDepthStencilView ); } // ウィンドウモード変更、またはリサイズ if (m_bInitialized) { // リサイズのための記述 DXGI_MODE_DESC modeDesc; { modeDesc.Width = m_resolution.x; modeDesc.Height = m_resolution.y; modeDesc.RefreshRate.Numerator = 60; modeDesc.RefreshRate.Denominator = 1; modeDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; modeDesc.ScanlineOrdering = DXGI_MODE_SCANLINE_ORDER_UNSPECIFIED; modeDesc.Scaling = DXGI_MODE_SCALING_UNSPECIFIED; } // レンダリングターゲットのリサイズ hr = m_pSwapChain->ResizeTarget(&modeDesc); if( FAILED( hr ) ) { return ERROR_SETRNDTGT_RESIZE_RNDTGT; } // ウィンドウモード、またはフルスクリーンモードの設定 m_pSwapChain->SetFullscreenState(bFllScreen, NULL); } // ビューポートの設定 { D3D10_VIEWPORT vp; vp.Width = m_resolution.x; vp.Height = m_resolution.y; vp.MinDepth = 0.0f; vp.MaxDepth = 1.0f; vp.TopLeftX = 0; vp.TopLeftY = 0; m_pd3dDevice->RSSetViewports( 1, &vp ); } m_bInitialized = true; // 成功を返す return ERROR_SETRNDTGT_NONE; } /**********************************************************************//** @brief エフェクトの追加 @param[in] pFilePath : エフェクトファイル(.fxファイル)パス（相対パスOK） @param[out] outIndex : 格納先インデックス @author Simplestar @par [説明] エフェクトファイルよりリストへ追加、格納先のインデックスを返します。配列内に重複は許しません。 @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::AppendEffect( const char* pFilePath, unsigned int& outIndex ) { PathToIndexMap::iterator iter = m_effectPathToIndexMap.find(string(pFilePath)); if (m_effectPathToIndexMap.end() != iter) { // 重複している場合は、既に作られているエフェクトのインデックスを返す outIndex = static_cast<unsigned int>(iter->second); return true; } // ファイルパスをワイド文字列に変換 wchar_t wideFilePath[MAX_PATH]; memset(wideFilePath, 0x0, MAX_PATH*sizeof(wchar_t)); if(false == PathUtility::MBToWC(pFilePath, &wideFilePath[0])) { DEBUG_PRINT("ワイド文字列へ変換に失敗"); return false; } DWORD dwShaderFlags = D3D10_SHADER_ENABLE_STRICTNESS; #if defined( DEBUG ) || defined( _DEBUG ) dwShaderFlags |= D3D10_SHADER_DEBUG; #endif // 格納先インデックスを outIndex = m_effectVector.size(); m_effectVector.push_back(NULL); // 最後尾に追加 HRESULT hr = D3DX10CreateEffectFromFile( wideFilePath, NULL, NULL, EFFECT_PROFILES, dwShaderFlags, 0, m_pd3dDevice, NULL, NULL, &m_effectVector[outIndex], NULL, NULL ); if( FAILED( hr ) ) { m_effectVector.pop_back(); // 最後尾を削除 wstring errorMsg = wstring(L"The FX file [") + wideFilePath + wstring(L"] cannot be located."); MessageBox( NULL, errorMsg.c_str(), L"Error", MB_OK ); return false; } // 重複確認マップへ挿入 m_effectPathToIndexMap.insert(make_pair(string(pFilePath), outIndex)); return true; } /**********************************************************************//** @brief エフェクトの削除 - インデックス版 @param[in] index : 削除対象のインデックス @author Simplestar @note エフェクト配列のインデックスをずらす erase 操作は厳禁です。削除の際は重複禁止マップも削除する必要があります。 *//***********************************************************************/ void SimpleDX10::EraseEffectByIndex( unsigned int index ) { if (m_effectVector.size() > index) { if (m_effectVector[index]) { SAFE_RELEASE(m_effectVector[index]); PathToIndexMap::const_iterator iter; for (iter = m_effectPathToIndexMap.begin(); m_effectPathToIndexMap.end() != iter; ++iter) { if (static_cast<unsigned int>(iter->second) == index) { m_effectPathToIndexMap.erase(iter); return; } } assert(NULL); } } } /**********************************************************************//** @brief エフェクトの削除 - 追加時のファイルパス版 @param[in] pFilePath : エフェクトファイル(.fxファイル)パス（相対パスOK） @author Simplestar @note エフェクト配列のインデックスをずらす erase 操作は厳禁です。削除の際は重複禁止マップも削除する必要があります。 *//***********************************************************************/ void SimpleDX10::EraseEffectByFilePath( const char* pFilePath ) { PathToIndexMap::iterator iter = m_effectPathToIndexMap.find(string(pFilePath)); if (m_effectPathToIndexMap.end() != iter) { unsigned int targetIndex = static_cast<unsigned int>(iter->second); SAFE_RELEASE(m_effectVector[targetIndex]); m_effectPathToIndexMap.erase(iter); } } /**********************************************************************//** @brief エフェクトリストの解放 @author Simplestar @note 重複禁止マップをクリアする必要があります。 *//***********************************************************************/ void SimpleDX10::ReleaseEffects( void ) { for (unsigned int index = 0; index < m_effectVector.size(); ++index) { SAFE_RELEASE(m_effectVector[index]); } m_effectVector.clear(); m_effectPathToIndexMap.clear(); } /**********************************************************************//** @brief エフェクトの取得 @param[in] index : エフェクトのインデックス @param[out] pOutEffect : 取得したエフェクト @author Simplestar @return 取得したエフェクト（取得できない場合NULLが返ります） *//***********************************************************************/ ID3D10Effect* SimpleDX10::GetEffect( unsigned int index, ID3D10Effect*& pOutEffect ) const { if (m_effectVector.size() > index) { if (NULL != m_effectVector[index]) { pOutEffect = static_cast<ID3D10Effect*>(m_effectVector[index]); return pOutEffect; } } return NULL; } /**********************************************************************//** @brief リソースの追加 @param[in] pFilePath : リソースファイルパス（相対パスOK） @param[out] outIndex : 格納先インデックス @author Simplestar @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::AppendResource( const char* pFilePath, unsigned int& outIndex ) { PathToIndexMap::iterator iter = m_resourcePathToIndexMap.find(string(pFilePath)); if (m_resourcePathToIndexMap.end() != iter) { // 重複している場合は、既に作られているエフェクトのインデックスを返す outIndex = static_cast<unsigned int>(iter->second); return true; } // ファイルパスをワイド文字列に変換 wchar_t wideFilePath[MAX_PATH]; memset(wideFilePath, 0x0, MAX_PATH*sizeof(wchar_t)); if(false == PathUtility::MBToWC(pFilePath, &wideFilePath[0])) { DEBUG_PRINT("ワイド文字列へ変換に失敗"); return false; } outIndex = m_resourceVector.size(); m_resourceVector.push_back(NULL); // 最後尾へ追加 HRESULT hr = D3DX10CreateShaderResourceViewFromFile( m_pd3dDevice, wideFilePath, NULL, NULL, &m_resourceVector[outIndex], NULL ); if( FAILED( hr ) ) { m_resourceVector.pop_back(); // 最後尾を削除 wstring errorMsg = wstring(L"The Resource file [") + wideFilePath + wstring(L"] cannot be located."); MessageBox( NULL, errorMsg.c_str(), L"Error", MB_OK ); return false; } // 重複確認マップへ挿入 m_resourcePathToIndexMap.insert(make_pair(string(pFilePath), outIndex)); return true; } /**********************************************************************//** @brief リソースの削除 - インデックス版 @param[in] index : 削除対象のインデックス @author Simplestar @note リソース配列のインデックスをずらす erase 操作は厳禁です。削除の際は重複禁止マップも削除する必要があります。 *//***********************************************************************/ void SimpleDX10::EraseResourceByIndex( unsigned int index ) { if (m_resourceVector.size() > index) { if (m_resourceVector[index]) { SAFE_RELEASE(m_resourceVector[index]); PathToIndexMap::const_iterator iter; for (iter = m_resourcePathToIndexMap.begin(); m_resourcePathToIndexMap.end() != iter; ++iter) { if (static_cast<unsigned int>(iter->second) == index) { m_resourcePathToIndexMap.erase(iter); return; } } assert(NULL); } } } /**********************************************************************//** @brief リソースの削除 - 追加時のファイルパス版 @param[in] pFilePath : リソースのファイルパス（相対パスOK） @author Simplestar @note リソース配列のインデックスをずらす erase 操作は厳禁です。削除の際は重複禁止マップも削除する必要があります。 *//***********************************************************************/ void SimpleDX10::EraseResourceByFilePath( const char* pFilePath ) { PathToIndexMap::iterator iter = m_resourcePathToIndexMap.find(string(pFilePath)); if (m_resourcePathToIndexMap.end() != iter) { unsigned int targetIndex = static_cast<unsigned int>(iter->second); SAFE_RELEASE(m_resourceVector[targetIndex]); m_resourcePathToIndexMap.erase(iter); } } /**********************************************************************//** @brief リソースリストの解放 @author Simplestar @note 重複禁止マップをクリアする必要があります。 *//***********************************************************************/ void SimpleDX10::ReleaseResources( void ) { for (unsigned int index = 0; index < m_resourceVector.size(); ++index) { SAFE_RELEASE(m_resourceVector[index]); } m_resourceVector.clear(); m_resourcePathToIndexMap.clear(); } /**********************************************************************//** @brief リソースを取得する @param[in] index : リソースリストのインデックス @param[out] pOutResource : 取得したリソース @author Simplestar @return 取得したリソース（失敗時はNULLが返ります） *//***********************************************************************/ ID3D10ShaderResourceView* SimpleDX10::GetResource( unsigned int index, ID3D10ShaderResourceView*& pOutResource ) const { if (m_resourceVector.size() > index) { if (NULL != m_resourceVector[index]) { pOutResource = static_cast<ID3D10ShaderResourceView*>(m_resourceVector[index]); return pOutResource; } } return NULL; } /**********************************************************************//** @brief 頂点バッファの作成 @param[in] bufferSize : バッファのサイズ（byteオーダー） @param[in] pBuffer : システムメモリのバッファポインタ @author Simplestar @par [説明] 既にバッファに情報がある場合は、一度解放してから設定します。 @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::CreateVertexBuffer( unsigned int bufferSize, const void* pBuffer ) { ReleaseVertexBuffer(); D3D10_BUFFER_DESC bd; { bd.Usage = D3D10_USAGE_DEFAULT; bd.ByteWidth = bufferSize; bd.BindFlags = D3D10_BIND_VERTEX_BUFFER; bd.CPUAccessFlags = 0; bd.MiscFlags = 0; } D3D10_SUBRESOURCE_DATA InitData; InitData.pSysMem = pBuffer; HRESULT hr = m_pd3dDevice->CreateBuffer( &bd, &InitData, &m_pVertexBuffer ); if( FAILED( hr ) ) { DEBUG_PRINT("頂点バッファの作成に失敗"); return false; } return true; } /**********************************************************************//** @brief 頂点バッファの解放 @author Simplestar *//***********************************************************************/ void SimpleDX10::ReleaseVertexBuffer( void ) { SAFE_RELEASE(m_pVertexBuffer); } /**********************************************************************//** @brief インデックスバッファの作成 @param[in] bufferSize : バッファのサイズ（byteオーダー） @param[in] pBuffer : システムメモリのバッファポインタ @author Simplestar @par [説明] 既にバッファに情報がある場合は、一度解放してから設定します。 @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::CreateIndexBuffer( unsigned int bufferSize, const void* pBuffer ) { ReleaseIndexBuffer(); D3D10_BUFFER_DESC bd; { bd.Usage = D3D10_USAGE_DEFAULT; bd.ByteWidth = bufferSize; bd.BindFlags = D3D10_BIND_INDEX_BUFFER; bd.CPUAccessFlags = 0; bd.MiscFlags = 0; } D3D10_SUBRESOURCE_DATA InitData; InitData.pSysMem = pBuffer; HRESULT hr = m_pd3dDevice->CreateBuffer( &bd, &InitData, &m_pIndexBuffer ); if( FAILED( hr ) ) { DEBUG_PRINT("インデックスバッファの作成に失敗"); return false; } return true; } /**********************************************************************//** @brief インデックスバッファの解放 @author Simplestar *//***********************************************************************/ void SimpleDX10::ReleaseIndexBuffer( void ) { SAFE_RELEASE(m_pIndexBuffer); } /**********************************************************************//** @brief 頂点レイアウトの作成 @param[in] format : 頂点レイアウトのフォーマット @param[in] effectIndex : エフェクトのインデックス @param[in] techniqueIndex : テクニックのインデックス @author Simplestar @par [説明] エフェクトを用意した後、描画する前にテクニックごとの頂点レイアウトをあらかじめ記述しておく必要があります。不正なエフェクト、テクニックインデックスが与えられた場合は失敗します。 @attention あらかじめエフェクトが設定してある必要があります。 @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::CreateVertexLayout( SMPLDX10_VERTEX_FORMAT format, unsigned int effectIndex, unsigned int techniqueIndex ) { vector<ID3D10InputLayout*> emptyVector; m_vertexLayout2Vector.resize(effectIndex+1, emptyVector); m_vertexLayout2Vector[effectIndex].resize(techniqueIndex+1, NULL); if (m_effectVector.size() < effectIndex) { DEBUG_PRINT("不正なエフェクトインデックス"); return false; } ID3D10Effect* pEffect = GetEffect(effectIndex, pEffect); if (NULL == pEffect) { DEBUG_PRINT("エフェクトの取得に失敗"); return false; } D3D10_EFFECT_DESC effectDesc; pEffect->GetDesc(&effectDesc); if (techniqueIndex > effectDesc.Techniques) { DEBUG_PRINT("不正なテクニックインデックス"); return false; } ID3D10EffectTechnique* pTechnique = pEffect->GetTechniqueByIndex(techniqueIndex); if (NULL == pTechnique) { DEBUG_PRINT("テクニックの取得に失敗"); return false; } D3D10_PASS_DESC PassDesc; pTechnique->GetPassByIndex( 0 )->GetDesc( &PassDesc ); InputElementDescVector inputElemDescArray; if (false == _GetInputElementDescArray(format, inputElemDescArray)) { DEBUG_PRINT("入力要素ディスクリプタの取得に失敗"); return false; } HRESULT hr = m_pd3dDevice->CreateInputLayout( &inputElemDescArray[0], inputElemDescArray.size(), PassDesc.pIAInputSignature, PassDesc.IAInputSignatureSize, &m_vertexLayout2Vector[effectIndex][techniqueIndex] ); if( FAILED( hr ) ) { DEBUG_PRINT("入力レイアウトの作成に失敗"); return false; } return true; } /**********************************************************************//** @brief 頂点レイアウトの解放 @author Simplestar *//***********************************************************************/ void SimpleDX10::ReleaseVertexLayout( void ) { for (unsigned int effectCount = 0; effectCount < m_vertexLayout2Vector.size(); ++effectCount) { for (unsigned int techniqueCount = 0; techniqueCount < m_vertexLayout2Vector.size(); ++techniqueCount) { SAFE_RELEASE(m_vertexLayout2Vector[effectCount][techniqueCount]); } m_vertexLayout2Vector[effectCount].clear(); } m_vertexLayout2Vector.clear(); } /**********************************************************************//** @brief カメラの設定 @param[in] matWorld : カメラ台の姿勢 @param[in] vecAt : 注視点 @author Simplestar *//***********************************************************************/ void SimpleDX10::SetCamera( D3DXMATRIX& matWorld, D3DXVECTOR3& vecAt ) { D3DXVECTOR3 Eye( matWorld._41, matWorld._42, matWorld._43 ); D3DXVECTOR3 Up( matWorld._21, matWorld._22, matWorld._23 ); D3DXMatrixLookAtLH( &m_matView, &Eye, &vecAt, &Up ); } /**********************************************************************//** @brief 画角の設定 @param[in] angle : 縦の画角（画面中央から上端までの仰角） @author Simplestar *//***********************************************************************/ void SimpleDX10::SetProjection( float angle ) { D3DXMatrixPerspectiveFovLH( &m_matProjection, angle * static_cast<float>(D3DX_PI) / 180.0f, m_resolution.x/static_cast<float>(m_resolution.y), 0.1f, 100.0f ); } /**********************************************************************//** @brief レンダリングターゲットのクリア @author Simplestar @par [説明] 深度ステンシルビュー、バックバッファのクリア *//***********************************************************************/ void SimpleDX10::ClearTargetView( void ) { if (NULL != m_pd3dDevice) { // バックバッファのクリア float clearColor[4] = { 0.0f, 0.125f, 0.3f, 1.0f }; // クリア色 (RGBA) m_pd3dDevice->ClearRenderTargetView( m_pRenderTargetView, clearColor ); // 深度ステンシルのクリア ( 1.0 max depth) m_pd3dDevice->ClearDepthStencilView( m_pDepthStencilView, D3D10_CLEAR_DEPTH, 1.0f, 0 ); } } /**********************************************************************//** @brief オブジェクトの描画 @param[in] meshInfo : バッファのインデックスオフセットとインデックス数を格納した構造体 @param[in] effectIndex : 適用するエフェクトのインデックス @param[in] techIndex : エフェクト内の使用するテクニックのインデックス（ディフォルト = 0） @author Simplestar @par [説明] この関数が呼ばれる時、既にグラフィックボードに全てのデータが確保されていなければなりません。 @attention この関数を呼ぶ前に、シェーダ変数を先に設定する必要があります。 @retval true : 成功 @retval false : 失敗 *//***********************************************************************/ bool SimpleDX10::DrawMesh( MESH_INFO_TYPE& meshInfo, unsigned int effectIndex, unsigned int techIndex /*= 0*/ ) const { if (NULL != m_pd3dDevice && m_vertexLayout2Vector.size() > effectIndex && m_vertexLayout2Vector[effectIndex].size() > techIndex) { ID3D10InputLayout* pInputLayout = m_vertexLayout2Vector[effectIndex][techIndex]; if (NULL == pInputLayout) { DEBUG_PRINT("頂点レイアウトが作られていません effectIndex = %u, techIndex = %u", effectIndex, techIndex); return false; } ID3D10Effect* pEffect = GetEffect(effectIndex, pEffect); if (NULL == pEffect) { DEBUG_PRINT("エフェクトの取得に失敗"); return false; } ID3D10EffectTechnique* pTechnique = pEffect->GetTechniqueByIndex(techIndex); if (NULL == pTechnique) { DEBUG_PRINT("テクニックの取得に失敗"); return false; } // Set input layout m_pd3dDevice->IASetInputLayout(pInputLayout); // Set vertex buffer m_pd3dDevice->IASetVertexBuffers( INPUT_SLOT, 1, &m_pVertexBuffer, &meshInfo.stride, &meshInfo.offset ); // Set index buffer m_pd3dDevice->IASetIndexBuffer( m_pIndexBuffer, DXGI_FORMAT_R32_UINT, 0 ); // Set primitive topology m_pd3dDevice->IASetPrimitiveTopology( D3D10_PRIMITIVE_TOPOLOGY_TRIANGLELIST ); D3D10_TECHNIQUE_DESC techDesc; pTechnique->GetDesc( &techDesc ); for( UINT p = 0; p < techDesc.Passes; ++p ) { pTechnique->GetPassByIndex( p )->Apply( 0 ); m_pd3dDevice->DrawIndexed( meshInfo.count, 0, 0 ); } return true; } return false; } /**********************************************************************//** @brief バックバッファとフロントバッファを切り替える @author Simplestar *//***********************************************************************/ void SimpleDX10::Present( void ) { if (NULL != m_pSwapChain) { m_pSwapChain->Present( 0, 0 ); } } } //**************************************************************************** // End Of File. //

さて、ライブラリが正しく機能するかどうかですが、どのようにテストすればよいでしょうか？
クラス単体で機能をテストすることを調べてみると、次の CppUnit なんてキーワードがヒットすると思います。

C++開発者のための単体テスト入門

このサイトを参考にすれば、誰でも CppUnit を実装できます。
作ったコードが、期待通りに動作するかどうかの確信を得られますので、機会があれば導入していきましょう。
さて、今回はウィンドウが出たりするので、GUIを操作してくれるテストツールとかも必要になります。
そんな時は、次のツールの使用を検討してみようと思います。

AutoIt

今はまだ、何をどうテストするか決めてないので、そこらへんが詰まってきたら手を出してみますね。

最後に、Doxygen でソースからドキュメントを作成してみましょう。

Doxygen の使い方は 22話で詳しく扱っています。
今回の変更点は、Doxyfile の INPUT = の部分のフォルダパスを書き換えるだけです。
doxygen を実行すると、次のリファレンスドキュメントが作成されます。
（現在のリファレンスとはバージョンが異なるので、あくまで例としてとらえて下さい。2010/12/05）

SimplestarDX10_Reference

さて、ライブラリも完成したことですし
これにて今回のレッスンを終了します。
さっそく次回から、今回のライブラリを使っていきましょう。

作成した SimpleDX10 ライブラリを次のリンク先に置いておきます。
ダウンロードコーナーにも追加しました。（ちゃんとテストしてないので多分動きません…何で公開したし！）

SimplestarDX10.zip

それでは、また次回に会いましょう！

2010/11/03 初記。
2010/11/14 追加。
2010/11/20 修正、追加。

:::::::::::032話　ライブラリの作り方:::::::::::

ホームページ制作　フリー素材　無料WEB素材

Simplestar Game

:::::::::::032話 ライブラリの作り方:::::::::::

:::::::::::032話 ライブラリの作り方:::::::::::

:::::::::::032話　ライブラリの作り方:::::::::::

:::::::::::032話　ライブラリの作り方:::::::::::