XR API reference

VR デバイス

VR 概要

Unity VR を使用すると、プロジェクトに外部プラグインを使わずに、Unity から直接 VR デバイスをターゲットにできます。Unity VR は、基本 API と機能のセット、そして、それらの機能と複数デバイスとの互換性を提供します。Unity VR は、これからのデバイスとソフトウェアにさらに進んだ互換性を提供するよう、設計されています。

*Note: XR is an umbrella term which encompassess virtual reality (VR), augmented reality (AR), and Mixed Reality (MR). We are in the process of updating our XR documentation, but for now this documentation refers mainly to just VR.*

** Unity の XR API は広義の用語「XR」を反映するように更新されましたが、ドキュメントの多くは現在でも「VR」という用語を使用しています。 XR API サーフェスは設計上最小限ですが、XR の発展に伴い拡張されます。**

ネイティブの VR サポートを使用することにより、以下が可能になります。

各 VR デバイスの安定バージョン
さまざまな VR デバイスと通信するための 1 つの API インターフェース
各デバイスごとの、外部プラグイン無しのクリーンなプロジェクトフォルダー
アプリケーション内で複数デバイスを扱い、その間を切り替えることが可能な性能
Increased performance (Lower-level Unity engine optimizations are possible for native devices) ot

Unity の VR サポートを有効にする

To enable native VR support for your game builds and the Editor, open the Player Settings (menu: Edit > Project Settings > Player). Select XR Settings and check the Virtual Reality Supported checkbox. Set this for each build target. Enabling virtual reality support in a standalone build does not also enable the support for Android (and vice-versa).

Navigating to Player Settings from the Unity Editor

その下に表示された Virtual Reality SDKs のリストに、それぞれのビルドターゲットの VR デバイスを追加、または、削除します。リストの順番は、ランタイムに Unity が VR デバイスを有効にする順番です。最初に適切に初期化されたデバイスが有効にされます。このリストの順番はビルドされたプレイヤー内でも同じです。

Enabling Virtual Reality Support through XR Settings

ビルドされたアプリケーション: 起動するデバイスを選ぶ

Your built application initializes and enables devices in the same order as the Virtual Reality SDKs list in XR Settings (see Enabling VR Support, above). Devices not present in the list at build time are not available in the final build. Device None is equivalent to a non-VR application (that is, a normal Unity application) and can be switched to during runtime without including it in the list; the exception to this is None.

リストにデバイスとして None を含めると、VR デバイスの初期化を行う前に、非 VR アプリケーションにデフォルト設定することができます。リストの一番上に None を配置すると、アプリケーションは VR を無効にして起動します。次に、 XR.XRSettings.LoadDeviceByName を使用して、スクリプトを通してリストに存在する VR デバイスを有効または無効にすることができます。

切り替えようとするデバイスの初期化が失敗すると、Unity はそのデバイスがまだアクティブな VR デバイスとして設定されている状態で VR を無効にします。デバイスを切り替えたり (XRSettings.LoadDeviceByName)、有効にすると (XR.XRSettings-enabled)、ビルドされたアプリケーションは再び初期化を試みます。

特定のデバイスを開始するためのコマンドライン引数は以下のとおりです。

-vrmode DEVICETYPE

この DEVICETYPE はサポートされている XR サポートデバイスリストにある名前の 1 つです。

例 MyGame.exe -vrmode oculus

VR を有効にすると、何が起きるか

Unity で VR を有効にすると、自動的にいくらか変化が起こります。

自動的にヘッドマウントディスプレイにレンダリング

シーンのすべてのカメラは、直接ヘッドマウントディスプレイ (HMD) にレンダリングできます。ビューとプロジェクション行列が自動的に調整され、ヘッドトラッキング、位置トラッキング、有効視野 (field of view, FOV) を処理します。

Camera コンポーネントの stereoTargetEye プロパティーを使用して HMD へのレンダリングを無効にすることが可能です。その他に、 Target Texture プロパティーを使って、カメラがレンダーテクスチャにレンダリングするように設定できます。

stereoTargetEye プロパティーを使用して、特定の目だけを HMD にレンダリングするようカメラを設定することもできます。これは、スナイパースコープや、立体映像のビデオなどの特殊なエフェクトに役立ちます。これを行うには、シーンにカメラを 2 つ加え、1 つのターゲットを左目、もう 1 つを右目に合わせます。それぞれの目に送るものを微調整するために、レイヤーマスクを設定します。

ヘッドトラッキングされた自動入力

使用するデバイスがヘッドマウントの場合、ヘッドトラッキングと適切な FOV は自動的にカメラに適用されます。手動で FOV を特定の値に設定することもできますが、Camera の Transform の値は直接設定することはできません。詳しくは、後出のカメラを理解するのセクションを参照してください。

ヘッドトラッキングと位置トラッキングが自動的に適用され、フレームをレンダリングする前に、位置と向きをできるだけ正確にユーザーのものと一致させます。こうすることにより、快適な VR 体験が実現し、ユーザーが吐き気をもよおすことを防ぎます。

カメラを理解する

カメラを動かしたり回転させたりするには、他のゲームオブジェクトの子としてアタッチします。そのため、カメラがアタッチした親の Transform が変化すると、カメラにも影響します。このことは、スクリプトを使ってカメラを動かしたり回転させる場合でも同じです。

Childing the Main Camera to a Gameobject

カメラの位置と向きを、ユーザーがニュートラルな姿勢で見ている状態と考えます。

座ったまま (seated) とルームスケール (room-scale) の VR 体験には相違点があります。

デバイスがルームスケールの体験をサポートする場合は、ユーザーのプレイスペースの中央がカメラの開始位置になります。
座ったまま (seated) の体験にする場合は XR.InputTracking.Recenter() を使って、カメラをニュートラルな位置にリセットします。

デバイスにレンダリングされている各カメラは、カメラの FOV を、各 VR SDK のソフトウェア設定でユーザーが入力した FOV に自動的に置き換えます。この動作は動きによる酔いを引き起こすことが知られているため、ユーザーは実行時に FOV を変更することはできません。

エディターモード

VR デバイスが Unity エディターモードをサポートしている場合、エディターで再生ボタンを押すとデバイス上で直接テストすることができます。

stereoTargetEye を左目、または両目に設定すると、左目がゲームビューウィンドウにレンダリングされます。stereoTargetEye を右目に設定すると、右目がゲームビューウィンドウにレンダリングされます。

ゲームビューで左右の目のビューを横並びにするには、2 つのカメラを作成します。片方を左目、もう片方を右目に設定し、それらを表示するビューポートを横並びにします。

エディターでの実行にはオーバーヘッドがあり、遅延やブレが発生することがあります。Unity IDE は各ウィンドウをレンダリングする必要があるため、ゲームビューの “Maximize on Play” を使ってエディターのレンダリングオーバーヘッドを削減してください。

パフォーマンスを検証する最良の方法は、ターゲットプラットフォームのビルドを作成して直接実行することです。開発ビルド以外で実行するほうが良いパフォーマンスを得られますが、開発ビルドを使うと、より詳しいパフォーマンスプロファイリングを得るために Unity プロファイラーに接続することができます。

Unity を使った VR 開発で推奨のハードウェアとソフトウェア

ハードウェア

ターゲット HMD に近いフレームレートを達成することは、よい VR 体験のためには不可欠です。これは、HMD で使われる画面のリフレッシュレートと一致しなければなりません。フレームレートが HMD のリフレッシュレートを下回ると、とても目立ち、しばしばプレイヤーが吐き気を感じる原因になります。

The table below lists the device refresh rates for common VR headsets:

*VR デバイス*	*リフレッシュレート*
Gear VR	60hz
Oculus Rift	90hz
Vive	90hz

ソフトウェア

Windows: Windows 7、8、8.1、10 はすべて互換性あり。
Android: Android OS Lollipop 5.1 以降。
OS X: OSX 10.9 以降とランタイムに Oculus 0.5.0.1。ただし、Oculus は OS X 対し開発停止しているため、Unity でネイティブの VR 機能を使うには Windows を使用してください。
グラフィックスカードドライバ: ドライバを更新するよう注意してください。すべてのデバイスは最新のドライバに対応しています。そのため、古いドライバはサポートされていない場合があります。

デバイスのランタイムの要件

各 VR デバイスでは、マシンに適切なランタイムがインストールされている必要があります。たとえば、Unity 内で Oculus を開発して実行するには、Oculus ランタイム (Oculus Home とも呼ばれます) がマシンにインストールされている必要があります。Vive には、Steam と SteamVR が必要です。

使用している Unity のバージョンによっては、Unity でサポートしている特定のデバイスのランタイムバージョンが異なる場合があります。ランタイムバージョンは、Unity のメジャーおよびマイナーリリースの各リリースノートを参照してください。

バージョンの更新の中には、以前のランタイムバージョンをサポートしないものもあります。つまり、ネイティブの Unity VR サポートは以前のランタイムバージョンでは機能しませんが、新しいランタイムバージョンでは引き続き動作します。

Unity native VR support does not read plug-ins from within your project’s folder, so including earlier versions of the plug-in with native support will fail if you have VR support enabled. If you wish to use an earlier version with a release of Unity that no longer supports that version, disable Native VR Support (go to XR Settings and uncheck Virtual Reality Supported). You can then access the plug-in like any other 3rd party plugin. See the section above on Enabling Unity VR Support for more details.