在 DirectX 代码中正确使用 ComPtr答案

【问题标题】：Proper usage of ComPtr in DirectX code在 DirectX 代码中正确使用 ComPtr
【发布时间】：2023-03-06 13:43:01
【问题描述】：

我正在编写一个基于 DirectX 11 的引擎。所有 DirectX Com 对象都包装在 Microsoft::WRL::ComPtr 中。但不幸的是，当我在关机时调用 ID3D11Debug::ReportLiveDeviceObjects 时，它报告的不止 1 个对象的引用计数不为零。

我很困惑，哪些代码实际上增加了这些引用计数，从而防止引用最后为零。例如，我在代码中提供了 ID3D11ShaderResourceView 的示例用法：

ID3D11ShaderResourceView 在我的渲染目标类中被声明为成员，

Microsoft::WRL::ComPtr<ID3D11ShaderResourceView> m_pShaderResourceView

在构造函数中初始化为nullptr：

m_pShaderResourceView(wwNULLPTR)

界面创建如下：

device->CreateShaderResourceView(m_pDXTexture.Get(), &shaderResourceDesc, m_pShaderResourceView.ReleaseAndGetAddressOf());

GenerateMips函数中使用了该接口：

deviceContext->GenerateMips(m_pShaderResourceView.Get());

接口有一个getter函数：

ID3D11ShaderResourceView* GetShaderResourceView() 
{ 
     return m_pShaderResourceView.Get(); 
}

最后界面在析构函数中被重置：

m_pShaderResourceView.Reset();

最后，我在活动对象摘要中获得了至少 8 个引用。

我的问题是：

我的代码的哪一部分实际上增加了引用计数？为什么调用 Reset 不会使参考为零？可能我错过了什么？

谢谢。

【问题讨论】：

智能指针一直是乌龟，一旦你放弃它们，你就会陷入困境。您的 GetShaderResourceView() 函数正在返回一个原始接口指针。你没有释放它。如果你声明它返回一个 CComPtr 那么你就不会遇到这个问题。
让 GetShaderResourceView() 返回一个 CComPtr 引用对我来说没有任何区别。我的代码是： D3D11ShaderResourceViewPtr& GetShaderResourceView() { return m_pShaderResourceView;其中 D3D11ShaderResourceViewPtr 是 Microsoft::WRL::ComPtr 的 typedef。

标签： com directx-11

【解决方案1】：

ID3D11Debug::ReportLiveDeviceObjects 是一个非常有用的调试工具，但它确实有一些怪癖。具体来说，一些对象具有您无法直接控制的生命，它们是 ID3D11Device 本身的一部分。如果不关闭设备，您将无法摆脱引用，此时您将无法获得活动对象报告。

在DXUT for Direct3D 11 框架中，我通过在调用报告活动对象之前调用ClearState 然后在直接上下文上调用Flush 来尽可能地降低它。

即使在“干净”的出口中，您仍然会有一些挥之不去的“活动”对象：

D3D11 WARNING: Live ID3D11Device at 0x025CA03C, Refcount: 5 [ STATE_CREATION WARNING #441: LIVE_DEVICE]
D3D11 WARNING:  Live ID3D11Context at 0x02831030, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #2097226: LIVE_CONTEXT]
D3D11 WARNING:  Live ID3DDeviceContextState at 0x02828038, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #3145742: LIVE_DEVICECONTEXTSTATE]
D3D11 WARNING:  Live ID3D11BlendState at 0x005B766C, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #435: LIVE_BLENDSTATE]
D3D11 WARNING:  Live ID3D11DepthStencilState at 0x0283ECAC, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #436: LIVE_DEPTHSTENCILSTATE]
D3D11 WARNING:  Live ID3D11RasterizerState at 0x027006F4, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #437: LIVE_RASTERIZERSTATE]
D3D11 WARNING:  Live ID3D11Sampler at 0x0270082C, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #434: LIVE_SAMPLER]
D3D11 WARNING:  Live ID3D11Query at 0x005BB904, Refcount: 0, IntRef: 1 [ STATE_CREATION WARNING #438: LIVE_QUERY]
D3D11 WARNING: Live                  ID3D11Context :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]
D3D11 WARNING: Live         ID3DDeviceContextState :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]
D3D11 WARNING: Live               ID3D11BlendState :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]
D3D11 WARNING: Live        ID3D11DepthStencilState :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]
D3D11 WARNING: Live          ID3D11RasterizerState :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]
D3D11 WARNING: Live                  ID3D11Sampler :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]
D3D11 WARNING: Live                    ID3D11Query :      1 [ STATE_CREATION WARNING #422: LIVE_OBJECT_SUMMARY]

这些是运行时本身使用的“默认”对象。理想情况下，调试运行时会在生成此报告时忽略它们，但它不会。

也就是说，由于您有 8 个而不是 5 个活动对象，因此您可能会有一些挥之不去的东西。首先尝试ClearState 和Flush 以确保您没有任何东西由于被绑定到管道或由于延迟破坏而保持活力。如果仍然有对象，找到它们的下一步是使用“调试对象命名”，这样您就可以找出您控制的对象仍然存在。调试命名可以使用宏或模板来完成：

模板

template<UINT TNameLength>
inline void SetDebugObjectName(_In_ ID3D11DeviceChild* resource, _In_z_ const char (&name)[TNameLength])
{
    #if defined(_DEBUG)
       resource->SetPrivateData(WKPDID_D3DDebugObjectName, TNameLength - 1, name);
    #else
        UNREFERENCED_PARAMETER(resource);
        UNREFERENCED_PARAMETER(name);
    #endif
}

宏

#ifdef _DEBUG

inline void DXUT_SetDebugName( _In_ ID3D11DeviceChild* pObj,
    _In_z_ const CHAR* pstrName )
{
    if ( pObj )
        pObj->SetPrivateData( WKPDID_D3DDebugObjectName,
            (UINT)strlen(pstrName), pstrName );
}
#else
#define DXUT_SetDebugName( pObj, pstrName )
#endif

您需要链接到dxguid.lib 以获取符号WKPDID_D3DDebugObjectName。 “WKPDID”代表众所周知的私有数据 ID。这很讽刺，因为它并不是那么“众所周知”。

见Object Naming和Direct3D SDK Debug Layer Tricks

【讨论】：