BMLDLL Tutorial

DxLibFanに戻る

1. BMLDLLとは
2. 最初に必要なもの
3. BMLDLLを使うのに必要なツール、ライブラリ
4. VisualC++での使い方
5. Dev-C++での使い方
6. サンプルプログラム　DxLibを使ってBML Playerを作ろう
7. Licence (ライセンス) (使用条件) (とても緩い使用条件ですよ^^；)
8. Frequency asked Question (よく聞かれる質問) (FAQ) (Q & A)
9. download BMLDLL (BMLDLLをダウンロードする)

---

---

BMLDLLとは

簡単に言うと、libBulletMLをC言語で使う事が出来るようになる。
です。
DLLなので変なリンカ問題に悩まされずにすみます。

最初に必要なもの

• C言語でDxLibをいじれるくらいの知識
• ちょっとしたパソコン用語を検索する能力
  用語を調べるにはe-wordとかASCII デジタル用語辞典を使ってください。 非常に簡単にすばやく調べられ効率的に学習できます＾＾
  

BMLDLLを使うのに必要なもの

• Win32 Binaryを吐くことの出来るC言語コンパイラ(VisualC++6.0以降 奨励,Dev-C++ (MinGWは最新版のもの)

VisualC++での使い方

VC以外のコンパイラを使用しているユーザー向けの設定

各自、BMLDLL.lib（マルチスレッドを使うならば BMLDLLMT.lib)をリンクしてください。 そうすれば勝手にBMLDLL.dllを読み込んで関数を使える状態にしてくれます。
しかし、Borland製のものはライブラリ形式が違うため各自変換する必要があります。
また、上記のような方法で上手く行かない場合は、 LoadLibraryとGetModuleHandleを駆使してください。
以上です。

設定方法 VCパワーユーザー向け要約

1. BMLDLL.hとその他必要なものをインクルードして関数を呼び出す。以上。

---

---

DxLibを使ってBML Playerを作ろう！

1. まず使用するコンパイラはVisualC++。（それでないとDxLibは使えない）。 まずはテンプレート。以下のソースをコピペして下さい。
   /*! @auther d金魚 @since 2004/2/7 @version 1.02 @note DxLibでサンプルを書いて見ました＾＾ <h3>見てね＾＾</h3> このソースコードはBSD Licence的な考えで自由に使ってOKです＾＾ 簡単に言うと、著作者への配慮を忘れなければ自由って事です。 例：以下のような事は止めてください。BSD Licence的な考えに反します。 これは私が作った！だからみんな使うな！って感じで主張する事のような事。 このソースつかったら被害が出た。賠償金払え！見たいな事。 <h3>謝辞</h3> DxLibの製作者、山田　巧　氏に感謝します。 http://homepage2.nifty.com/natupaji/DxLib/ */ #include "DxLib.h" #include "BMLDLL.h" //********************************************************** ///ベンチマーク用設定でコンパイルする #define BML_BENCHMARK 1 //********************************************************** //ユーティリティ関数 inline bool CheckCollision(const RECT &a,const RECT &g){ return !(a.right<g.left || a.left>g.right || a.top>g.bottom || a.bottom<g.top); } //********************************************************** ///超簡易プレイヤークラス class TestPlayer{ public: TestPlayer(){ mx = 0; my = 0; } ~TestPlayer(){} typedef int Coordinates; Coordinates mx,my; Coordinates getX(){return mx;} Coordinates getY(){return my;} void setX(Coordinates x){mx = x;} void setY(Coordinates y){my = y;} void setXY(Coordinates x,Coordinates y){ setX(x); setY(y); } void addX(Coordinates x){ mx += x;} void addY(Coordinates y){ my += y;} virtual void Move(){ int angle=-1; //とりあえず角度を-1にしておく //[38]↑ [40]↓ [37]← [39]→ bool right = false,left = false,up = false,down = false; //::ProcessMessage(); if(::CheckHitKey(KEY_INPUT_RIGHT)){ right = true; } if(::CheckHitKey(KEY_INPUT_LEFT)){ left = true; } if(::CheckHitKey(KEY_INPUT_UP)){ up = true; } if(::CheckHitKey(KEY_INPUT_DOWN)){ down = true; } if(up && right) //右上 angle=45; else if(left && up) //左上 angle=135; else if(left && down) //左下 angle=225; else if(down && right) //右下 angle=315; else if(up) //↑ angle=90; else if(down) //↓ angle=270; else if(left) //← angle=180; else if(right) //→ angle=0; //angleの値が変わっていたらキャラクタの座標を変更する if(angle!=-1){ int mv = 3;//３の速さ addX(BML_HELPER_AngleToCos(angle)*mv); addY(-BML_HELPER_AngleToSin(angle)*mv); //cx+=fcos[angle]*mv; //cy-=fsin[angle]*mv; } return; } virtual void Draw(int color){ DrawBox(getX(),getY(),getX() + 3,getY() + 3,color,TRUE); return; } }; ///ここでテストプレイヤーを宣言 TestPlayer gPlayer; //********************************************************** //簡易FPSマネージメント class FPSManager{ ///時間を保存しておくもの DWORD mReserveTime; ///次のFPS更新するときの時間の差分を導くための時間保存 DWORD mFPSReserveTime; ///今のフレームカウント DWORD m_CountFrame; ///2回Beginを呼び出さないようにする。カウンタ保存変数 DWORD m_NowFrame; ///1FPSあたりの時間 DWORD mFPSSec; ///FPSのカウント DWORD mFPSCount; ///今のFPS DWORD mNowFPS; bool mFPSManagementEnable; /*DWORD FrameInit(){ m_NowFrame=0; return m_CountFrame = 0; }*/ protected: DWORD IncCountFrame(){ return m_CountFrame++;} public: DWORD NowCountFrame(){ return m_CountFrame;} FPSManager(){ mReserveTime = 0; m_CountFrame = 0; mFPSSec = 0; m_NowFrame = 0; mFPSCount = 0; mFPSReserveTime = 0; SetFPS(60);//defaultは６０ //FPS管理は行う。 mFPSManagementEnable = true; } void ClearCountFrame(){ m_NowFrame = 0; m_CountFrame = 0; } virtual ~FPSManager(){} ///1フレームに１回呼び出してほしいもの(ループの最初に呼び出すこと void Begin(){ if( NowCountFrame() == m_NowFrame) return; //フレームカウントを代入 m_NowFrame = NowCountFrame(); //次へのタイムを保存 DWORD getTime = ::timeGetTime(); mReserveTime = getTime; //FPSの更新処理 if (getTime - mFPSReserveTime > 1000) { mNowFPS = mFPSCount;//結果を入れるなり mFPSCount = 0; //カウンタをゼロクリア mFPSReserveTime = getTime;//ここで次への時間の差分をゲット！ } } void SetFPS(int seq){ seq *= 2;//なぜかFPSが合わないのでこういう風にするしかない＾＾； //だれかどこが間違っているか教えて＾＾；；； mFPSSec = 1000/seq; } ///@param flag[in] FALSEだとFPS管理を行わない。 void Enable(bool flag){ mFPSManagementEnable = flag; } void FPS_Management(){ } void End() { /*do{ :Sleep(CPU_SLEEP_TIME); }while(::timeGetTime() < wait_time + FPSSec); */ if(true==mFPSManagementEnable) { DWORD t = ::timeGetTime(); if(t < mReserveTime + mFPSSec){ DWORD tmp = (mReserveTime + mFPSSec - t); tmp = (tmp > 20) ? tmp - 20 : tmp; Sleep(tmp); } t = ::timeGetTime(); while(t < mReserveTime + mFPSSec){ DWORD tmp = (mReserveTime + mFPSSec - t); tmp = (tmp > 1) ? tmp - 1 : tmp; Sleep(tmp); t = ::timeGetTime(); } } mFPSCount ++;//FPSカウントをUPするなり！ //フレームをインクリメント IncCountFrame(); } DWORD GetFPS()const{return mNowFPS;} inline int DrawFPS(int x,int y,int color){ return ::DrawFormatString(x,y,color,"FPS = %d",GetFPS()); } }; //********************************************************** //コールバック関数郡 BOOL CALLBACK GetPlayerCollision(BML_PLAYER_CALLBACK_DATA *data){ int x,y; x = gPlayer.getX(); y = gPlayer.getY(); data->collision.left = x; data->collision.top = y; data->collision.right = x + 1; data->collision.bottom = y + 1; // data->result = TRUE; return TRUE; } ///画面から消えたらTRUE BOOL CALLBACK DisplayCheckCollisionCallback(const RECT *myrect,BML_BULLET_DATA *data){ RECT b={data->x,data->y,data->x + 1,data->y + 1}; return (!CheckCollision(*myrect,b)); } //********************************************************** //メイン関数 int WINAPI WinMain( HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow ) { char buff[MAX_PATH];//XMLへのパス //フォルダオープンダイアログを表示 if(edk_Not_Selected == BML_HELPER_OpenBMLSelectDialog(buff,sizeof(buff),NULL)) { return 1; } ChangeWindowMode(TRUE);//Window Mode //DxLibを初期化 if(0 != DxLib_Init()){return -1;} SetDrawScreen(DX_SCREEN_BACK);//back buffer write mode //BMLDLLを初期化 10000個の弾領域、スピードは1、２００個の空き領域保存キュー if(DKUTIL_FAILED(BML_Init(10000,1,200))) {//error return -1; } int SimpleColor = ::GetColor(255,0,0);//赤色 int ActionColor = ::GetColor(0,255,255);//水色 int PlayerColor = ::GetColor(255,255,255);//白 //BulletMLが定義されたXMLを読み込む。 int bml = BML_LoadXMLFile(buff); if(bml==-1) return -1; char dummywork[1]; //フレームをクリア BML_ClearFrame(); //プレイヤーの座標をセット gPlayer.setX(320); gPlayer.setY(240); FPSManager fps; //FPSのウェイトをTRUEにする。 fps.Enable(TRUE); while(ProcessMessage() != -1){ //FPS計測開始 fps.Begin(); if(CheckHitKey(KEY_INPUT_ESCAPE)==1) {//ESCキーが押されたらこのループを抜ける。 break; } //画面をクリア ClsDrawScreen(); # ifdef BML_BENCHMARK if(BML_GetFrame() % 10 == 0 || BML_GetFrame()==0) # else if(BML_GetFrame() % 60 == 0 || BML_GetFrame()==0) # endif {//60フレームに１回生成。 BML_CreateBullet(bml, 320,//生成する座標 240, dummywork,//タスクワーク sizeof(dummywork), GetPlayerCollision//プレイヤーへの座標を得るコールバック関数 ); } //移動処理 //弾の移動　ここでフレームをひとつインクリメント BML_Move(); //プレイヤーの移動 gPlayer.Move(); //この範囲を出たら弾を削除するようにする。 RECT disp={0 - 5,0 - 5,640 + 5,480 + 5}; //コールバック関数を指定して、コリジョンチェック BML_HELPER_HitDelete( &disp,//この矩形をDisplayCheckCollisionCallbackの第一引数に渡す NULL,//NULLだと内部で用意してくれる DisplayCheckCollisionCallback//チェック関数 ); //libBulletMLの処理 BML_Update(); //描画処理　 //弾の描画はヘルパ関数に任せる。 BML_HELPER_DrawBullet(SimpleColor,ActionColor,DrawBox); //プレイヤーの描画 gPlayer.Draw(PlayerColor); //弾数を表示 ::DrawFormatString(0,0,PlayerColor, "弾数 = %d , PlayerX=%d PlayerY=%d", BML_GetBulletNum(),gPlayer.getX(),gPlayer.getY() ); //FPS計測終了 fps.End(); //FPS描画 fps.DrawFPS(0,16,PlayerColor); ScreenCopy(); Sleep(1); } BML_End(); DxLib_End(); return 0; }
   まぁ、こんな感じです。じゃぁソースを見ていきますか。
   まぁ、見たまんま単純な構造なんですけど＾＾；
   DxLibの関数については説明は省きますね。各自DxLibの関数リファレンス見る事＾＾
   
   

2. //BMLDLLを初期化 10000個の弾領域、スピードは1、２００個の空き領域保存キュー
   if(DKUTIL_FAILED(BML_Init(10000,1,200)))
   {//error
   	return -1;
   }
   

   まず、最初にBMLDLLを使うにはBML_Init関数を呼び出します。
   第一引数は弾の領域
   第二引数は弾のデフォルトスピード
   第3引数空き領域管理キューです。
   戻り値はedk_Result型のenumです。
   DKUTIL_FAILEDマクロを使うことで失敗を調べる事が出来ます。
   ですのでこのような構文になっています。

3. //BulletMLが定義されたXMLを読み込む。
   int bml = BML_LoadXMLFile(buff);
   if(bml==-1) return -1;
   
   

   BML_LoadXMLFileは、BulletMLが定義されたXMLを読み込むための関数です。
   読み込んだ後、成功した場合はint型のハンドルを返します。
   −１だとロード失敗です。
   余談ですが、一部にBMLDLLが読み込むとBMLDLL自体がエラーするものがあります。
   それは普通のBulletMLデータではなく、拡張されたBulletMLデータの可能性があります。
   例えば弾幕やさんで取得したBulletMLデータの一つに以下のようなものがあります。以下のようなXML構文のものはエラーになってしまいます。
   ですので、各自、このような弾幕は改造する必要があります。
   <!DOCTYPE bulletml SYSTEM "../barrage.dtd"> <barrage> <barrageInfo> <group>shinichiro_h</group> <title>OKG</title> <description>殺す気まんまんのガラさんです。</description> <capture>避けれるかどうかとかは深く考えていません。</capture> </barrageInfo> <barrageStyles> <!-- bulletml か lua が使えます。 --> <bulletLanguage name="lua" /> </barrageStyles>

4. {//60フレームに１回生成。
   	BML_CreateBullet(bml,
   		320,//生成する座標
   		240,
   		dummywork,//タスクワーク
   		sizeof(dummywork),
   		GetPlayerCollision//プレイヤーへの座標を得るコールバック関数
   	);
   }
   

   さて、一番の肝である弾の生成の部分にきました。
   BML_CreateBullet関数は 第一引数から、X座標、Y座標、タスクワークへのアドレス、タスクワークのサイズ、プレイヤー座標を得るためのコールバック関数へのポインタ です。
   なぜ、第五引数にコールバック関数を入れる必要があるか。
   例えば、二人プレイの出来るシューティングゲームを考えましょう。
   その時、１Playerだけに誘導弾が来てしまったらあまりにも不公平でしょう。
   では、弾が１Playerか２Playerのどちらに移動するかランダムに決めれば良いのでは？
   と思っている方もいらっしゃるかもしれませんが、そうなると、１Playerと２Playerの座標のどっちにいくのかが毎回決められるので、 弾は画面内でブルブル震えるだけになってしまうと思います。
   ですので、コールバック関数を用意したわけです。
   コールバック関数の規定は以下のような感じなります。

   
   BOOL CALLBACK GetPlayerCollision(BML_PLAYER_CALLBACK_DATA *data){
   	int x,y;
   	x = gPlayer.getX();
   	y = gPlayer.getY();
   	//プレイヤーの当たり判定の矩形をRECT型の
   	//BML_PLAYER_CALLBACK_DATA構造体メンバcollisionに入れる。
   	data->collision.left = x;
   	data->collision.top = y;
   	data->collision.right = x + 1;
   	data->collision.bottom = y + 1;
   //	data->result = TRUE;
   	return TRUE;
   }
   

   これだけです。このコールバック関数が成功したならTRUEをreturnするようにします。
   
   

5. //弾の移動　ここでフレームをひとつインクリメント
   BML_Move();
   

   見たまんま、弾の移動関数です。弾を移動させます。
   

6. //libBulletMLの処理
   BML_Update();
   

   これも見たまんま、libBulletMLが内部で行う処理を行います。
   

7. //そして、ソフトを終了する時は以下の関数を呼び出します。
   BML_End();
   

8. さて、ソースコードには出ていませんが、 弾の座標にアクセスして弾を描画したいのですが、どうすればいいのでしょうか？
   BML_CreateBulletと並ぶ肝の部分ですね。
   ///シンプルな弾の格納先へのアドレスを取得 BMLDLL_EXTERN(BML_BULLET_DATA *)BML_GetSimpleBulletAddress(); ///シンプルな弾への格納先のアドレスは添え字を通して何個までアクセス可能かどうかの数字を返す。 BMLDLL_EXTERN(size_t) BML_GetSimpleBulletSentinel(); ///シンプルな弾を削除する。 BMLDLL_EXTERN(void) BML_DeleteSimpleBullet(BML_BULLET_DATA *); ///アクションな弾の格納先へのアドレスを取得 BMLDLL_EXTERN(BML_BULLET_DATA *) BML_GetActionBulletAddress(); ///アクションな弾への格納先のアドレスは添え字を通して何個までアクセス可能かの数字を返す。 BMLDLL_EXTERN(size_t) BML_GetActionBulletSentinel(); ///アクションな弾を削除する。 BMLDLL_EXTERN(void) BML_DeleteActionBullet(BML_BULLET_DATA *);
   こんな感じの関数が定義されています。
   さて、これらの関数を使って当たり判定のサンプルを示します。
   //この範囲を出たら弾を削除するようにする。 RECT disp={0 - 5,0 - 5,640 + 5,480 + 5}; { size_t sentinel = BML_GetSimpleBulletSentinel(); BML_BULLET_DATA *a = BML_GetSimpleBulletAddress(); for(size_t i=0;i<sentinel;i++) { BML_BULLET_DATA *d = &a[i]; if(ebmlSIMPLE_BULLET==d->flag) {//もし、弾領域がSimpleBulletだったら。 RECT r={d->x,d->y,d->x + 1,d->y + 1}; if(false==CheckCollision(disp,r)) {//画面外を出た。 BML_DeleteSimpleBullet(d); }else {//有効だったら描画 DrawBox(d->x,d->y,d->x + 1,d->y + 1,GetColor(255,0,0),TRUE); } } } } { size_t sentinel = BML_GetActionBulletSentinel(); BML_BULLET_DATA *a = BML_GetActionBulletAddress(); for(size_t i=0;i<sentinel;i++) { BML_BULLET_DATA *d = &a[i]; if(ebmlACTION_BULLET==d->flag) {//もし、弾領域がActionBulletだったら。 RECT r={d->x,d->y,d->x + 1,d->y + 1}; if(false==CheckCollision(disp,r)) {//画面外を出た。 BML_DeleteActionBullet(d); }else {//有効だったら描画 DrawBox(d->x,d->y,d->x + 1,d->y + 1,GetColor(0,255,255),TRUE); } } } }
   まぁ、こんな感じですね。
   このサンプルを見ればもう明白なはずです。イテレーションの仕方、削除の仕方等。
   ちなみに、このサンプルの描画部分をまとめたのがBML_HELPER_DrawBullet関数です。
   そして、画面外に出たら削除をしている部分をまとめたのがBML_HELPER_HitDelete関数です。
   
   
9. さぁ！最後ですね。つかみはとれましたでしょうか？口癖のようですが、まぁ、こんな感じです。
   BML_HELPER系の関数は一部しか説明してませんでしたね＾＾；
   えーっと、これらは私が便利にする為に作った関数類なので各自、関数リファレンスを見てください＾＾；
   さて！まとめです。いままでのフローチャートを見ましょう。
   

   
   BML_Init();
   loop *1
    特定のタイミングでBML_CreateBullet
    BML_Move
     GetAdress系GetSentinel系を駆使して
     弾データアクセスしてコリジョンチェック *2
    BML_Update
     *2と同じく、描画を行う。
   }*1に戻る。
   BML_End();
   
   

   こんな感じです。 超簡単ですね＾＾いや〜これで超簡単に弾幕シューティングが出来るようになりますよ！作った甲斐があった〜〜ヽ(´ー｀)ノ万歳
   ではでは、またの機会にでもお話に付き合ってくれるとうれししいです。
   
   Thank you very much！
   
   

---

Licence (使用条件)

BMLDLLのdoxygenマニュアルの方をご覧下さい。

---

---

Download

こちらからダウンロードして下さい。
また、Vectorでもダウンロード出来ます。（最新版ではない事が多い）

---

Frequently asked question(よく聞かれる質問)

技術的質問

Ｑ： BMLDLL.dllが無いとWindowsに怒られるのですが、
Ａ：BMLDLL.dllを自分のアプリケーションと同じフォルダにいれてください。

著作権に関して。

Ｑ： BMLDLL.dllは再配布自由ですか？
Ａ：自由にしてかまいません。