vrHMDService

クラス vrHMDService()

クラス vrHMDService

(vrBaseService を継承)

HTC Vive や Oculus などのバーチャル リアリティ HMD (ヘッドマウント ディスプレイ)にアクセスできるようにします。

概要

関数:
信号:

関数

vrHMDService.getActiveOpenXRRuntimeName()
戻り値:アクティブな OpenXR ランタイムの名前を文字列として返します
戻り値の型:string

vrHMDService.getActiveOpenXRSystemName()
戻り値:アクティブな OpenXR システムの名前を文字列として返します。
戻り値の型:string

vrHMDService.getDefaultRenderMode()

HMD がアクティブなときに使用されるレンダリング モードを取得します。

戻り値:レンダリング モード
戻り値の型:vrXRealityTypes.XRRenderMode

vrHMDService.getDepthTextureEnabled()

位置タイムワープの深度テクスチャが有効になっているかどうかを確認します。

戻り値:有効な場合は True、無効な場合は False
戻り値の型:bool

vrHMDService.getEyeGaze()

視線トラッキングがアクティブな間にトラッキングされた視線データを返します。視線トラッキングを使用しない場合は、HMD ユーザの前方のレイを返します。視線レイはワールド座標で表されます。

注: これは現在、OpenXR モードでは使用できません。
戻り値:視線データ
戻り値の型:vrdEyeGaze

vrHMDService.getEyeTrackingEnabled()

VR で視線トラッキングを有効にするかどうかを返します。これは、HMD が視線トラッキングを実際にサポートしているかどうか、または視線トラッキングが現在実行されているかどうかを示すものではないことに注意してください。視線トラッキングが現在実行されているかどうかを確認する場合は、vrHMDService.isEyeTrackingActive() を使用してください。

戻り値:有効な場合は True
戻り値の型:bool

vrHMDService.getFovealRegionSize()

フォービエイテッド レンダリング モードの場合の中心領域のサイズを取得します。

戻り値:中心領域のサイズ
戻り値の型:float

vrHMDService.getFoveatedRenderingEnabled()

VR でフォービエイテッド レンダリングを有効にするかどうかを返します。これは、グラフィックス カードがフォービエイテッド レンダリングを実際にサポートしているかどうかを示すものではないことに注意してください。

戻り値:有効な場合は True
戻り値の型:bool

vrHMDService.getFoveatedRenderingQuality(preset)

指定したプリセットの品質設定を取得します。

パラメータ:preset (vrRenderTypes.FoveatedQualityPreset): フォービエイテッド レンダリング モードで使用されるシェーディング品質のプリセット。
戻り値:品質設定
戻り値の型:vrdFoveatedQuality

vrHMDService.getFoveatedRenderingQualityPreset()

フォービエイテッド レンダリングに使用される品質プリセットを取得します。getFoveatedRenderingQuality(vrRenderTypes::FoveatedQualityPreset)を使用してプリセットの設定を個別に取得します。

戻り値:現在のプリセット
戻り値の型:vrRenderTypes.FoveatedQualityPreset

vrHMDService.getMixedRealityDepthEstimationEnabled()

複合現実の深度テストが有効になっているかどうかを確認します。

戻り値:有効な場合は True (使用できない場合も含む)、それ以外の場合は False
戻り値の型:bool

vrHMDService.getMixedRealityEyeOffsetPercentage()

複合現実におけるカメラと視点の間のオフセットをパーセントで取得します。

戻り値:視点とカメラの間のオフセット(0.0 ～ 1.0 の範囲)。
戻り値の型:float

vrHMDService.getMixedRealityHandDepthEstimationEnabled()

複合現実の深度テストが有効になっているかどうかを確認します。

戻り値:有効な場合は True (使用できない場合も含む)、それ以外の場合は False
戻り値の型:bool

vrHMDService.getOpenXRDepthLayerCompositionEnabled()
戻り値:深度合成レイヤを OpenXR ランタイムに送信するかどうかを返します。
戻り値の型:bool

vrHMDService.getVarjoRenderSettings()

Varjo HMD 固有の現在のレンダリング設定を取得します。

戻り値:Varjo HMD のレンダリング設定
戻り値の型:vrdVarjoRenderSettings

vrHMDService.getXRRenderMode()

現在設定されている XR レンダリング モードを取得します。

戻り値:透視対応 HMD がアタッチされていない場合、現在設定されているレンダリング モードとして FullScene を返します
戻り値の型:vrXRealityTypes.XRRenderMode

vrHMDService.isEyeTrackingActive()

現在、視線トラッキングがアクティブであるかどうかを返します。視線トラッキングをアクティブにするには、視線トラッキングを有効にする必要があります。VR で操作する場合は、HMD の視線トラッカーが VRED でサポートされていることも必要です。

戻り値:アクティブな場合は True
戻り値の型:bool

vrHMDService.isHmdActive()

HMD (VR)表示モードがアクティブかどうかを確認します。

戻り値:HMD モードの場合は True
戻り値の型:bool

vrHMDService.isMixedRealityDepthEstimationSupported()
戻り値:現在アクティブな HMD が複合現実での深度テストをサポートしている場合は True。
戻り値の型:bool

vrHMDService.isMixedRealitySupported()

現在アクティブになっている HMD が複合現実をサポートしているかどうかを確認します。

戻り値:複合現実がサポートされていない場合や現在アクティブな HMD がない場合は False、それ以外の場合は True。
戻り値の型:bool

vrHMDService.isXRRenderModeSupported(mode)

現在アクティブな HMD が XR レンダリング モードをサポートしているかどうかを確認します。

パラメータ:mode (vrXRealityTypes.XRRenderMode): レンダリング モード
戻り値:レンダリング モードがサポートされている場合は True、サポートされていない場合は False。
戻り値の型:bool

vrHMDService.setDefaultRenderMode(mode)

HMD がアクティブなときに使用されるレンダリング モードを設定します。

パラメータ:mode (vrXRealityTypes.XRRenderMode): アクティブ時に設定されるレンダリング モード。モードが FullScene でなく、HMD が複合現実をサポートしていない場合は、アクティブ時に FullScene モードがアクティブになります

vrHMDService.setDepthTextureEnabled(enabled)

位置タイムワープの深度テクスチャが使用可能な場合は、深度テクスチャを有効/無効にします。

パラメータ:enabled (bool): 有効にする場合は True、無効にする場合は False

vrHMDService.setEyeTrackingEnabled(enabled)

接続された HMD で視線トラッキングがサポートされている場合に、VR で有効または無効にします。VR モードが有効になる前にこのオプションを設定した場合は、VR モードが開始するときに適用されます。フォービエイテッド レンダリングを行うには、視線トラッキングを有効にします。

パラメータ:enabled (bool): 視線トラッキングを有効にする場合は True、無効にする場合は False

vrHMDService.setFovealRegionSize(size)

フォービエイテッド レンダリング モードの場合の中心領域のサイズを設定します。「vrHMDService.setFoveatedRenderingEnabled(enabled)」を参照してください。

パラメータ:size (float): 中心領域のサイズ

vrHMDService.setFoveatedRenderingCustomQuality(quality)

フォービエイテッド レンダリング モードで使用されるシェーディング品質のカスタム設定を行うことができます。vrHMDService.setFoveatedRenderingQualityPreset(preset) を[カスタム]に設定して、カスタム品質を有効にします。

パラメータ:quality (vrdFoveatedQuality): フォービエイテッド シェーディング品質の設定。

vrHMDService.setFoveatedRenderingEnabled(enabled)

VR でフォービエイテッド レンダリングを有効または無効にします。この操作を行うには、NVIDIA Turing グラフィックス カードでサポートされる OpenGL シェーディング レート イメージ拡張機能が必要です。VR モードが有効になる前にこのオプションを設定した場合は、VR モードが開始するときに適用されます。

パラメータ:enabled (bool): フォービエイテッド レンダリングを有効にする場合は True、無効にする場合は False

vrHMDService.setFoveatedRenderingQualityPreset(preset)

フォービエイテッド レンダリングに使用する品質プリセットを設定します。

パラメータ:preset (vrRenderTypes.FoveatedQualityPreset): フォービエイテッド レンダリング モードで使用されるシェーディング品質のプリセット。

vrHMDService.setMixedRealityDepthEstimationEnabled(enabled)

複合現実の深度テストがサポートされている場合に、このテストを有効/無効にします。深度テストを使用すると、実際にレンダリング イメージの一部をオクルードできます。

パラメータ:enabled (bool): 有効にする場合は True、無効にする場合は False

vrHMDService.setMixedRealityEyeOffsetPercentage(offset)

複合現実におけるカメラと視点の間のオフセットをパーセントで設定します。mr ビデオの視点をレンダリングの視点に合わせる場合に必要です。

パラメータ:offset (float): 視点とカメラ間のオフセット(0.0 ～ 1.0 の範囲)

vrHMDService.setMixedRealityHandDepthEstimationEnabled(enabled)

複合現実の深度テストがサポートされている場合に、このテストを有効/無効にします。深度テストを使用すると、実世界の手で、レンダリング イメージの一部をオクルードできます。

パラメータ:enabled (bool): 有効にする場合は True、無効にする場合は False

vrHMDService.setOpenXRDepthLayerCompositionEnabled(enable)

OpenXR ランタイムに深度情報を提供するための深度合成レイヤの送信を有効または無効にします。これは、位置タイムワープや複合現実などに使用できます。これは、一部のランタイムまたは HMD でサポートされていない可能性があることに注意してください。

パラメータ:enable (bool): 有効にする場合は True、無効にする場合は False。

vrHMDService.setVarjoRenderSettings(settings)

Varjo HMD に特定のレンダリング設定を適用します。これらの設定の変更は、Varjo HMD モードが次回アクティブになると有効になります。

パラメータ:settings (vrdVarjoRenderSettings) –

vrHMDService.setXRRenderMode(mode)

HMD の XR レンダリング モードが使用可能な場合は設定します。

パラメータ:mode (vrXRealityTypes.XRRenderMode): レンダリング モード

信号

vrHMDService.eyeGazeChanged()

この信号は、視線トラッキングがアクティブな間、フレームごとにトリガされます。

vrHMDService.foveatedRenderingStateChanged(enabled)

この信号は、フォービエイテッド レンダリングの状態が変化したときにトリガされます。

パラメータ:enabled (bool): フォービエイテッド レンダリングが有効な場合は True。

vrHMDService.handDepthEstimationChanged(enabled)

この信号は、MR の深度テストが有効または無効になっている場合にトリガされます。

パラメータ:enabled (bool): 深度テストが有効な場合は True、それ以外の場合は False。

vrHMDService.hmdStatusChanged(active)

この信号は、HMD (VR)表示モードのオン/オフが切り替わったときにトリガされます。

パラメータ:active (bool): HMD モードがオンに切り替わっている場合は True

vrHMDService.hmdStatusWillChange(active)

この信号は、HMD (VR)表示モードのオン/オフが切り替わる直前にトリガされます。

パラメータ:active (bool): HMD モードがオンに切り替わった場合は True、それ以外の場合は False。

vrHMDService.XRRenderModeChanged(mode)

この信号は、XR レンダリングモードが変更されたときにトリガされます。

パラメータ:mode (vrXRealityTypes.XRRenderMode): レンダリングが切り替わった場合の変更先のモード。
親ページ: VRED Python API v2