UnityAdvent Calendar 2023

Unity でスクリーンセーバーを作る方法を模索してみた

Last updated at 2024-10-01Posted at 2023-12-15

はじまり

Unity でHLSL書いてシェイダーアートを作ってみたいなーと漠然と思いつつ、どうせならスクリーンセーバーとして動かせないものかと漠然と思いながらあれこれ調べてみました。
するとどうも Windows と Android でビルド方法が見えそうだったので試してみることにしました。

目的

Unity で以下のプラットフォーム向けにスクリーンセーバーをビルドする設定や手順を調べる。
(シェイダーアートを書くのはここではやりません。)

Windows x86-64
Android

環境

Windows 11 22H2
Android 14
Unity 2022.3.14f1

下調べ…スクリーンセーバーの仕組みを調べる

そもそもUnity以外のスクリーンセーバーがどのように作られてるのか調べないと手順が見えてこないのでOSごとに調べます。

Windows スクリーンセーバー

Windows のスクリーンセーバーの拡張子は .scr ですが、中身は実行可能ファイルです。
最低限 .exe の拡張子を .scr に変えて開けば実行できます。
しかしコマンドライン引数が特別仕様で、この仕様に合った実行ファイルを作らないと実用に耐えません。

つまり、スクリーンセーバー仕様のコマンドライン引数を解釈する.exe を拡張子 .scr でビルドすれば動きます。
この .exe を自作すれば UnityPlayer をスクリーンセーバーにできそうですね。

Windows SDK (C/C++) で作ればコマンドライン引数をいい感じに解釈してくれる SCRNSAVW.LIB¹ をリンクできますが、 .NET を使って C# でゴリゴリ書く²実装も理論上は可能です。どっちでいこうかなー?

Android Daydream スクリーンセーバー

Daydream といえばVRプラットフォームの Daydream VR がありましたが、 Android 4.2 が新しかったころ Daydream という名前はスクリーンセーバーの機能名でした。
Android のスクリーンセーバーは充電中に表示します。

その仕組みを大雑把に説明すると Android API の android.service.dreams.DreamService というクラスを継承したフォアグラウンドサービスを実装すること。

Unity は普通にビルドすると1個のアクティビティからなるアプリを実装しますが、そもそもプログラムの始まりがアクティビティではないのでフォアグラウンドサービスを自作する必要があります。

逆に言えばスクリーンセーバーのフォアグラウンドサービスを自作³することで動かせるようになるはずですね。
標準の GameActivity が使ってるはずの com.unity3d.player.UnityPlayer のクラスの仕様がマニュアルに載ってないのが曲者の雰囲気ですが……

その他

macOS のスクリーンセーバーも実行可能バンドルを特定手順でつくればスクリーンセーバーになりそうですが、細かい手順⁴もさることながら「UserDefaults を使わずに ScreenSaverDefaults で設定を保存せよ」という制約が嫌な感じです。
Unity の中間成果物をいじって PlayerPrefs の実装を魔改造しないと PlayerPrefs 封印する羽目になりそう……?
サブマシンの Mac が古いので別の機会に調べましょう。

実装

Android

作成したばかりのまっさらなプロジェクトを試しに Android Studio プロジェクトとしてエクスポートしてみます。

これを Android Studio で開いてみると、いつもの UnityPlayerActivity のソースコードを開くことができました。

この中で com.unity3d.player.UnityPlayer をあれこれしているので、これの継承関係を Android Studio で調べてみるとどうやらFrameLayout のサブクラスのようです。
ならば Android 公式のサンプルコード³における自作FrameLayoutとおおむね同様に使えそうです。

Android 公式ブログの BouncerDaydream と unityLib に収録されている UnityPlayerActivity.java の定義を見ながら見様見真似でサービスをつくっていきます。

→ UnityPlayerDreamService

できましたー!

しかしここで新たな問題発生です。 Unity 側から currentActivity が取得できないのです。

元来 UnityPlayer は Activity と一緒に使う前提で組まれているのですが、スクリーンセーバーの描画領域を提供するアクティビティは非公開のようです。

なのでスクリーンセーバー起動時 UnityPlayer.currentActivity は null にせざるを得ません。

Android API を使う Unity パッケージが動かなくなることがあります。外部パッケージとの相性は特に注意しましょう。

それでも自分の書いたコードで使いたい場合のために、代わりに Daydream のサービスを取得するための UnityPlayerDream.Companion.getCurrentService() を実装してみました。
そもそもアクティビティではなくサービスなのでいろいろと勝手が異なりますが、ないよりはマシでしょう。
マネージドコードでスクリーンセーバーを終了するサンプルを作ってみました。

→ サンプルコード

早速 LogCat をつないで動かしてみると終了間際に NullPointerException(ぬるぽ) が発生してるのでまだ粗削りですが、とりあえず動くようになりました。

もう少し頑張れば、いつもの UnityPlayerActivity と両方入れてアクティビティで起動したら設定画面を開く、みたいな芸当もできそうです。

Windows

C++ と Windows SDK で書こうか迷いましたが、 Unity 使いに読んでもらうなら C# で書いた方がいいだろうと判断したので .NET で書くことにします。

有志の情報²によると、本実行してほしいときには /S という引数を受け取るようです。
では「引数が /S だったら UnityPlayer を全画面で開く Windows アプリ」を .NET でサクッと書いてみましょうか。
なお本実行の際は Unity が自分でウィンドウを開くため、スクリーンセーバーの終了処理を Unity で実装する必要があります。
マウスの動き（と、ついでにタッチイベント）を毎フレーム見て変化があったら終了するようにしてみましょう。
プレビューと本実行の区別は後述。

ところで Windows 版 UnityPlayer が受け取る引数⁵に -parentHWND というのがありまして、ここに10進数でウィンドウハンドルを渡すと、そのウィンドウに Unity の画面をレンダリングするようになるらしいです。⁶
プレビューの時はこれを使います。

あとは引数が無い場合と /C の場合は設定画面を開くべきなのですが、 Windows 公式の中にこういうのがあるのでオミットしちゃいます。