---
title: VRDisplay
slug: Web/API/VRDevice
tags:
- API
- DOM
- Experimental
- Interface
- Media
- Reference
- VR
- VRDisplay
- Virtual Reality
- WebVR
translation_of: Web/API/VRDisplay
---
{{APIRef("WebVR API")}}{{SeeCompatTable}}
WebVR API の VRDisplay
インターフェイスは,このAPIがサポートしているVRデバイスを現します.VRDisplayにはデバイスIDやデスクリプションのような汎用的な情報が含まれていて,VRシーンの表示を開始するためのメソッドや,目のパラメータやディスプレイの備える機能の取得,その他の重要な機能を含んでいます。
{{domxref("Navigator.getVRDisplays()")}} を呼び出すことで,すべての接続されているVRのデバイスの配列が返されます。
プロパティ
- {{domxref("VRDisplay.capabilities")}} {{readonlyInline}}
VRDisplay
の備える機能を示す {{domxref("VRDisplayCapabilities")}} オブジェクトを返します.
- {{domxref("VRDisplay.depthFar")}}
- eye view frustum(ビューフラスタム;つまりシーンの可視領域の境界) のfar平面を定義しているz-depthの取得と設定を行います.
- {{domxref("VRDisplay.depthNear")}}
- eye view frustum(ビューフラスタム;つまりシーンの可視領域の境界) のnear平面を定義しているz-depthの取得と設定を行います.
- {{domxref("VRDisplay.displayId")}} {{readonlyInline}}
- このVRDisplay固有のIDを返します.このIDはGamepad API (参照 {{domxref("Gamepad.displayId")}}) の関連付けのために使用されます.
- {{domxref("VRDisplay.displayName")}} {{readonlyInline}}
VRDisplay
を識別するための人間が読める形式の名前を返します.
- {{domxref("VRDisplay.isConnected")}} {{readonlyInline}}
VRDisplay
がコンピュータに接続されているか否かを示す {{domxref("Boolean")}} を返します.
- {{domxref("VRDisplay.isPresenting")}} {{readonlyInline}}
VRDisplay
が現在コンテンツを表示中であるか否かを示す {{domxref("Boolean")}} を返します.
- {{domxref("VRDisplay.stageParameters")}} {{readonlyInline}}
VRDisplay
がルームスケール体験をサポートしている場合に,ルームスケールパラメータを含んだ {{domxref("VRStageParameters")}} オブジェクトを返します.
メソッド
- {{domxref("VRDisplay.getEyeParameters()")}}
- 指定した側の眼のパラメータを含む {{domxref("VREyeParameters")}} オブジェクトを返します.
- {{domxref("VRDisplay.getLayers()")}}
VRDisplay
に表示中のレイヤーを返します.
- {{domxref("VRDisplay.getPose()")}}
- 現在のフレームが実際に描画される時点の未来の
VRDisplay
の予測ポーズを決める {{domxref("VRPose")}} オブジェクトを返します.
- {{domxref("VRDisplay.getImmediatePose()")}}
- (予測なしの)
VRDisplay
のポーズを決める {{domxref("VRPose")}} オブジェクトを返します.
- {{domxref("VRDisplay.resetPose()")}}
- 現在の {{domxref("VRPose.position")}} と {{domxref("VRPose.orientation")}} を"原点/ゼロ"位置の値として扱うように,
VRDisplay
のポーズをリセットします.
- {{domxref("VRDisplay.cancelAnimationFrame()")}}
- {{domxref("Window.cancelAnimationFrame")}} の特別な実装で,{{domxref("VRDisplay.requestAnimationFrame()")}} を未登録状態にすることをコールバック可能にしています.
- {{domxref("VRDisplay.requestAnimationFrame()")}}
- {{domxref("Window.requestAnimationFrame")}} の特別な実装で,
VRDisplay
の新しいフレームが描画される際に毎回呼出されるコールバック関数を持っています.
- {{domxref("VRDisplay.requestPresent()")}}
VRDisplay
へのシーン描画を開始します.
- {{domxref("VRDisplay.exitPresent()")}}
VRDisplay
のシーン描画を停止します.
- {{domxref("VRDisplay.submitFrame()")}}
- {{domxref("VRLayer")}} の現在の状態をキャプチャし,
VRDisplay
上にそれを表示します.
-
非推奨のメソッド
- {{domxref("VRDisplay.getPose()")}} {{deprecated_inline}}
- Returns a {{domxref("VRPose")}} object defining the future predicted pose of the
VRDisplay
as it will be when the current frame is actually presented. This method is deprecated — instead, you should use {{domxref("VRDisplay.getFrameData()")}}, which also provides a {{domxref("VRPose")}} object.
-
廃止されたメソッド
- {{domxref("VRDisplay.getImmediatePose()")}} {{obsolete_inline}}
- Returns a {{domxref("VRPose")}} object defining the current pose of the
VRDisplay
, with no prediction applied. This is no longer needed, and has been removed from the spec.
- {{domxref("VRDisplay.hardwareUnitId")}} {{obsolete_inline}}
- Returns a {{domxref("DOMString")}} defining the shared ID of the display, and any other devices that are part of that hardware set (e.g. controllers). This is no longer needed, and has been removed from the spec. Displays now use {{domxref("VRDisplay.displayId")}}, and corresponsing controllers will now return the same ID under {{domxref("Gamepad.displayId")}}.
例
if(navigator.getVRDisplays) {
console.log('WebVR 1.1 supported');
// Then get the displays attached to the computer
navigator.getVRDisplays().then(function(displays) {
// If a display is available, use it to present the scene
if(displays.length > 0) {
vrDisplay = displays[0];
// Now we have our VRDisplay object and can do what we want with it
}
});
}
仕様
仕様 |
ステータス |
備考 |
{{SpecName('WebVR', '#interface-vrdisplay', 'VRDisplay')}} |
{{Spec2('WebVR')}} |
初回定義 |
ブラウザー実装状況
{{Compat("api.VRDisplay")}}
参照