1. トップ
  2. 開発者
  3. 空間再現ディスプレイ ELF-MN1 開発者サイト
  4. Spatial Reality Display Unity API リファレンス

Spatial Reality Display Unity API リファレンス

Spatial Reality Display Unity API リファレンス
公開日　　｜　
最終更新日　
目次

このドキュメントは、Spatial Reality Display Plugin for Unityの公開ランタイム API リファレンスです。
名前空間および型ごとに構成され、アプリケーション開発を対象とした API を掲載しています。
直接的なアプリケーション利用を想定していない公開 API は意図的に除外しています。
読者は、開発者ガイドおよびプラグインの基本動作を理解していることを前提とします。

名前空間: SRD.Core

クラス

SRDManager

継承元: UnityEngine.MonoBehaviour > SRDManagerBase

説明

Spatial Reality Display へのレンダリング制御と Spatial Reality Runtime との通信を担う、Spatial Reality Display Plugin for Unity の中核コンポーネントです（ELF-SR1/ELF-SR2 向け）。現在は Windows x64 プラットフォームのみを完全サポートします。

継承メンバー (SRDManagerBase から継承)

フィールド/プロパティ

API

概要

IsSRRenderingActive

SRレンダリングの有効/無効を設定します。

IsSpatialClippingActive

空間クリッピングの有効/無効を設定します。
IsHighImageQualityMode 高画質レンダリングを有効化するかどうかを制御します。

IsAutoConnectEnabled

初期化時の自動接続を有効にします。

IsConnectionActive

マネージャー接続が現在有効かどうかを示します。

SRDViewSpaceScale

Spatial Reality Display View Space のスケール値です。

Presence

実空間におけるPresenceのTransformです。

DisplayEdges

Spatial Reality Display の各辺と中心の位置です。

メソッド

API

概要

ConnectAsync()

非同期で接続を開始します。

Disconnect()

有効な Spatial Reality Display セッションを切断します。

GetRuntimeVersion(out string version)

ランタイムのバージョン文字列を取得します。

GetDisplayVersion(out string version)

ディスプレイのファームウェアバージョン文字列を取得します。

RestartHeadTracking()

ヘッドトラッキング処理を再起動します。

IsHeadTrackingActive(out bool active)

ヘッドトラッキングが現在有効かどうかを問い合わせます。

イベント

API

概要

OnSRDManagerReadyEvent

初期化が完了し、マネージャー接続が有効になったときに呼び出されます。

OnSRDViewSpaceScaleChangedEvent

SRDViewSpaceScale が変更されたときに呼び出されます。

OnFaceTrackStateEvent

現在の顔追跡状態とともに毎フレーム呼び出されます。

フィールド/プロパティ

IsCrosstalkCorrectionActive

宣言

public bool IsCrosstalkCorrectionActive

型

説明

bool

クロストーク補正を有効化するかどうかを制御します。

CrosstalkCorrectionType

宣言

public SrdXrCrosstalkCorrectionType CrosstalkCorrectionType

型

説明

SrdXrCrosstalkCorrectionType

クロストーク補正モードです。

IsWallmountMode

宣言

public bool IsWallmountMode
型 説明
bool Wallmount モードを有効にします。有効にすると、Gizmo が45度傾きます。

ScalingMode

宣言

public enum ScalingMode
名前 説明
ScaledSize ディスプレイ本体寸法のスケール係数に応じてPresenceを拡大縮小し、設定した表示サイズでGizmoを描画します。
OriginalSize 選択した物理パネルの寸法をGizmoに使用します。

_scalingMode

宣言

public ScalingMode _scalingMode
型 説明

ScalingMode

 PresenceとGizmoのスケーリング方法を選択します。

SRD2DView

宣言

public SRD2DView SRD2DView

型

説明

SRD2DView

2DビューウィンドウのAPIにアクセスするためのSRD2DViewインスタンスです。

メソッド

ShowCameraWindow

カメラウィンドウを表示または非表示にします。
宣言

public bool ShowCameraWindow(bool isOn)

パラメーター

名前

型

説明

isOn

bool

カメラウィンドウを開く場合は true、閉じる場合は false。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

GetRealityCreationLevel

現在のリアリティクリエーションのレベルを取得します。
宣言

public bool GetRealityCreationLevel(out int level)

パラメーター

名前

型

説明

level

out int

リアリティクリエーションのレベル。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

SetRealityCreationLevel

リアリティクリエーションのレベルを設定します。
宣言

public bool SetRealityCreationLevel(int level)

パラメーター

名前

型

説明

level

int

リアリティクリエーションのレベル。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

GetSensorRangeMode

現在のセンサー範囲モードを取得します。
宣言

public bool GetSensorRangeMode(out int mode)

パラメーター

名前

型

説明

mode

out int

センサー範囲モード。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

SetSensorRangeMode

センサー範囲モードを設定します。
宣言

public bool SetSensorRangeMode(int mode)

パラメーター

名前

型

説明

mode

int

センサー範囲モード。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

GetXtalkAdjustParam

現在のクロストーク調整値を取得します。
宣言

public bool GetXtalkAdjustParam(out int param)

パラメーター

名前

型

説明

param

out int

クロストーク調整値。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

SetXtalkAdjustParam

クロストーク調整値を設定します。
宣言

public bool SetXtalkAdjustParam(int param)

パラメーター

名前

型

説明

param

int

クロストーク調整値。

戻り値

型

説明

bool

操作が成功した場合に true を返します。

Init2DView

セカンドモニターにサイズ変更可能なウィンドウを作成し、SRD画面の2Dビューを描画します。
宣言

public bool Init2DView()

戻り値

型

説明

bool

2Dビューウィンドウの作成に成功した場合に true を返します。セカンドモニターがPCに接続されていない場合は失敗します。

2DView APIにはSRD2DViewオブジェクトを使用してアクセスします。

PortraitSRDManager

継承元: UnityEngine.MonoBehaviour > SRDManagerBase

説明

Spatial Reality Display へのレンダリング制御と Spatial Reality Runtime との通信を担う、Spatial Reality Display Plugin for Unity の中核コンポーネントです（ELF-MN1 向け）。Windows では、API サポートに制限はあるものの、ELF-SR1/ELF-SR2 の 16:9 画面上で縦向き 1080x2160（1:2）コンテンツのプレビューにも使用できます。

継承メンバー (SRDManagerBase から継承)

フィールド/プロパティ

API

概要

IsSRRenderingActive

SRレンダリングの有効/無効を設定します。

IsSpatialClippingActive

空間クリッピングの有効/無効を設定します。
IsHighImageQualityMode 高画質レンダリングを有効化するかどうかを制御します。

IsAutoConnectEnabled

初期化時の自動接続を有効にします。

IsConnectionActive

マネージャー接続が現在有効かどうかを示します。

SRDViewSpaceScale

Spatial Reality Display View Space のスケール値です。

Presence

実空間におけるPresenceのTransformです。

DisplayEdges

Spatial Reality Display の各辺と中心の位置です。

メソッド

API

概要

ConnectAsync()

非同期で接続を開始します。

Disconnect()

有効な Spatial Reality Display セッションを切断します。

GetRuntimeVersion(out string version)

ランタイムのバージョン文字列を取得します。

GetDisplayVersion(out string version)

ディスプレイのファームウェアバージョン文字列を取得します。

RestartHeadTracking()

ヘッドトラッキング処理を再起動します。

IsHeadTrackingActive(out bool active)

ヘッドトラッキングが現在有効かどうかを問い合わせます。

イベント

API

概要

OnSRDManagerReadyEvent

初期化が完了し、マネージャー接続が有効になったときに呼び出されます。

OnSRDViewSpaceScaleChangedEvent

SRDViewSpaceScale が変更されたときに呼び出されます。

OnFaceTrackStateEvent

現在の顔追跡状態とともに毎フレーム呼び出されます。

フィールド/プロパティ

IdleTexture

宣言

public Texture2D IdleTexture
型 説明
Texture2D マネージャーがアイドル状態または未接続のときに表示されるテクスチャです。

EFMSettings

宣言

public SRDEasyFusionMaskSettings EFMSettings
型 説明
SRDEasyFusionMaskSettings Easy Fusion Mask の設定です。

メソッド

GetDisplayBrightness

現在の画面輝度を取得します。

宣言

public bool GetDisplayBrightness(out uint brightness)

パラメーター

名前 型 説明
brightness out uint 画面輝度レベル。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

SetDisplayBrightness

画面輝度を設定します。

宣言

public bool SetDisplayBrightness(uint brightness)

パラメーター

名前 型 説明
brightness uint 輝度レベル。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

GetSpeakerVolume

現在のスピーカー音量を取得します。

宣言

public bool GetSpeakerVolume(out uint volume)

パラメーター

名前 型 説明
volume out uint スピーカー音量レベル。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

SetSpeakerVolume

スピーカー音量を設定します。

宣言

public bool SetSpeakerVolume(uint volume)

パラメーター

名前 型 説明
volume uint スピーカー音量レベル。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

GetScreenDisplayMode

現在の画面表示モードを取得します。

宣言

public bool GetScreenDisplayMode(out SRDScreenDisplayMode mode)

パラメーター

名前 型 説明
mode out SRDScreenDisplayMode 表示モード。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

SetScreenDisplayMode

画面表示モードを設定します。

宣言

public bool SetScreenDisplayMode(SRDScreenDisplayMode mode)

パラメーター

名前 型 説明
mode SRDScreenDisplayMode 表示モード。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

SetIOSAutoLaunchApplicationName

ディスプレイ起動時にiOSが自動起動するアプリケーションの名前を設定します。

宣言

public bool SetIOSAutoLaunchApplicationName(string applicationName)

パラメーター

名前 型 説明
applicationName string 起動するアプリケーション名。

戻り値

型 説明
bool 設定に成功した場合は true、それ以外は false。

iOSビルド向けのメソッドです。

イベント

OnSRDSpeakerVolumeChangedEvent

宣言

public SRDSpeakerVolumeChangedEvent OnSRDSpeakerVolumeChangedEvent
型 説明
SRDSpeakerVolumeChangedEvent 本体の音量ボタンが押されたときに呼び出されます。

イベントパラメーター

名前 型 説明
volume uint スピーカー音量値。

SRDManagerBase

継承元: UnityEngine.MonoBehaviour / 派生先: SRDManager, PortraitSRDManager

説明

SRDManager と PortraitSRDManager で共通利用される Spatial Reality Display Plugin for Unity の基底クラスです。接続およびレンダリングのライフサイクルに関する共通動作を定義します。インスタンス化はできません。

フィールド/プロパティ

IsSRRenderingActive

宣言

public bool IsSRRenderingActive
型 説明
bool SRレンダリングの有効/無効を設定します。

IsSpatialClippingActive

宣言

public bool IsSpatialClippingActive
型 説明
bool 空間クリッピングの有効/無効を設定します。

IsHighImageQualityMode

宣言

public bool IsHighImageQualityMode

型

説明

bool

対応環境ではレンズシフト描画を有効化し、非対応時はホモグラフィ描画を使用します。

IsAutoConnectEnabled

宣言

public bool IsAutoConnectEnabled
型 説明
bool 初期化時の自動接続を有効にします。

IsConnectionActive

宣言

public bool IsConnectionActive
型 説明
bool マネージャー接続が現在有効かどうかを示します。

SRDViewSpaceScale

宣言

public float SRDViewSpaceScale
型 説明
float Spatial Reality Display View Space のスケール値です。

Presence

宣言

public Transform Presence
型 説明
Transform 実空間におけるPresenceのTransformです。

DisplayEdges

宣言

public DisplayEdges DisplayEdges
型 説明
DisplayEdges Spatial Reality Display の各辺と中心の位置です。

メソッド

ConnectAsync

必要に応じてマネージャーを初期化し、Spatial Reality Display への接続を非同期で開始します。

宣言

public Task<bool> ConnectAsync()

戻り値

型 説明
Task 接続結果。

Disconnect

レンダリングを停止し、このマネージャーとSpatial Reality Displayの接続を切断します。

宣言

public bool Disconnect()

戻り値

型 説明
bool 操作が成功した場合に true を返します。

GetRuntimeVersion

現在のランタイムバージョン文字列を取得します。

宣言

public bool GetRuntimeVersion(out string version)

パラメーター

名前 型 説明
version out string ランタイムバージョン。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

GetDisplayVersion

接続中ディスプレイのファームウェアバージョン文字列を取得します。

宣言

public bool GetDisplayVersion(out string version)

パラメーター

名前 型 説明
version out string ディスプレイのファームウェアバージョン。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

RestartHeadTracking

ヘッドトラッキング処理を再起動します。

宣言

public bool RestartHeadTracking()

戻り値

型 説明
bool 操作が成功した場合に true を返します。

IsHeadTrackingActive

ヘッドトラッキングが現在有効かどうかを問い合わせます。

宣言

public bool IsHeadTrackingActive(out bool active)

パラメーター

名前 型 説明
active out bool ヘッドトラッキング有効状態。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

イベント

OnSRDManagerReadyEvent

宣言

public SRDManagerReadyEvent OnSRDManagerReadyEvent
型 説明
SRDManagerReadyEvent 初期化が完了し、マネージャー接続が有効になったときに呼び出されます。

このイベントにパラメーターはありません。

OnSRDViewSpaceScaleChangedEvent

宣言

public SRDViewSpaceScaleChangedEvent OnSRDViewSpaceScaleChangedEvent
型 説明
SRDViewSpaceScaleChangedEvent SRDViewSpaceScale（Spatial Reality Display View Space Scale）が変更されたときに呼び出されます。

イベントパラメーター

名前 型 説明
scale float 更新後の SRDViewSpaceScale 値。

OnFaceTrackStateEvent

宣言

public SRDFaceTrackStateEvent OnFaceTrackStateEvent
型 説明
SRDFaceTrackStateEvent 現在の顔追跡状態とともに毎フレーム呼び出されます。

イベントパラメーター

名前 型 説明
isSuccess bool 現在のフレームで顔追跡に成功したかどうか。

SRD2DView

継承元: UnityEngine.MonoBehaviour

説明

別ディスプレイに表示される 2D View ウィンドウを制御します。

フィールド/プロパティ

SourceTexture

宣言

public SRDTextureType SourceTexture
型 説明
SRDTextureType 現在表示中のテクスチャ種別です。

CustomTexture

宣言

public RenderTexture CustomTexture
型 説明
RenderTexture SourceTexture が Custom のときに表示されるテクスチャです。

IsFullScreen

宣言

public bool IsFullScreen
型 説明
bool 2D View が全画面表示かどうか。

IsVisible

宣言

public bool IsVisible
型 説明
bool 2D View が可視状態かどうか。

DisplayIndex

宣言

public static int DisplayIndex
型 説明
static int 2D View に関連付けられたディスプレイインデックスです。

メソッド

SetSourceTexture

2D View で使用するソーステクスチャ種別を設定します。

宣言

public void SetSourceTexture(SRDTextureType sourceTexture)

パラメーター

名前 型 説明
sourceTexture SRDTextureType 表示するテクスチャ種別。

Show

2D View を表示または非表示にします。

宣言

public void Show(bool show)

パラメーター

名前 型 説明
show bool 表示する場合は true、非表示にする場合は false。

SetTargetDisplay

2D View の対象ディスプレイを設定します。

宣言

public bool SetTargetDisplay(DisplayInfo targetDisplay)

パラメーター

名前 型 説明
targetDisplay DisplayInfo 対象ディスプレイ情報。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

SetFullScreen

2D View の全画面モードを設定します。

宣言

public bool SetFullScreen(bool fullScreen)

パラメーター

名前 型 説明
fullScreen bool 全画面表示の場合は true、ウィンドウ表示の場合は false。

戻り値

型 説明
bool 操作が成功した場合に true を返します。

SRDCameras

説明

Spatial Reality Display マネージャーにアタッチされた Camera コンポーネントへのアクセスと、レンダリング画面空間・Spatial Reality Display 画面空間・ワールド空間間の座標変換ヘルパーを提供します。

フィールド/プロパティ

WatcherAnchorObject

宣言

public GameObject WatcherAnchorObject
型 説明
GameObject 頭部位置可視化用のアンカーオブジェクトです。

AnchorTransform

宣言

public Transform AnchorTransform
型 説明
Transform ウォッチャーアンカーの Transform です。

WatcherCameraObject

宣言

public GameObject WatcherCameraObject
型 説明
GameObject レイキャストに使用するカメラオブジェクトです。

WatcherCamera

宣言

public Camera WatcherCamera
型 説明
Camera レイキャストおよび UI 操作用のカメラです。

LeftEyeCamera

宣言

public Camera LeftEyeCamera
型 説明
Camera 左眼レンダリング用のアイカメラです。

RightEyeCamera

宣言

public Camera RightEyeCamera
型 説明
Camera 右眼レンダリング用のアイカメラです。

メソッド

SRDCameras

指定したマネージャーに関連付けられた SRDCameras インスタンスを作成します。

宣言

public SRDCameras(SRDManagerBase manager)

パラメーター

名前 型 説明
manager SRDManagerBase 現在のシーンに存在する Spatial Reality Display マネージャー。

戻り値

型 説明
constructor 新しい SRDCameras インスタンス。

ScreenPointToRay

画面空間の位置をワールド空間のレイに変換します。

宣言

public Ray ScreenPointToRay(Vector2 positionInScreen)

パラメーター

名前 型 説明
positionInScreen Vector2 画面座標系での位置。

戻り値

型 説明
Ray 指定した画面位置を通る、視点からのレイ。

ScreenToWorldPoint

画面空間の位置をワールド空間の位置に変換します。

宣言

public Vector3 ScreenToWorldPoint(Vector2 positionInScreen)

パラメーター

名前 型 説明
positionInScreen Vector2 画面座標系での位置。

戻り値

型 説明
Vector3 ワールド空間の Vector3 位置。

WorldToSRDScreenPoint

ワールド空間の位置を Spatial Reality Display 画面空間へ変換します。

宣言

public Vector2 WorldToSRDScreenPoint(Vector3 positionInWorld)

パラメーター

名前 型 説明
positionInWorld Vector3 ワールド座標系での位置。

戻り値

型 説明
Vector2 Spatial Reality Display 画面座標系での Vector2。

ScreenToSRDScreen

レンダリング画面座標を Spatial Reality Display 画面座標へ変換します。

宣言

public Vector2 ScreenToSRDScreen(Vector2 positionInScreen)

パラメーター

名前 型 説明
positionInScreen Vector2 レンダリング画面座標系での位置。

戻り値

型 説明
Vector2 Spatial Reality Display 画面座標系での Vector2。

SRDScreenToScreen

Spatial Reality Display 画面座標をレンダリング画面座標へ変換します。

宣言

public Vector2 SRDScreenToScreen(Vector2 positionInSRDScreen)

パラメーター

名前 型 説明
positionInSRDScreen Vector2 Spatial Reality Display 画面座標系での位置。

戻り値

型 説明
Vector2 レンダリング画面座標系での Vector2。

列挙型

SrdXrCrosstalkCorrectionType

説明

クロストーク補正モードです。

値

名前 説明
GRADATION_CORRECTION_MEDIUM 階調補正 Medium モード。
GRADATION_CORRECTION_ALL 階調補正 All モード。
GRADATION_CORRECTION_HIGH_PRECISE 高精度階調補正モード。

SRDTextureType

説明

2D View ウィンドウで使用するテクスチャソースです。

値

名前 説明
LeftEye 左眼テクスチャを表示します。
RightEye 右眼テクスチャを表示します。
SideBySide 左右並列のテクスチャ出力を表示します。
Custom SRD2DView.CustomTexture を表示します。

SRDScreenDisplayMode

説明

画面表示モードです。

値

名前 説明
Normal 通常表示を出力します。
BlackScreen 黒画面を出力します。
SonyLogo Sony ロゴ画面を出力します。

SRDEasyFusionMaskMode

説明

Easy Fusion Mask のソースモードです。

値

名前 説明
SingleColor 単色マスクを使用します。
Texture テクスチャマスクを使用します。
RawImage RawImage ソースを使用します。
Plane Plane オブジェクトをマスクソースとして使用します。

構造体

SRDEasyFusionMaskFrameSize

説明

Easy Fusion Mask で使用するフレーム余白です。

フィールド

名前 型 説明
left int 左フレームサイズ。
top int 上フレームサイズ。
right int 右フレームサイズ。
bottom int 下フレームサイズ。

SRDEasyFusionMaskSettings

説明

Easy Fusion Mask の設定です。

フィールド

名前 型 説明
Enabled bool Easy Fusion Mask の有効/無効を切り替えます。
Mode SRDEasyFusionMaskMode マスク描画モード。
BaseColor Color SingleColor モードで使用するベースカラー。
Texture Texture Texture モードで使用するテクスチャソース。
RawImage RawImage RawImage モードで使用する RawImage ソース。
Plane GameObject Plane モードで使用する Plane ソース。
FrameSize SRDEasyFusionMaskFrameSize マスクのフレーム余白。
SlopeGain float スロープゲイン調整値。
LevelOffset float レベルオフセット調整値。

名前空間: SRD.Utils

クラス

SRDApplicationContext

説明

検出デバイス数の取得とSpatial Reality Displayのエラー通知を行う静的APIです。

フィールド/プロパティ

ConnectedDeviceCount

宣言

public static uint ConnectedDeviceCount
型 説明
static uint システムが検出した Spatial Reality Display デバイス数。

メソッド

AddDeviceConnectionEventListener

検出デバイス数の変化を受け取るリスナーを登録します。

宣言

public static void AddDeviceConnectionEventListener(UnityAction<uint> callback)

パラメーター

名前 型 説明
callback UnityAction 登録時に現在の検出デバイス数を受け取り、その後は検出数が変化するたびに呼び出されるリスナー。

RemoveDeviceConnectionEventListener

検出デバイス数の変化を受け取るリスナーの登録を解除します。

宣言

public static void RemoveDeviceConnectionEventListener(UnityAction<uint> callback)

パラメーター

名前 型 説明
callback UnityAction 解除対象のリスナー。

AddSRDErrorOccurredEventListener

Spatial Reality Display のエラー通知を受け取るリスナーを登録します。

宣言

public static void AddSRDErrorOccurredEventListener(UnityAction<SRDApplicationContext.SRDErrorType> callback)

パラメーター

名前 型 説明
callback UnityAction<SRDErrorType> Spatial Reality Display のエラー通知時に呼び出されるリスナー。

RemoveSRDErrorOccurredEventListener

Spatial Reality Display のエラー通知リスナーの登録を解除します。

宣言

public static void RemoveSRDErrorOccurredEventListener(UnityAction<SRDApplicationContext.SRDErrorType> callback)

パラメーター

名前 型 説明
callback UnityAction<SRDErrorType> 解除対象のリスナー。

SRDProjectSettings

継承元: UnityEngine.ScriptableObject

説明

Spatial Reality Display の動作に関するプロジェクト設定を保持します。

フィールド/プロパティ

RunWithoutSpatialRealityDisplay

宣言

public bool RunWithoutSpatialRealityDisplay
型 説明
bool Spatial Reality Display を接続せずにアプリケーションを実行します。

BehaviorWhenNoSRDisplay

宣言

public BehaviorOptionWhenNoSRDisplay BehaviorWhenNoSRDisplay
型 説明

BehaviorOptionWhenNoSRDisplay

 Spatial Reality Display未接続時の動作。RunWithoutモードが有効な場合、この設定は適用されません。

MultiDisplayMode

宣言

public MultiSRDMode MultiDisplayMode
型 説明

MultiSRDMode

 アプリケーションで使用するマルチディスプレイモード。RunWithoutモードでは単一ディスプレイになります。

NumberOfDisplays

宣言

public int NumberOfDisplays
型 説明
int アプリケーションで使用するSpatial Reality Displayの台数。シングルディスプレイでは1台です。

PositionChangeTime

宣言

public float PositionChangeTime
型 説明
float Unity EditorのPlayモードでディスプレイ位置を切り替える間隔（秒）。

メソッド

IsRunWithoutSRDisplayMode

RunWithoutモードが有効かどうかを取得します。

宣言

public static bool IsRunWithoutSRDisplayMode()

戻り値

型 説明
bool Spatial Reality Displayを接続せずに実行する場合にtrueを返します。

GetBehaviorOptionWhenNoSRDisplay

Spatial Reality Display未接続時に適用する動作を取得します。

宣言

public static BehaviorOptionWhenNoSRDisplay GetBehaviorOptionWhenNoSRDisplay()

戻り値

型 説明
BehaviorOptionWhenNoSRDisplay 設定済みの未接続時の動作。

GetMutlipleDisplayMode

有効なマルチディスプレイモードを取得します。API名はソースコード上の綴りを維持しています。

宣言

public static MultiSRDMode GetMutlipleDisplayMode()

戻り値

型 説明
MultiSRDMode 有効なマルチディスプレイモード。RunWithoutモードでは単一ディスプレイになります。

GetNumberOfDevices

設定されたSpatial Reality Displayの台数を取得します。

宣言

public static int GetNumberOfDevices()

戻り値

型 説明
int 有効なSpatial Reality Displayの台数。シングルディスプレイでは1台を返します。

GetPositionSwitchInterval

設定済みの位置切替間隔を取得します。

宣言

public static float GetPositionSwitchInterval()

戻り値

型 説明
float Unity EditorのPlayモードで位置を切り替える間隔（秒）。

SRDGraphicRaycaster

継承元: UnityEngine.UI.GraphicRaycaster

説明

トラッキングされたユーザー視点からワールド空間Canvasへポインター入力をレイキャストします。_srdManagerを設定するか、未設定の場合はコンポーネント開始時にマネージャーを検索します。

フィールド/プロパティ

_srdManager

宣言

public SRDManager _srdManager
型 説明

SRDManager

 カメラおよびディスプレイ座標変換に使用するマネージャー。

イベント

OnCanvasHitEvent

宣言

public SRDCanvasInteractionEvent OnCanvasHitEvent
型 説明
SRDCanvasInteractionEvent レイがCanvasと交差している間、レイキャストごとに呼び出されます。

イベントパラメーター

名前 型 説明
rayOrigin Vector3 ワールド空間での操作レイの始点。
srdScreenPos Vector3 ポインター位置に対応するディスプレイ平面上のワールド座標。
canvasPos Vector3 Canvas上のワールド座標でのヒット位置。

OnCanvasEnterEvent

宣言

public SRDCanvasInteractionEvent OnCanvasEnterEvent
型 説明
SRDCanvasInteractionEvent レイが初めてCanvasと交差したときに呼び出されます。

イベントパラメーター

名前 型 説明
rayOrigin Vector3 ワールド空間での操作レイの始点。
srdScreenPos Vector3 ポインター位置に対応するディスプレイ平面上のワールド座標。
canvasPos Vector3 Canvas上のワールド座標でのヒット位置。

OnCanvasExitEvent

宣言

public SRDCanvasInteractionEvent OnCanvasExitEvent
型 説明
SRDCanvasInteractionEvent レイがCanvasとの交差を終了したときに呼び出されます。Canvas位置は最後のヒット位置です。

イベントパラメーター

名前 型 説明
rayOrigin Vector3 ワールド空間での操作レイの始点。
srdScreenPos Vector3 ポインター位置に対応するディスプレイ平面上のワールド座標。
canvasPos Vector3 Canvas上の最後のワールド座標でのヒット位置。

DisplayEdges

説明

ワールド空間における Spatial Reality Display の四隅と中心位置を表します。

フィールド/プロパティ

LeftUp

宣言

public Transform LeftUp
型 説明
Transform 左上エッジの Transform。

LeftBottom

宣言

public Transform LeftBottom
型 説明
Transform 左下エッジの Transform。

RightUp

宣言

public Transform RightUp
型 説明
Transform 右上エッジの Transform。

RightBottom

宣言

public Transform RightBottom
型 説明
Transform 右下エッジの Transform。

CenterPosition

宣言

public Vector3 CenterPosition
型 説明
Vector3 ディスプレイ中心位置。

Normal

宣言

public Vector3 Normal
型 説明
Vector3 左辺と下辺から計算されるディスプレイ平面の法線ベクトル。

Positions

宣言

public Vector3[] Positions
型 説明
Vector3[] ワールド空間の角点位置。LeftUp、LeftBottom、RightBottom、RightUpの順。

SRDAdaptivePerformanceController

継承元: UnityEngine.MonoBehaviour

説明

フレームレートを目標値付近に保つため、動的バッファサイズと、URPビルドではレンダースケールを調整するランタイム性能コントローラーです。FPSがしきい値を下回ると比率に応じて画質を下げ、性能が回復すると設定された回復ステップで画質を上げます。

フィールド/プロパティ

TargetFPS

宣言

public float TargetFPS
型 説明
float 目標フレームレート。

FpsDropThreshold

宣言

public float FpsDropThreshold
型 説明
float これを下回るFPS/目標FPS比でバッファサイズとレンダースケールを下げます。

FpsMeasurementWindowSeconds

宣言

public float FpsMeasurementWindowSeconds
型 説明
float FPS測定ウィンドウの長さ（秒）。

ControlBufferSize

宣言

public bool ControlBufferSize
型 説明
bool バッファサイズ制御を有効化するかどうかを制御します。

MinBufferSize

宣言

public float MinBufferSize
型 説明
float バッファサイズの下限値。

MaxBufferSize

宣言

public float MaxBufferSize
型 説明
float バッファサイズの上限値。

BufferSizeRecoveryStep

宣言

public float BufferSizeRecoveryStep
型 説明
float 性能回復時に測定ウィンドウごとに増加させるバッファサイズ。

ControlRenderScale

宣言

public bool ControlRenderScale
型 説明
bool URPのレンダースケール調整を有効化します。URPビルドでのみ利用できます。

MinRenderScale

宣言

public float MinRenderScale
型 説明
float 画質低下時に使用するURPレンダースケールの下限。

MaxRenderScale

宣言

public float MaxRenderScale
型 説明
float URPレンダースケールの上限。1.0はネイティブ解像度です。

RenderScaleRecoveryStep

宣言

public float RenderScaleRecoveryStep
型 説明
float 性能回復時に測定ウィンドウごとに増加させるレンダースケール。

CurrentFps

宣言

public float CurrentFps
型 説明
float 直近に計測されたフレームレート。

CurrentBufferSize

宣言

public float CurrentBufferSize
型 説明
float 現在の動的バッファサイズスケール。

CurrentRenderScale

宣言

public float CurrentRenderScale
型 説明
float URPアセットが有効な場合の現在のレンダースケール。

列挙型

SRDApplicationContext.SRDErrorType

説明

ランタイムエラーコードを表す SRDApplicationContext の入れ子enumです。

値

名前 説明
ERROR_DEVICE_NOT_FOUND 対象デバイスが見つかりませんでした。
ERROR_NOT_ALLOW_USB_CONNECTION USB 接続を利用できません。
ERROR_NOT_ALLOW_CAMERA カメラアクセスを利用できません。
ERROR_DEVICE_LOST ランタイム実行中に接続デバイスが失われました。
ERROR_CONNECTION_LOST ランタイム接続が失われました。

BehaviorOptionWhenNoSRDisplay

説明

Spatial Reality Display 未接続時の動作です。

値

名前 説明
ExitWithError エラーメッセージを表示してアプリケーションを終了します。
RunWithDisabled SRDManagerを無効にして実行します。

MultiSRDMode

説明

マルチディスプレイのレイアウトモードです。

値

名前 説明
SingleDisplay シングルディスプレイ / 複製出力。
MultiVertical 縦型マルチディスプレイ。
MultiHorizontal 横型マルチディスプレイ。
MultiGrid グリッドマルチディスプレイ。

開発者お問い合わせ・
商用利用について

お問い合わせ