SlimDXでDirect2DのWPF連携

Direct2DとWPFでググって出てくるサイトはここですね。


ここを読むとWPFでDirect2Dを使う方法がわかるようです。

ふむふむ、なるほど。そういうことだったのか！



……まったく分からん

最初はリンク先の図すら分からなかったのですが、調べるうちにだんだんと分かるようになってきました。そのことと、簡単に連携させる方法をこの記事で書こうと思います。
簡単に連携させる方法はWindowsFormsHostクラスを使う方法で、調べる前から知っていたのですが、あまりスマートじゃない気がしていました。それで色々調べていたのですが、他の方法が難しすぎるので、もうこの方法でいきたいと思います。実際に検証してみればわかりますが、速度も遅いということはありません。



まずはWPFの復習からやりましょうか。
復習と言ってもこのブログでは書いたことが無いし、書いていたホームページはもう閉鎖してしまいましたから、実際には初になるでしょう。

WPF(ウィンドウズ・プレゼンテーション・ファウンデーション)の厳密な説明はウィキペディアを参考にしてください。WPFはXAMLというものと一緒に出てきたため、またマイクロソフトがよくわからないことを始めた（やれやれ）と思われがちです。実はXAMLなんて全く必要ありません。これまでのC#言語でそのまま扱うことができます。
WPFはこれまでのフォーム（ウィンドウ）アプリケーションの後継と 考えることができます。フォームと同じようにボタンやテキストボックスといった部品を配置できます。従来のフォームアプリケーションの基本的な部品に加え て、円や四角といった図形もフォーム部品と同じように扱うことができるようになっています。さらには３Ｄ図形や動画までペタペタと配置することができます。そんなこのとができるのは、裏でDirectXを使っているからです。

……と、こんなことを昔書いていました。ここに書いているようにWPFはDirectXを使っています。Direct3D9です。

そして、Direct2Dが使っているのはDirect3D10.1です。このDirect3D9とDirect3D10.1を連携させるのが難しい。難しすぎるのです。

Direct3Dのバージョンは9から、9Ex、10、10.1、11となっており、9から10.1は結構離れています。ちなみに9Exと10の連携は簡単らしいです。そして、10.1以降はDXGI1.1というインターフェースを備えているので10.1と11の連携は簡単です。
しかし、9と10.1の連携は難しいのです。

私はWPFがいつかDirect3D9から別のバージョンに移ってくれると思っているので、わざわざ9と10.1の連携をやる気はありません。
いいですか？　やる気が無いだけで、決してやろうとしてできなかったわけじゃないですからね！


さて、では、簡単に連携させる方法を書きましょう。動かすのは[SlimDXでDirect2D]と同じで背景を真っ黒にするだけのものです。
ちなみにこの方法はDirect2D以外でも利用できます。

最初にWPFのウィンドウを表示させるプログラムを載せます。その後でそのプログラムにDirect2Dの部分を追加します。

using System;
using System.Windows;

namespace WPFSample
{
    public class OriginalWindow : Window
    {
        public OriginalWindow()
        {
            this.Title = "WPF Sample";
        }
    }

    class Progarm
    {
        [STAThread]
        static void Main()
        {
            var app = new Application();
            app.Run(new OriginalWindow());
        }
    }
}

WPFのプログラムは基本的にWindowクラスを継承したクラスを自作し、それを実行するというものです。この場合自作したのはOriginalWindowクラスです。
Main関数の中で作ったウィンドウを実行しています。

では、Direct2Dを導入してみましょう。

using System;
using System.Windows;
using System.Windows.Media;
using System.Windows.Forms.Integration;
using SlimDX;
using SlimDX.Direct2D;

namespace Direct2DSample
{
    public class SlimDXControl : System.Windows.Forms.Control
    {
        protected override void OnPaintBackground(System.Windows.Forms.PaintEventArgs pevent)
        {
        }
    }

    public class OriginalWindow : Window
    {
        public OriginalWindow()
        {
            this.Title = "SlimDX - Direct2D Sample";
            this.SizeToContent = SizeToContent.WidthAndHeight;

            var host = new WindowsFormsHost(){
                Width  = 400,
                Height = 300,
            };
            this.Content = host;

            var control = new SlimDXControl(){
                Width  = 400,
                Height = 300,
            };
            host.Child = control;

            /* ここからDirect2D */
            var factory = new Factory();

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

            CompositionTarget.Rendering += (sender,e)=>{
                target.BeginDraw();
                target.Clear(new Color4(0,0,0,0));

                target.EndDraw();
            };
        }
    }

    class Progarm
    {
        [STAThread]
        static void Main()
        {
            var app = new Application();
            app.Run(new OriginalWindow());

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

それじゃあ説明ですね。

    public class SlimDXControl : System.Windows.Forms.Control
    {
        protected override void OnPaintBackground(System.Windows.Forms.PaintEventArgs pevent)
        {
        }
    }

ここでコントロールを継承したクラスを作っています。ここで言うコントロールとは、Windowsフォームアプリケーションで言うところのコントロールで、ウィンドウに配置する部品の基礎になるものです。そのままだとウィンドウのサイズを変えたときなどに背景が描画されてしまうので、OnPaintBackgroundメソッドをオーバーライドしています。

            this.SizeToContent = SizeToContent.WidthAndHeight;

この文を書いておくことで、コンテンツのサイズに合わせてウィンドウのサイズを調整してくれます。コンテンツのサイズを400×300にしたらウィンドウもそうなります（もちろんタイトルバーは除く）。

            var host = new WindowsFormsHost(){
                Width  = 400,
                Height = 300,
            };
            this.Content = host;

これがかの有名なWindowsFormsHostです。これを使えばWPFで、これまでのフォームアプリの遺産を活用することができます。注意が必要なのは、このクラスを使用するときは、"WindowsFormsIntegration.dll"への参照を加えないといけません。その中にWindowsFormsHostが入っているので。
サイズを400×300とし、ウィンドウのコンテンツにしています。

            var control = new SlimDXControl(){
                Width  = 400,
                Height = 300,
            };
            host.Child = control;

ホストするためのコントロールを作っています。サイズは400×300です。このサイズをWindowsFormsHostと合わせておかないと楽しいことになります。

            CompositionTarget.Rendering += (sender,e)=>{

CompositionTarget.Renderingイベントは描画の度に呼ばれるイベントです。そのため、ここに描画処理を書きます。
ちなみにFPSは……よく分かりません。30くらいだと思います。
ディスパッチャタイマーを使う方法もありまして、それだとFPSが60くらいになります。しかし、私にはWPFが一回描画をする間に、２回Direct2Dの描画を行っているような気がしてなりません。もしそうであれば非効率です。
数日かけて色々と検証したのですが、分かりませんでした。だいたいの予測などはあるのですが、正しいかどうか分からないので書きません。


何と言うか、ほら、

WPFでDirect2Dを使うことに意味があるのか

という結論です。
いっそのことWPFで全部描いちゃうほうがいいと思います。たぶんWPFのほうが簡単です。

ぐだぐだでしたがこれにて！

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