緊急企画DirectXを使おうの巻・その１

　今回は、「緊急企画」としてHSPでDirectXを使う方法について触れます。まあ別に緊急である意味はないですけど、いきなり飛んでDirectXの使い方だからね。それに最近ちっとも新しいことやっていないし。・・・いいのッ！　緊急なのッ！(←急な逆ギレ)

2001/06/02追記：いい加減情報が古くなってきたり変なことが書いてあったりするので一部HSPDXFIXと絡めて書き直すことにします。

●準備しよう
　つうことで、DirectXなのです。まず、マシンとかOSとかHSP本体以外に以下のものを用意してください。

• DirectＸプラグインDLL(HSPDX.DLLもしくはHSPDXFIX.DLL)
• DirectX3以上(5以上を推奨)
• ヘッダファイル(HSPDX.ASもしくはHSPDXFIX.AS)

　はーい、順に説明しましょう。まずプラグインは、HSP ver2.4g以降を使っているならダウンロードしたときに入ってるはずだから、問題ないよね。「DIRECTX」ってフォルダにあると思うよ。HSPDXFIX.DLLってのはHSPDXのバグ取り改良品のこと。ウチのダウンロードページより落としてね。詳細は追って説明するよ。
　じゃー次。DirectXは今の環境なら必ず入っているので問題ないでしょう。最新のバージョンを入れた方がいいとかってことは有りません(たぶん)。ヘッダはHSPDX(FIX).DLLと一緒に入っているはずなので、これも問題なし。ちなみにヘッダファイルとは外部命令の情報などをまとめたファイルのことです。

●プログラミングの手順
　これってマニュアルにも書いてあるから、なんか手抜きっぽくて申し訳ないけど、プログラムは以下のような手順で組むのだ。なお、どういう命令を使えばよいかは下の方にあるスクリプトと照合してね。

1.初期設定

1. DirectXの初期化
   　これをしなきゃDirectXはいつまでたっても使えません。まずDirectXを使用可の状態にし、続いてフルスクリーンに画面を変更します。ちなみに、DirectXで画面をフルスクリーンにするので従来のようにウィンドウやアイコン等が左上に寄ったりすることはありません(のはずだが、一部のアプリケーションは解像度を変更した際に影響を受けることがあるようで・・・)。
2. エラー処理
   　DirectXの初期化やフルスクリーンへの変更に失敗した状態で処理を続けるとどうなるかは定かではないし、怖くてできません(多分何事もなかったようにWindowsに戻ってくると思いますが)。
3. 画面の初期化
   　フルスクリーンしたての画面には、白黒のデスクトップ(一部)と変な模様が表示されています。これを消去してきれいにしましょう。でもこれって後でもできるからどっちでもいい気がするけどね。
   　このあと、フルスクリーンに切り替わる際にディスプレイのモードも切り替わるのでウェイトを入れておくといいでしょう(画面がディスプレイに完全に表示される前に処理を行わないようにする。そうしないと目で確認できないうちから動き出すので出だしの確認が難しい)。

2.メイン処理

1. 画面を消去
   　es_clsで画面を消します。前に描画した画面が残っているので新たに書き直すわけです。ただし、画面全体を不透明な背景画像でコピーする場合はやらない方が速度を稼げます。
2. 各種処理(画面描画以外)
   　ごくごく普通に。べつにDirectXだからといって特に意識すべきことはありません。
3. 画面描画
   　もちろんBと平行して行っても問題ありません。注意すべきことは、ウィンドウの描画に使っていた命令(gcopy,boxfなど)は使えないということです。DirectX固有の命令のみで行ってください。
4. 画面を更新
   　DirectX使用時は描画命令を行った時点では画面表示は更新されず、es_syncという命令を実行してはじめて画面が書き変わります。常に「redraw 2」の状態になっていて、一通り描画を終えたら「redraw 1」に変更するのと同じようなものです。
5. Windowsにタスクを渡す
   　いくらDirectXを使っていようが、OSにタスクを渡してやることが約束です。ただし、es_sync命令はウェイトを兼ねているのでここでさらにウェイトをかける必要はないでしょう。
   　余談ですが、HSPDXFIX使用時、awaitでウェイトを取らなければCPU使用率が常時100%になることはありません。
6. 緊急脱出機能
   　DirectX使用中は[Ctrl]+[Alt]+[Del]による強制終了はできませんので、特定の操作で終了するように処理を作っておかなくてはなりません。万が一忘れた場合はリセット以外に抜け出す術はないはずです。別にここである必要はないのですが。
   　・・・と書きましたが、[Alt]+[F4]にて中断することはできます。ただし、Windowsにタスクが渡っていることが条件となります。つまり、きちんとawaitを行っていれば脱出可能というわけです。

3.終了処理

　まあどちらでもよいのですが、最後に後始末を行っておきましょう。このとき、一瞬パレットが化けるのが気になる人は画面消去と更新を2回行うと効果的です。

●組み方
　以上簡単に手順を説明しましたが、ではどんな命令を使えばいいのかとか、そういう部分に突っ込んでいきたいと思います。

• DirectXの初期化
  　まず、「es_ini」でシステムを初期化します。つづいて、「es_screen p1,p2,p3,p4」でフルスクリーンにします。パラメータは、最初の二つが画面解像度です。800*600位を越えると処理速度にも影響しますので(最近のビデオカードなら平気か?)、通常は(320,240)か(640,480)で十分でしょう。ちなみに数値を間違えると実行できませんので、解像度はあらかじめ「画面のプロパティ」にて確認しておきましょう。次が、カラーモードですが、HSPでは現在256色(8Bit)しかサポートしていないので「8」を指定します。最後のパラメータが、パレットモードの色数の設定です。「0」(236色)「1」(254色)「2」(256色)の3種類がありますが、ビデオカードによっては256色フルに使うことができないものもあるので普段は「0」にしておき、足らない場合に「1」にするといいでしょう。
  　HSPDXFIXではウィンドウモードをサポートしています。「es_screen」のp4に「3」を指定することでウィンドウモードになります。
• 画面の消去
  　ウィンドウへの描画命令は無効になるので、「cls」ではなく「es_cls p1,p2,p3」を使います。パラメータにRGB値を指定することで画面を消去する色を(近い色のパレットが存在する範囲で)自由に決めることができます。
• 画面更新
  　すでに書いていますが、「es_sync p1」を実行してはじめて画面が更新されます。p1はウェイトの長さをms単位で指定します。省略してもウェイトはかかりますが、ディスプレイのリフレッシュレートによっては処理速度が変わってしまいますので「1000/目標FPS」を入れましょう。
• 終了処理
  　「es_bye」で終了です。なお、これはクリーンアップ関数といってプログラム終了時に自動的に実行されるようになっているので忘れてもあまり問題はなかったりします。
  　HSPDXではここでプログラムが終了してしまいます。HSPDXFIXではこの後通常ウィンドウで処理ができますが、stopが利かないなどの問題を抱えています(・・・)。

●画面描画の方法
　HSPのDirectXには点や線、丸といった図形を描画する命令はほとんどありませんので、ここでは「画像をコピーする方法」について触れます。

1. ウィンドウのバッファに画像を読み込む
   　DirectXのバッファに画像を転送するために、まず(DirectXを使わない通常の)バッファに画像を読み込みます。
2. DirectXのオフスクリーンバッファに転送する
   　そのまま「es_buffer p1,p2」を実行して画像をオフスクリーンバッファへ転送します。このとき、一緒にパレットも転送されます。パラメータp1はバッファのID、p2はVRAMとメインメモリのどっちに転送するかの指定です。通常は多くのユーザーに遊んで(利用して)もらうためにも「2」(VRAMにバッファを確保し、できなかった場合メインメモリに確保)を指定したほうがよいでしょう。
   　バッファIDはHSPDXが0〜7(マニュアルには9までと書いてあるが、実際には7までしかとれません)、HSPDXFIXでは0〜63までとなっています。
   　ちなみにメインメモリにバッファを確保した場合、そのバッファから画像をコピーする速度が低下するので覚悟しましょう。
3. 座標等を設定する
   　では、画像を画面に表示する準備です。あらかじめ「gmode p1,p2,p3」で転送モードとコピーする画像のサイズを指定しておきます。p1が転送モード(0:不透明、1〜2:透明)です。そして、「pos p1,p2」でコピーする位置を指定します。この辺は従来とほとんど一緒ですので、簡単ですね。ちなみに拡大(縮小)表示をしたい場合、「objsize p1,p2」で表示するサイズを指定しておく必要があります(マニュアルにはobjsizeがコピーする画像のサイズになり、gmodeが表示サイズになると記述されていますが、これは誤りです)。
4. 表示!!
   　そして、「es_copy p1,p2,p3」でバッファから画面へコピーしてめでたく画像が表示されるわけです。p1がバッファID、p2,p3でコピーする画像のある座標を指定します。

　異なるサイズの画像をコピーする場合、es_copy命令でコピーする画像サイズを指定することができないのでそのつど変更する必要がありますことと、objsizeの意味がウィンドウ描画のときと異なることを注意すれば、従来のウィンドウ描画とほぼ同じ間隔で使えます。

●透明色について
　画像を転送する際に色を抜く「透明色」ですが、HSPDXではバグでパレット0番の色しか使えません(黒である必要はありません。ビデオボードに依存するかもしれませんが)。HSPDXFIXではes_bufferの第3パラメータで任意の色を透明色に指定したり、黒を自動的に探し出したりできます。

●やってみよう
　てことで、簡単なサンプルを組んでみました。ランダムに「HOT SOUP PROCESSOR」という文字列を表示するというものです。DirectX使用版と未使用版の二つを用意しました。全部大文字で組んであるので、見づらいスクリプトですいません(^^;。

RANDOMIZE
SCREEN 0,640,480,1
BUFFER 2,256,64,1
PICLOAD "FONT.BMP"
GSEL 0
CLS 4
GMODE 1,16,16
PALCOPY 2
COLOR 0,0,0

*MAIN
;REDRAW 2
STICK S,0
IF (S&128) : END
RND MOJIX,79
RND MOJIY,30
MOJI="HOT SOUP PROCESSOR"
GOSUB *FPUT
;REDRAW 1
AWAIT 0
GOTO *MAIN

*FPUT
STRLEN LNG,MOJI
REPEAT LNG,0
PEEK PMOJI,MOJI,CNT
PMOJI-=32
CPX=(PMOJI\16)*16
CPY=(PMOJI/16)*16
POS MOJIX*8,MOJIY*16
GCOPY 2,CPX,CPY,16,16
MOJIX+=2
IF MOJIX>78 : MOJIX=0:MOJIY=(MOJIY+1)\30
LOOP
RETURN

#include "HSPDX.AS"

RANDOMIZE
ES_INI
ES_SCREEN 640,480,8,0
IF STAT : GOTO *DDERR1
GOTO *START
*DDERR1
END

*START
BUFFER 2,256,64,1
PICLOAD "FONT.BMP"
ES_BUFFER 0,2
IF STAT : GOTO *DDERR1

GSEL 0
ES_CLS
ES_SYNC
WAIT 100
GMODE 0,16,16
COLOR 0,0,0

*MAIN
STICK S,0
IF (S&128) : GOTO *FINISH
RND MOJIX,79
RND MOJIY,30
MOJI="HOT SOUP PROCESSOR"
GOSUB *FPUT
MOJIX=0
MOJIY=0
MOJI=TM
STR MOJI
GOSUB *FPUT
ES_SYNC
TM=STAT
AWAIT 0
GOTO *MAIN

*FINISH
REPEAT 2
ES_CLS
ES_SYNC
AWAIT 0
LOOP
ES_BYE
END

*FPUT
STRLEN LNG,MOJI
REPEAT LNG,0
PEEK PMOJI,MOJI,CNT
PMOJI-=32
CPX=(PMOJI\16)*16
CPY=(PMOJI/16)*16
XX=MOJIX*8
YY=MOJIY*16
POS MOJIX*8,MOJIY*16
ES_COPY 0,CPX,CPY
MOJIX+=2
IF MOJIX>78 : MOJIX=0:MOJIY=(MOJIY+1)\30
LOOP
RETURN

　処理ごとに色分けをしてあるので、照らし合わせて変更点を探してみましょう。

• 紫：初期設定
  　そんなに大きな変更はありませんね。一度es_screenの第1、2パラメータを変更して解像度が変わるところを楽しんでみてください。
• 赤：画像読み込み
  　バッファに画像を読み込み、メインのスクリーンにグラフィック操作先を戻すところまでを一かたまりとしています。picloadの後にes_bufferでオフスクリーンバッファへ画像を転送しています。後半部分の「es_cls」、「es_sync」はゴミ消し、その後の「wait 100」はディスプレイが変更されて完全に画像が表示されるまでのウェイトです。
• 緑：メインルーチン
  　DirectX版の方はついでで処理時間を表示するようになっています。ちなみにDirectX未使用版でコメントをはずしてredraw命令を有効にすると処理速度が低下します。この程度の処理ならredrawを行わない方が高速に処理できるようです(いや、組み方が悪いのかも・・・)。
  　「es_sync」で画面を更新した後、システム変数statを参照することで経過時間を知ることができます。
• 黄：フォント表示ルーチン
  　「gcopy」が「es_copy」に置き換わっているだけです。ほとんど一緒です。
• 白：エラー処理、終了処理(DirectX版のみ)
  　エラー処理は、はっきりいって手抜きです(^^;。もっとちゃんとした処理を組みましょう(笑)。人に教えるためのスクリプトでこんなにいい加減なことしてはいけません(爆)。
  　終了処理では画面消去を2回行っていますが、これはプログラム終了時に一瞬パレットが化けるのが気になるので画面をきれいにしてパレットの変更がわからないようにしているのです。普通はこんな事しなくてよいですが、一度この処理をはずしてみて気になる人はこうしておきましょう(といっても単色なので、HSP付属のサンプルで行うほうがわかりやすいですが)。

　結論をいうと、そんなに変更点はありません(当たり前といえば、当たり前かもしれないけど)。マニュアルを読むとファーストインプレッションで投げ出したくなるかもしれませんが、サンプルプログラムをいじったりしてみれば意外と簡単だって事がわかるかと思いますので色々試してみましょう。

　なお、このスクリプトはフォントデータが無いのでこのままでは実行できません。ここに載せたスクリプトともう一つ別のスクリプトの2種類と一緒にフォントデータ(拙作「MZ味」の流用ですが)を同梱したものを用意しましたのでダウンロードして確認してみてください。
　で、実行してみるとわかりますが、バックバッファが2画面存在するせいで(多分)画面がチラチラします。同じ事を2回書き込めばちらつきはなくなりますが、処理が秒間30フレーム以下になってしまいDirectXを使う意味がなくなりますよね。ってことで画面は1フレームごとにes_clsで消しましょう。そして、こういう処理を行わないようにしましょう。っつうかダメなプログラム示してどうするって感じもしますが(^^;。

●オフスクリーンバッファについて
　オフスクリーンバッファというのはDirectXを使うときに画像を保存しておくバッファのことですが、このバッファのサイズはどれだけ割り当てられるのかということなどはキチンと把握しておかないとスプライトなどを使うときに誤動作の原因にもなりますので、ここにいろいろ書いておこうと思います。

• オフスクリーンバッファのサイズはバッファを割り当てたときの仮想画面のサイズになる
  　ここでは、「仮想画面」＝「ウィンドウのバッファ」と考えてください。buffer 2,320,240,1として、オフスクリーンバッファを割り当てた場合オフスクリーンバッファのサイズは320*240になります。
• バッファのサイズは640*480以上確保できる
  　マニュアルには「640*480まで」とありますが、それは画面解像度に640*480を指定した場合の話で、解像度を640*480以上に設定した場合はそれにあわせてそれ以上のサイズのバッファを確保することは可能です。また、マニュアルの誤読からか「画面解像度(640*480)以上のバッファは確保できない」という情報が広まっていますがそう言い切ってしまうのは間違いで、画面解像度以上のバッファを確保することは可能です。ただし、ビデオボードによっては「縦には伸ばせるが横に伸ばすことはできない」ものが有りますので、注意が必要です。
  　で、何を言っているのか意味がわからないと言う人のために簡易診断プログラムを作ってみました。下のスクリプトを実行し、表示されたメッセージによって自分の環境ではどのようにバッファが取れるのかわかります。「画面解像度以上の〜」と出たらどんな大きさのバッファでも確保可能、「縦に長い〜」と出たら横は画面解像度までだが縦にはいくらでも確保可能、「〜作成不可能」と出たら画面解像度までです。

  #include"hspdxfix.as" es_ini resox=320 resoy=240 es_screen resox,resoy,8,0 if stat : end buffer 2,resox*2,resoy*2,1 es_buffer 0,2 wait 100 if stat=0 : result="画面解像度以上のバッファを作成可能":goto *finish buffer 2,resox,resoy*2,1 es_buffer 0,2 wait 100 if stat=0 : result="縦に長いバッファを作成可能":goto *finish result="画面解像度以上のバッファは作成不可能" *finish es_bye wait 100 dialog result,1 end

• バッファはとりあえず確保しておくべし
  　es_xferを使って、別のバッファへ画像をコピーするときに確保していないバッファへコピーしようとするとエラーになります(終了する)。また、バッファより大きいサイズの画像をコピーしようとするとこれまたエラーになります。
  　これは、「640*480の左上1/4に画面を描画したものを別のバッファにコピーしてから拡大し、擬似的に320*240で表示する」というようなことをしたいときに知らないと苦戦します。筆者のように(^^;。そういうことをやりたいときはあらかじめ320*240以上のカラのバッファを確保しておく必要があります。よくよく考えれば、当たり前なのですが。

●es_xferの使い方
　なんだか上の文章よくわかりませんね(^^;。この文章とあわせることでes_xferを使うときにこういうことに気をつけないと誤動作しちゃうよーっていうネタフリになるわけですが、es_xferの使い方を簡単に触れておきます。

1. 前もって画面解像度と同じくらいのバッファを用意する
   　ふつう画像を読み込んだバッファをつぶすようなことはしないので、下のスクリプトのようにカラのバッファを用意しておく必要が出てきます。これを忘れるとes_xferは役には立ってくれません。

   buffer 2,640,480,1 cls 4 es_buffer 0,2

2. gmodeでサイズとモードを設定する
   　ここはほかのグラフィック操作命令と一緒です。
3. posでコピー先の座標を指定する
   　間違えてはいけないのは、posはコピー先の座標を指定するということです。間違えてコピー元の座標を指定してしまうとうまく動かなくなります。
4. es_xferでコピーする
   　さらに気をつけてほしいのは、パラメータが転送先のバッファID、転送元のバッファID、転送元の画像の座標の順であるということです。特に最初の二つは間違えるとえらいことになりますので間違えちゃいけません。
   　このとき、コピー先のバッファをはみ出したり(はみ出しは問題ないようです)、存在しないバッファへコピーしようとするとエラー(終了)になります。
   　バッファIDは、es_bufferで割り当てたバッファのほかに、現在表示されている画面(-1)や描画中の画面(-2)を指定できます。描画中の画面を4倍に拡大して表示するには、下のようにします。

   gmode 0,160,120 objsize 640,480 pos 0,0 es_xfer 0,-2,0,0 pos 0,0 es_zoom 0,0,0

　スプライトの使い方は第2回で。

戻る