IHolographicCameraInterop
COM公式ドキュメント
HolographicCamera を拡張し、Direct3D 12 でのホログラフィックレンダリングのバックバッファーとして使用する 2D テクスチャーリソースを作成・使用できるようにします。
解説(Remarks)
C++/WinRT でこのインターフェイスを使用するには、HolographicCamera オブジェクトから IHolographicCameraInterop インターフェイスに対して QueryInterface を行います。
winrt::com_ptr<IHolographicCameraInterop> spCameraInterop {
m_holographicCamera.as<IHolographicCameraInterop>() };
D3D12_RESOURCE_DESC bufferDesc { };
bufferDesc.Format =
SelectFormatUsingHolographicViewConfiguration(
m_holographicCamera.ViewConfiguration());
bufferDesc.SampleDesc.Count = 1;
bufferDesc.SampleDesc.Quality = 0;
bufferDesc.MipLevels = 1;
bufferDesc.Width = static_cast<UINT64>(
m_holographicCamera.ViewConfiguration().RenderTargetSize().Width);
bufferDesc.Height = static_cast<UINT64>(
m_holographicCamera.ViewConfiguration().RenderTargetSize().Height);
winrt::check_hresult(
spCameraInterop->CreateDirect3D12BackBufferResource(
m_deviceResources->GetD3D12Device(),
&bufferDesc,
&m_D3D12BackBuffer[m_contentBufferIndex]));
HolographicViewConfiguration API を使用すると、バッファーフォーマットとして利用可能な選択肢を判別したり、対応する出力(たとえば HolographicDisplay)のレンダーターゲットサイズに関する情報を取得したりできます。アプリケーションで、Direct3D 12 バッファーのバッファーサイズを HolographicCamera の既定のレンダーターゲットサイズから変更する必要がある場合は、HolographicViewConfiguration::RequestRenderTargetSize メソッドを使用して新しいレンダーターゲットサイズを要求し、そのメソッドが返すサイズでバッファーを作成するか、または任意のサイズを選択して次の段落で説明するようにビューポートをオーバーライドしてください。
Direct3D 12 アプリケーションでは、アプリケーションが独自に選択したビューポートサイズを使用できます。その場合、レンダリングに使用するビューポートをプラットフォームに通知するために、フレームごとに HolographicCameraPose.OverrideViewport メソッドを呼び出す必要があります。
次のコード抜粋は Windows Mixed Reality Direct3D 12 アプリテンプレートからのものです。このテンプレートには、Windows.Graphics.Holographic.Interop.h ヘッダーで提供されるほとんどの API のボイラープレートコードが含まれています。
winrt::com_ptr<IHolographicCameraInterop> spCameraInterop =
m_holographicCamera.as<IHolographicCameraInterop>();
winrt::check_hresult(
spCameraInterop->CreateDirect3D12BackBufferResource(
spD3D12Device.get(),
&bufferDesc,
m_spD3D12BackBuffer[bufferSlot].put()));
メソッド 5
vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。
カメラのコンテンツバッファーとして使用する Direct3D 12 リソースを作成します。
| pDevice | ID3D12Device* | in | リソースの作成に使用される Direct3D 12 デバイスです。 |
| pTexture2DDesc | D3D12_RESOURCE_DESC* | in | Direct3D 12 リソースの記述です。このパラメーターは省略できません。 CreateDirect3D12BackBufferResource は、実行時に決定されるバッファーサイズやフォーマットの制約など、プラットフォームの要件に準拠するために、必要に応じてこの記述を調整します。アプリケーションは、ppCreatedTexture2DResource で返されるテクスチャーの記述子を確認し、指定した内容との差異に適切に対応する必要があります。 |
| ppCreatedTexture2DResource | ID3D12Resource** | out | 成功した場合は、コンテンツバッファーとして使用する Direct3D 12 の 2D テクスチャーリソースです。それ以外の場合は nullptr です。 |
戻り値
成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。
IHolographicCameraInterop::CreateDirect3D12HardwareProtectedBackBufferResource は、カメラのコンテンツバッファーとして使用する Direct3D 12 リソースを作成します。
| pDevice | ID3D12Device* | in | リソースの作成に使用される Direct3D 12 デバイスです。 |
| pTexture2DDesc | D3D12_RESOURCE_DESC* | in | Direct3D 12 リソースの記述です。 CreateDirect3D12HardwareProtectedBackBufferResource は、実行時に決定されるバッファーサイズやフォーマットの制約など、プラットフォームの要件に準拠するために、必要に応じてこの記述を調整します。アプリケーションは、ppCreatedTexture2DResource で返されるテクスチャーの記述子を確認し、指定した内容との差異に適切に対応する必要があります。 |
| pProtectedResourceSession | ID3D12ProtectedResourceSession* | in | 省略可能な Direct3D 12 の保護されたリソースセッションです。有効な保護セッションを渡すと、このメソッドは Direct3D 12 のハードウェア保護されたリソースを作成します。 |
| ppCreatedTexture2DResource | ID3D12Resource** | out | 成功した場合は、バックバッファーとして使用するハードウェア保護された Direct3D 12 の 2D テクスチャーリソースです。それ以外の場合は nullptr です。 |
戻り値
成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。
IHolographicCameraInterop::AcquireDirect3D12BufferResource 関数は、Direct3D 12 バッファーリソースを取得します。
| pResourceToAcquire | ID3D12Resource* | in | 取得する Direct3D 12 リソースです。 |
| pCommandQueue | ID3D12CommandQueue* | in | アプリケーション用にこのリソースを取得する際に、その状態を遷移させるために使用する Direct3D 12 コマンドキューです。 リソースは取得された時点で D3D12_RESOURCE_STATE_COMMON 状態になります。取得時にリソースが既に共通状態にある場合、リソース遷移コマンドはキューに入れられないことがあります。 |
戻り値
成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。
IHolographicCameraInterop::AcquireDirect3D12BufferResourceWithTimeout 関数は、省略可能なタイムアウトを指定して Direct3D 12 バッファーリソースを取得します。
| pResourceToAcquire | ID3D12Resource* | in | 取得する Direct3D 12 リソースです。 |
| pCommandQueue | ID3D12CommandQueue* | in | アプリケーション用にこのリソースを取得する際に、その状態を遷移させるために使用する Direct3D 12 コマンドキューです。リソースは取得された時点で D3D12_RESOURCE_STATE_COMMON 状態になります。 |
| duration | ULONGLONG | in | このパラメーターに 0 以外の値を設定すると、呼び出しはバッファーが取得されるまでその時間だけ待機します。バッファーを取得できる前にタイムアウト期間が経過した場合、このメソッドはエラーコード E_TIMEOUT で失敗します。このパラメーターは、TimeSpan.Duration フィールドと同様に 100 ナノ秒単位で指定します。 |
戻り値
成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。
IHolographicCameraInterop::UnacquireDirect3D12BufferResource 関数は、Direct3D 12 バッファーリソースの取得を解除します。
| pResourceToUnacquire | ID3D12Resource* | in | 制御を手放す Direct3D 12 リソースです。 |
戻り値
成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
HSP用 COM定義
#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。
#define global IID_IHolographicCameraInterop "{7CC1F9C5-6D02-41FA-9500-E1809EB48EEC}" #usecom global IHolographicCameraInterop IID_IHolographicCameraInterop "{}" #comfunc global IHolographicCameraInterop_CreateDirect3D12BackBufferResource 6 sptr,var,sptr #comfunc global IHolographicCameraInterop_CreateDirect3D12HardwareProtectedBackBufferResource 7 sptr,var,sptr,sptr #comfunc global IHolographicCameraInterop_AcquireDirect3D12BufferResource 8 sptr,sptr #comfunc global IHolographicCameraInterop_AcquireDirect3D12BufferResourceWithTimeout 9 sptr,sptr,int64 #comfunc global IHolographicCameraInterop_UnacquireDirect3D12BufferResource 10 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IHolographicCameraInterop "{7CC1F9C5-6D02-41FA-9500-E1809EB48EEC}" #usecom global IHolographicCameraInterop IID_IHolographicCameraInterop "{}" #comfunc global IHolographicCameraInterop_CreateDirect3D12BackBufferResource 6 sptr,sptr,sptr #comfunc global IHolographicCameraInterop_CreateDirect3D12HardwareProtectedBackBufferResource 7 sptr,sptr,sptr,sptr #comfunc global IHolographicCameraInterop_AcquireDirect3D12BufferResource 8 sptr,sptr #comfunc global IHolographicCameraInterop_AcquireDirect3D12BufferResourceWithTimeout 9 sptr,sptr,int64 #comfunc global IHolographicCameraInterop_UnacquireDirect3D12BufferResource 10 sptr ; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。 ; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。