SlimDXでDirect2Dのキーボード入力

Direct2Dのキーボード入力！

なんて言っても、Direct2Dはあくまで描画するための道具ですので、キーボードとかマウスとかゲームのコントローラー（ジョイパッド）などから入力を受け取りたいときは全く別の道具を使わないといけません。

じゃあ何を使うのか？

そりゃあもう何でも使っていいんじゃないでしょうか。
あなたのお気に入りのものを使っちゃってください。何せDirect2Dは描画するための道具ですから、入力とはぜんっぜん関係ありません。

ただしここでは３つの方法を紹介します。

１．フォームのイベントを用いる方法
２．SlimDXのRawInputを用いる方法
３．SlimDXのDirectInputを用いる方法

扱いが楽なのは１，２，３の順
応用が利くのは３，２，１の順
という感じですかね。



１．フォームのイベントを用いる方法

Direct2DやDirect3Dを使っていると、私には「DirectXがウィンドウを乗っ取った！」という感覚があります。だから入出力含めあらゆる操作にDirectX流のやり方があるのだと。
DirectXを使ってみる前やDirectXの使い始めはそういう考えを持っていました。だからなかなかDirectXの世界に入り込めませんでした。

しかし、使ってみて分かってきたのですが、DirectXは通常のフォームアプリと仲良く楽しく一緒に使えるように作られています。
Direct2Dの場合、何もしないと単なるねずみ色になってしまうフォームの描画を肩代わりするだけです。よって、フォームに元から付いている機能はほぼ全てそのまま活用できます。

フォームには元からKeyDown、KeyPress、KeyUpイベントがありますが、それもそのまま活用できます。
以下は、フォームのタイトルが、押されたキーの名前になるサンプルです。

using System;
using System.Drawing;
using System.Windows.Forms;
using SlimDX;
using SlimDX.Direct2D;
using SlimDX.Windows;

namespace DirectInputSample
{
    static class Program
    {
        [STAThread]
        static void Main()
        {
            var form = new RenderForm("SlimDX - Keyboard Sample");
            var factory = new Factory();

            var target = new WindowRenderTarget(factory,new WindowRenderTargetProperties(){
                Handle = form.Handle,
                PixelSize = form.ClientSize
            });

            form.KeyDown += (sender,e) =>{
              form.Text = e.KeyCode.ToString();
            };

            MessagePump.Run(form, () =>
            {
                target.BeginDraw();
                target.Clear();

                target.EndDraw();
            });

            foreach (var item in ObjectTable.Objects)
                item.Dispose();
        }
    }
}

Direct2Dの基本については[SlimDXでDirect2D]を参考にされてください。

            form.KeyDown += (sender,e) =>{
              form.Text = e.KeyCode.ToString();
            };

ここで、KeyDownイベントが発生したときの処理を書いています。キーコードをフォームのタイトルにしているだけですけどね。ちなみにここでは匿名メソッド偉い人の解説という手法を用いています。本当はフォームのイベントに対して匿名メソッドを使うのはあまりよろしくありません。これはサンプルですから、なるべくMain関数に全ての処理を書きたいのでわざと使用しました。





２．SlimDXのRawInputを用いる方法

次はSlimDXに付属しているRawInputを用いる方法です。

RawInputはDirectXの機能ではありません。それとはまた別のWindowsの機能です。RawInputについては検索してもあんまりヒットしませんがだいたい概要は掴めると思います。Microsoftの解説ページ（英語）を見てみるとわかりますが生入力（エロい）というだけあって実に低レベルで使いにくそうです。マウスの入力に直に触れちゃう感じなんだと思います。

しかし心配は要りません。そのRawInputをラップしたSlimDXバージョンは実に使いやすいですから。個人的には後に紹介するDirectInputよりもこちらのほうが好きです（設計美的に）。

それじゃあサンプルです。

using System;
using System.Drawing;
using System.Windows.Forms;
using SlimDX;
using SlimDX.Direct2D;
using SlimDX.Windows;
using SlimDX.Multimedia;
using SlimDX.RawInput;

namespace DirectInputSample
{
    static class Program
    {
        [STAThread]
        static void Main()
        {
            var form = new RenderForm("SlimDX - Keyboard Sample");
            var factory = new Factory();

            var target = new WindowRenderTarget(factory,new WindowRenderTargetProperties(){
                Handle = form.Handle,
                PixelSize = form.ClientSize
            });

            Device.RegisterDevice(UsagePage.Generic,UsageId.Keyboard,DeviceFlags.None);
            Device.KeyboardInput += (sender,e) =>{
                form.Text = e.Key.ToString();
            };

            MessagePump.Run(form, () =>
            {
                target.BeginDraw();
                target.Clear();

                target.EndDraw();
            });

            foreach (var item in ObjectTable.Objects)
                item.Dispose();
        }
    }
}

キーボードから入力があると、押された文字がフォームのタイトルに表示されます。
では説明します。

using SlimDX.Multimedia;
using SlimDX.RawInput;

RawInputを扱うにはこの２つの参照を加えないといけません。SlimDX.Multimedia名前空間にはUsage（後で説明）に関するものが入っています。

            Device.RegisterDevice(UsagePage.Generic,UsageId.Keyboard,DeviceFlags.None);

ここでキーボードを登録しています。さて、SlimDXのRawInputではこのように、Deviceという名の静的クラスを用います。入力装置は１つしかないのでインスタンスを生成する必要は無いのです。
で、このコード、なんだか意味が分からないですよね。そもそもキーボードを登録って意味不明だし！　Usage？　うさげって何だよ！　うさぎの毛？　かわいいな！
……RegisterDevice関数はデバイスを登録するということです。デバイスというのは日本語では装置。つまりキーボードやらマウスやらのことです。本来そういうのは繋がってさえいれば使えるはずです。面倒ごとはWindowsさんがやってくれます。しかし、RawInputの仕組みがデバイスの登録制なのです。デバイスから生入力（エロい）を受け取るにはそのデバイスを登録しないといけませんよ、とそういうことです。
で、うさげ(Usage)というのは調べるとややこしいのですが、RawInputでは単純にデバイスの識別に使われているようです。UsagePageをGenericに、UsageIdをKeyboardにするとキーボードになります。
DeviceFlagsというのは、UsagePageとUsageIdで提供された情報をどう解釈するか決めるものです（直訳）。まあ、オプションと考えてください。現在特別なオプションを付けないのでNoneです。もしこれを

            Device.RegisterDevice(UsagePage.Generic,UsageId.Keyboard,DeviceFlags.InputSink,form.Handle);

としたならば、別のウィンドウをアクティブにした状態でもキーボード入力に反応するようになります。

            Device.KeyboardInput += (sender,e) =>{
                form.Text = e.Key.ToString();
            };

ここでキーボードから何らかの入力があったときの動作を書いています。今の状態だとマウスが押されたとき、離されたときのどちらも反応します。もし離されたときのみにしたいならばStateプロパティを用いて、

              if(e.State==KeyState.Released){
                form.Text = e.Key.ToString();
              }

とします。




３．SlimDXのDirectInputを用いる方法

DirectInputはDirectXです。これが一番高機能です。リファレンスを見ると沢山のクラスがずら～っと並んでいます。DirectXですので文献も豊富です。検索数で比較してRawInput（エロい）の１０倍以上あります。

ただし、SlimDXバージョンは部分的に上手く設計されていません。個人的にキライ。
でも他に代わる物が無ければ使うしかありません。

んではサンプルです。

using System;
using System.Drawing;
using System.Windows.Forms;
using SlimDX;
using SlimDX.Direct2D;
using SlimDX.Windows;
using SlimDX.DirectInput;

namespace DirectInputSample
{
    static class Program
    {
        [STAThread]
        static void Main()
        {
            var form = new RenderForm("SlimDX - DirectInput Sample");
            var factory = new Factory();

            var target = new WindowRenderTarget(factory,new WindowRenderTargetProperties(){
                Handle = form.Handle,
                PixelSize = form.ClientSize
            });

            var di = new DirectInput();

            var keyboard = new Keyboard(di);
            keyboard.SetCooperativeLevel(form.Handle,CooperativeLevel.Foreground|CooperativeLevel.Nonexclusive);
            keyboard.Properties.BufferSize = 4;

            MessagePump.Run(form, () =>
            {
              if(keyboard.Acquire().IsSuccess){
                foreach(var state in keyboard.GetBufferedData()){
                  foreach(var key in state.PressedKeys){
                    form.Text = key.ToString();
                  }
                }
              }

              target.BeginDraw();
              target.Clear();

              target.EndDraw();
            });

            foreach (var item in ObjectTable.Objects)
                item.Dispose();
        }
    }
}

DirectInputでは入力があった場合、それをバッファに一度貯めておきます。そして、任意のタイミングでそれを取得できます。これは本来ＯＳがやってくれることですが、DirectInputではそこまで自在に操れるということです。このサンプルでは描画の直前に取得しています。
さらに、複数のキーが同時に押された場合というのも識別できるようです。私のキーボードではそのような状況を発生させることができませんでしたが……。

using SlimDX.DirectInput;

DirectInputを用いる場合はSlimDX.DirectInput名前空間への参照を加えます。

            var di = new DirectInput();

ここでDirectInputで色々なデバイスを使うためのDirectInputクラスのインスタンスを作ります。
とてつもなく意味の分からないクラスですが、とりあえずこれを作らないといけません。

小言になりますが私が気になるのはここでして、ここで作ったインスタンスを使えばなぜかキーボードやらマウスやらを使うことができます。まるでシステムに繋がっているかのようです。このことは直感に反します。インスタンスの生成はあくまで生成するだけで、そこで作られたインスタンスは何とも繋がっていないはずです。もしインスタンスの生成時点で他のものとの関連を持たせるならば、コンストラクタに何らかの引数を与えるか、静的なCreateDirectInputメソッドでも用意してそれで生成させるべきです。

            var keyboard = new Keyboard(di);

ここでキーボードを作っています。残念ながら痛キーボードにするような設定はできないみたいです。

            keyboard.SetCooperativeLevel(form.Handle,CooperativeLevel.Foreground|CooperativeLevel.Exclusive);

作ったキーボードの協調レベルを設定します。協調レベルというのはまたの名を共同組合レベルと言い、他のアプリケーションとの間でどのようにキーボードを奪い合うかということです。
現在のアプリケーションはフォームですのでフォームのハンドルを渡しています。
Foregroundの場合はアプリケーションがアクティブになっているときしかキーボードにアクセスできません。Backgroundになると別のアプリケーションがアクティブになっているときでもキーボードにアクセスできます。
Exclusiveの場合はこのアプリケーションがキーボードにアクセスしている間、別のアプリケーションからキーボードにアクセスできなくします。Nonexclusiveになると別のアプリケーションもキーボードにアクセスできるようになります。ちなみに実際にはアクセス権の取引によりこういうことを実現しています。。
この他にNoWinKeyというのがあります。これを設定すると、キーボードにWIndowsマークのキーがあると思いますが、そのキーを押したときにWindowsのメニューを出さなくします。

            keyboard.Properties.BufferSize = 4;

ここでキーボードの入力を貯めるバッファのサイズを決めています。初期値が0らしく、わざわざ設定しています。4としたことに特に意味はありません。

              if(keyboard.Acquire().IsSuccess){

Acquireメソッドでアクセス権を取得しています。協調レベルがForegroundのときなどに失敗することがあるので、成功したときということでif文を使っています。

                foreach(var state in keyboard.GetBufferedData()){

GetBufferedDataメソッドでバッファに溜まっている全てのデータを取得します。そしてforeachでそれら１つずつに対して処理を行っています。

                  foreach(var key in state.PressedKeys){

押されている全てのキーを取得します。そしてforeachでそれらｈ(ry


DirectInputは高機能な故に簡単なことをするのにも手間がかかりますね。ちゃんと説明できている気がしませんし。なるべくリファレンスを読むようにお願いします。



ところで、３つ紹介しましたがどれをどう使い分けるか気になりますよね。１の方法はちょっと低機能すぎるかなという気がします。対して３はとにかく使いにくいです。やっぱり個人的にはRawInput（エロい）がステキかな。

なんか今回はまじめに書いた気がします。前の記事との間に時間が空いたので真面目になったのですね。せっかくなので今聴いている作業用ＢＧＭを載せておきます。

[SlimDXでDirect2Dの記事まとめ] に戻る