Win32 API 日本語リファレンス
ホームSystem.WinRT.Holographic › IHolographicQuadLayerInterop

IHolographicQuadLayerInterop

COM
IIDcfa688f0-639e-4a47-83d7-6b7f5ebf7fed継承元IInspectable自前メソッド開始 vtbl6

公式ドキュメント

Direct3D 12 を使用してホログラフィックレンダリングを行うアプリ向けに、HolographicQuadLayer Windows ランタイムクラスとの COM 相互運用を可能にする nano-COM インターフェイスです。

解説(Remarks)

このインターフェイスを C++/WinRT で使用するには、HolographicQuadLayer オブジェクトから IHolographicQuadLayerInterop インターフェイスを QueryInterface で取得します。

バッファーフォーマットの利用可能なオプションを判別するには、HolographicViewConfiguration API を使用できます。

m_quadLayer = HolographicQuadLayer{ {1024, 1024} };
winrt::com_ptr<IHolographicQuadLayerInterop> quadLayerInterop{
    m_quadLayer.as<IHolographicQuadLayerInterop>() };

// バッファーの作成/取得。
if (!m_D3D12ContentBuffer[m_contentBufferIndex])
{
    D3D12_RESOURCE_DESC bufferDesc{ sourceDesc };
    bufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
    bufferDesc.SampleDesc.Count = 1;
    bufferDesc.SampleDesc.Quality = 0;
    bufferDesc.MipLevels = 1;

    winrt::check_hresult(
        quadLayerInterop->CreateDirect3D12ContentBufferResource(
            m_deviceResources->GetD3D12Device(),
            &bufferDesc,
            &m_D3D12ContentBuffer[m_contentBufferIndex]));
}

このインターフェイスを C++/CX で使用するには、HolographicQuadLayer オブジェクトを IInspectable* にキャストします。次に、IInspectable ポインターから IHolographicQuadLayerInterop インターフェイスを QueryInterface で取得します。

m_quadLayer = ref new HolographicQuadLayer();
Microsoft::WRL::ComPtr<IHolographicQuadLayerInterop> quadLayerInterop;
{
    Microsoft::WRL::ComPtr<IInspectable> iInspectable = reinterpret_cast<IInspectable*>(m_quadLayer);
    DX::ThrowIfFailed(iInspectable.As(&quadLayerInterop));
}

// バッファーの作成/取得。
if (!m_D3D12ContentBuffer[m_contentBufferIndex])
{
    D3D12_RESOURCE_DESC bufferDesc = sourceDesc;
    bufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
    bufferDesc.SampleDesc.Count = 1;
    bufferDesc.SampleDesc.Quality = 0;
    bufferDesc.MipLevels = 1;

    DX::ThrowIfFailed(quadLayerInterop->CreateDirect3D12ContentBufferResource(
        m_deviceResources->GetD3D12Device(),
        &bufferDesc,
        &m_D3D12ContentBuffer[m_contentBufferIndex]));
}

メソッド 5

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 6 HRESULT CreateDirect3D12ContentBufferResource(ID3D12Device* pDevice, D3D12_RESOURCE_DESC* pTexture2DDesc, ID3D12Resource** ppTexture2DResource)

レイヤーのコンテンツバッファーとして使用する Direct3D 12 リソースを作成します。

pDeviceID3D12Device*inリソースの作成に使用される Direct3D 12 デバイスです。
pTexture2DDescD3D12_RESOURCE_DESC*in

Direct3D 12 リソースの記述です。このパラメーターは省略できません。

CreateDirect3D12ContentBufferResource は、実行時に決定されるバッファーサイズやフォーマットの制限などのプラットフォーム要件に準拠するよう、必要に応じて記述を調整します。アプリケーションは、ppCreatedTexture2DResource で返されるテクスチャの記述子を確認し、指定した内容との相違に適切に対応する必要があります。

ppTexture2DResourceID3D12Resource**out成功した場合は、コンテンツバッファーとして使用する Direct3D 12 の 2D テクスチャリソースです。それ以外の場合は nullptr です。

戻り値

成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。

vtbl 7 HRESULT CreateDirect3D12HardwareProtectedContentBufferResource(ID3D12Device* pDevice, D3D12_RESOURCE_DESC* pTexture2DDesc, ID3D12ProtectedResourceSession* pProtectedResourceSession, ID3D12Resource** ppCreatedTexture2DResource)

IHolographicQuadLayerInterop::CreateDirect3D12HardwareProtectedContentBufferResource 関数は、カメラ用の Direct3D 12 リソースコンテンツバッファーを作成します。

pDeviceID3D12Device*inリソースの作成に使用される Direct3D 12 デバイスです。
pTexture2DDescD3D12_RESOURCE_DESC*in

Direct3D 12 リソースの記述です。

CreateDirect3D12HardwareProtectedContentBufferResource は、実行時に決定されるバッファーサイズやフォーマットの制限などのプラットフォーム要件に準拠するよう、必要に応じて記述を調整します。アプリケーションは、ppCreatedTexture2DResource で返されるテクスチャの記述子を確認し、指定した内容との相違に適切に対応する必要があります。

pProtectedResourceSessionID3D12ProtectedResourceSession*in省略可能な Direct3D 12 保護リソースセッションです。有効な保護セッションを渡すと、このメソッドは Direct3D 12 のハードウェア保護リソースを作成します。
ppCreatedTexture2DResourceID3D12Resource**out成功した場合は、コンテンツバッファーとして使用するハードウェア保護された Direct3D 12 の 2D テクスチャリソースです。それ以外の場合は nullptr です。

戻り値

成功した場合は S_OK。それ以外の場合は、失敗の 理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。

vtbl 8 HRESULT AcquireDirect3D12BufferResource(ID3D12Resource* pResourceToAcquire, ID3D12CommandQueue* pCommandQueue)

IHolographicQuadLayerInterop::AcquireDirect3D12BufferResource 関数は、Direct3D 12 バッファーリソースを取得します。

pResourceToAcquireID3D12Resource*in取得する Direct3D 12 リソースです。取得時、リソースは D3D12_RESOURCE_STATE_COMMON 状態になります。
pCommandQueueID3D12CommandQueue*inアプリケーション用にこのリソースを取得する際、その状態を遷移させるために使用する Direct3D 12 コマンドキューです。

戻り値

成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。

vtbl 9 HRESULT AcquireDirect3D12BufferResourceWithTimeout(ID3D12Resource* pResourceToAcquire, ID3D12CommandQueue* pCommandQueue, ULONGLONG duration)

IHolographicQuadLayerInterop::AcquireDirect3D12BufferResourceWithTimeout 関数は、省略可能なタイムアウトを指定して Direct3D 12 バッファーリソースを取得します。

pResourceToAcquireID3D12Resource*in取得する Direct3D 12 リソースです。取得時、リソースは D3D12_RESOURCE_STATE_COMMON 状態になります。
pCommandQueueID3D12CommandQueue*inアプリケーション用にこのリソースを取得する際、その状態を遷移させるために使用する Direct3D 12 コマンドキューです。
durationULONGLONGinこのパラメーターを設定すると、呼び出しはバッファーが取得されるまでその時間だけ待機します。バッファーを取得できないままタイムアウト時間が経過した場合、メソッドはエラーコード E_TIMEOUT で失敗します。このパラメーターは、TimeSpan.Duration フィールドと同様に 100 ナノ秒単位です。

戻り値

成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。

タイムアウト値が指定されていない場合、このメソッドが呼び出された時点でバッファーが取得可能な状態でなければ、メソッドの呼び出しはエラーコード E_NOTREADY で失敗します。

vtbl 10 HRESULT UnacquireDirect3D12BufferResource(ID3D12Resource* pResourceToUnacquire)

IHolographicQuadLayerInterop::UnacquireDirect3D12BufferResource 関数は、Direct3D 12 バッファーリソースの取得を解除します。

pResourceToUnacquireID3D12Resource*in制御を手放す Direct3D 12 リソースです。

戻り値

成功した場合は S_OK。それ以外の場合は、失敗の理由を示す HRESULT エラーコードを返します。COM Error Codes (UI, Audio, DirectX, Codec) も参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_IHolographicQuadLayerInterop "{CFA688F0-639E-4A47-83D7-6B7F5EBF7FED}"
#usecom global IHolographicQuadLayerInterop IID_IHolographicQuadLayerInterop "{}"
#comfunc global IHolographicQuadLayerInterop_CreateDirect3D12ContentBufferResource                   6 sptr,var,sptr
#comfunc global IHolographicQuadLayerInterop_CreateDirect3D12HardwareProtectedContentBufferResource  7 sptr,var,sptr,sptr
#comfunc global IHolographicQuadLayerInterop_AcquireDirect3D12BufferResource                         8 sptr,sptr
#comfunc global IHolographicQuadLayerInterop_AcquireDirect3D12BufferResourceWithTimeout              9 sptr,sptr,int64
#comfunc global IHolographicQuadLayerInterop_UnacquireDirect3D12BufferResource                       10 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。