WRL에서 C++/WinRT로 이동

아티클
07/13/2023

Windows 런타임 C++ 템플릿 라이브러리(WRL) 코드를 C++/WinRT의 상응하는 코드로 포팅하는 방법을 보여줍니다.

C++/WinRT로 포팅하는 첫 번째 단계는 수동으로 C++/WinRT 지원을 프로젝트에 추가하는 것입니다(C++/WinRT에 대한 Visual Studio 지원 참조). 이 작업을 수행하려면 Microsoft.Windows.CppWinRT NuGet 패키지를 프로젝트에 설치합니다. Visual Studio에서 프로젝트를 열어 프로젝트>NuGet 패키지 관리...>찾아보기를 차례로 클릭하고, 검색 상자에서 Microsoft.Windows.CppWinRT를 입력하거나 붙여넣고, 검색 결과에서 해당 항목을 선택한 다음, 설치를 클릭하여 해당 프로젝트에 대한 패키지를 설치합니다. 해당 변경의 효과 중 하나는 프로젝트에서 C++/CX에 대한 지원이 꺼진다는 것입니다. 프로젝트에서 C++/CX를 사용 중인 경우 지원을 끈 채로 유지하고 C++/CX 코드를 C++/WinRT에도 업데이트할 수 있습니다(C++/CX에서 C++/WinRT로 이동 참조). 또는 지원을 다시 켜고(프로젝트 속성에서 C/C++>일반>Windows 런타임 확장 사용>예(/ZW)) 먼저 WRL 코드 포트에 집중할 수 있습니다. C++/CX 및 C++/WinRT 코드는 같은 프로젝트에 공존할 수 있으며, XAML 컴파일러 지원 및 Windows 런타임 구성 요소의 예외가 있습니다(C++/CX에서 C++/WinRT로 이동 참조).

프로젝트 속성 일반>대상 플랫폼 버전을 10.0.17134.0(Windows 10 버전 1803) 이상으로 설정합니다.

컴파일된 헤더 파일에(일반적으로 pch.h) winrt/base.h를 포함합니다.

#include <winrt/base.h>

C++/WinRT 프로젝션된 Windows API 헤더를 포함하는 경우(예: winrt/Windows.Foundation.h) 자동으로 포함되기 때문에 명시적으로 이와 같은 winrt/base.h를 포함할 필요가 없습니다.

WRL COM 스마트 포인터 포팅(Microsoft: WRL::ComPtr)

Microsoft::WRL::ComPtr<T>를 사용하는 코드를 포팅하여 winrt::com_ptr<T>를 사용합니다. 다음은 코드 이전과 이후의 예제입니다. 이후 버전에서 com_ptr::put 멤버 함수는 기본 원시 포인터를 설정할 수 있도록 검색합니다.

ComPtr<IDXGIAdapter1> previousDefaultAdapter;
DX::ThrowIfFailed(m_dxgiFactory->EnumAdapters1(0, &previousDefaultAdapter));

winrt::com_ptr<IDXGIAdapter1> previousDefaultAdapter;
winrt::check_hresult(m_dxgiFactory->EnumAdapters1(0, previousDefaultAdapter.put()));

Important

이미 배치된 winrt::com_ptr이 있고(내부 원시 포인터에 이미 대상이 있음) 다른 개체를 가리키도록 다시 배치하려는 경우, 아래 코드 예제와 같이 nullptr를 먼저 할당해야 합니다. 할당하지 않으면, com_ptr::put 또는 com_ptr::put_void를 호출할 때 이미 배치된 com_ptr에서 내부 포인터가 Null이 아님을 어설션하여 문제가 부각됩니다.

winrt::com_ptr<IDXGISwapChain1> m_pDXGISwapChain1;
...
// We execute the code below each time the window size changes.
m_pDXGISwapChain1 = nullptr; // Important because we're about to re-seat 
winrt::check_hresult(
    m_pDxgiFactory->CreateSwapChainForHwnd(
        m_pCommandQueue.get(), // For Direct3D 12, this is a pointer to a direct command queue, and not to the device.
        m_hWnd,
        &swapChainDesc,
        nullptr,
        nullptr,
        m_pDXGISwapChain1.put())
);

다음 예제(이후 버전)에서는 com_ptr::put_void 멤버 함수는 피할 포인터에 대한 포인터로 기본 원시 포인터를 검색합니다.

ComPtr<ID3D12Debug> debugController;
if (SUCCEEDED(D3D12GetDebugInterface(IID_PPV_ARGS(&debugController))))
{
    debugController->EnableDebugLayer();
}

winrt::com_ptr<ID3D12Debug> debugController;
if (SUCCEEDED(D3D12GetDebugInterface(__uuidof(debugController), debugController.put_void())))
{
    debugController->EnableDebugLayer();
}

ComPtr::Get을 com_ptr::get으로 바꿉니다.

m_d3dDevice->CreateDepthStencilView(m_depthStencil.Get(), &dsvDesc, m_dsvHeap->GetCPUDescriptorHandleForHeapStart());

m_d3dDevice->CreateDepthStencilView(m_depthStencil.get(), &dsvDesc, m_dsvHeap->GetCPUDescriptorHandleForHeapStart());

IUnknown 포인터가 필요한 함수에 기본 원시 포인터를 전달하려면 다음 예제처럼 winrt::get_unknown 프리 함수를 사용합니다.

ComPtr<IDXGISwapChain1> swapChain;
DX::ThrowIfFailed(
    m_dxgiFactory->CreateSwapChainForCoreWindow(
        m_commandQueue.Get(),
        reinterpret_cast<IUnknown*>(m_window.Get()),
        &swapChainDesc,
        nullptr,
        &swapChain
    )
);

winrt::agile_ref<winrt::Windows::UI::Core::CoreWindow> m_window; 
winrt::com_ptr<IDXGISwapChain1> swapChain;
winrt::check_hresult(
    m_dxgiFactory->CreateSwapChainForCoreWindow(
        m_commandQueue.get(),
        winrt::get_unknown(m_window.get()),
        &swapChainDesc,
        nullptr,
        swapChain.put()
    )
);

WRL 모듈 포팅(Microsoft: WRL::Module)

이 섹션에서는 Microsoft:: WRL:: Module 형식을 사용하는 포팅 코드와 관련된 항목을 설명합니다.

C++/WinRT 코드를 구성 요소를 구현하기 위해 WRL을 사용하는 기존 프로젝트에 서서히 추가할 수 있으며 기존 WRL 클래스는 계속 지원됩니다. 이 섹션에서는 그 방법을 보여줍니다.

Visual Studio에서 새 Windows 런타임 구성 요소(C++/WinRT) 프로젝트 형식을 만드는 경우 Generated Files\module.g.cpp 파일이 생성됩니다. 해당 파일은 프로젝트에 복사하고 추가할 수 있는 두 가지 유용한 C++/WinRT 함수(아래에 나열)의 정의를 포함합니다. 이러한 함수는 WINRT_CanUnloadNow 및 WINRT_GetActivationFactory이며, 보시다시피 조건에 따라 사용자가 포팅하는 스테이지를 지원하기 위한 순서로 WRL을 호출합니다.

HRESULT WINRT_CALL WINRT_CanUnloadNow()
{
#ifdef _WRL_MODULE_H_
    if (!::Microsoft::WRL::Module<::Microsoft::WRL::InProc>::GetModule().Terminate())
    {
        return S_FALSE;
    }
#endif

    if (winrt::get_module_lock())
    {
        return S_FALSE;
    }

    winrt::clear_factory_cache();
    return S_OK;
}

HRESULT WINRT_CALL WINRT_GetActivationFactory(HSTRING classId, void** factory)
{
    try
    {
        *factory = nullptr;
        wchar_t const* const name = WINRT_WindowsGetStringRawBuffer(classId, nullptr);

        if (0 == wcscmp(name, L"MoveFromWRLTest.Class"))
        {
            *factory = winrt::detach_abi(winrt::make<winrt::MoveFromWRLTest::factory_implementation::Class>());
            return S_OK;
        }

#ifdef _WRL_MODULE_H_
        return ::Microsoft::WRL::Module<::Microsoft::WRL::InProc>::GetModule().GetActivationFactory(classId, reinterpret_cast<::IActivationFactory**>(factory));
#else
        return winrt::hresult_class_not_available().to_abi();
#endif
    }
    catch (...) { return winrt::to_hresult(); }
}

이러한 기능을 프로젝트에 가져왔으면 Module::GetActivationFactory를 직접 호출하는 대신 WINRT_GetActivationFactory(내부적으로 WRL 함수를 호출)를 호출합니다. 다음은 코드 이전과 이후의 예제입니다.

HRESULT WINAPI DllGetActivationFactory(_In_ HSTRING activatableClassId, _Out_ ::IActivationFactory **factory)
{
    auto & module = Microsoft::WRL::Module<Microsoft::WRL::InProc>::GetModule();
    return module.GetActivationFactory(activatableClassId, factory);
}

HRESULT __stdcall WINRT_GetActivationFactory(HSTRING activatableClassId, void** factory);
HRESULT WINAPI DllGetActivationFactory(_In_ HSTRING activatableClassId, _Out_ ::IActivationFactory **factory)
{
    return WINRT_GetActivationFactory(activatableClassId, reinterpret_cast<void**>(factory));
}

Module::Terminate를 직접 호출하는 대신 WINRT_CanUnloadNow(내부적으로 WRL 함수를 호출)를 호출합니다. 다음은 코드 이전과 이후의 예제입니다.

HRESULT __stdcall DllCanUnloadNow(void)
{
    auto &module = Microsoft::WRL::Module<Microsoft::WRL::InProc>::GetModule();
    HRESULT hr = (module.Terminate() ? S_OK : S_FALSE);
    if (hr == S_OK)
    {
        hr = ...
    }
    return hr;
}

HRESULT __stdcall WINRT_CanUnloadNow();
HRESULT __stdcall DllCanUnloadNow(void)
{
    HRESULT hr = WINRT_CanUnloadNow();
    if (hr == S_OK)
    {
        hr = ...
    }
    return hr;
}

Microsoft::WRL::Wrappers 래퍼 포팅

이 섹션에서는 Microsoft::WRL::Wrappers 래퍼를 사용하는 포팅 코드와 관련된 항목을 설명합니다.

아래 표에서 볼 수 있듯이 스레딩 도우미를 바꾸려면 표준 C++ 스레드 지원 라이브러리를 사용하는 것이 좋습니다. 사용자의 요구에 따라 선택이 달라지므로 WRL 래퍼의 일대일 매핑이 잘못될 수 있습니다. 또한 명확하게 매핑할 수 있는 일부 형식은 C ++ 20 표준에 새로 도입되었으므로 아직 업그레이드하지 않은 경우 비실용적입니다.

Type	포팅 노트
CriticalSection 클래스	스레드 지원 라이브러리 사용
이벤트 클래스(WRL)	winrt::event struct template 사용
HandleT 클래스	winrt::handle struct 또는 winrt::file_handle struct 사용
HString 클래스	winrt::hstring struct 사용
HStringReference 클래스	C++/WinRT는 사용자가 고려할 필요가 없는 이점이 있는 HStringReference만큼이나 효율적인 방식으로 이를 내부적으로 처리하기 때문에 대체할 필요가 없습니다.
Mutex 클래스	스레드 지원 라이브러리 사용
RoInitializeWrapper 클래스	winrt::init_apartment 및 winrt::uninit_apartment를 사용하거나 CoInitializeEx 및 CoUninitialize 주변에 간단한 래퍼를 작성합니다.
Semaphore 클래스	스레드 지원 라이브러리 사용
SRWLock 클래스	스레드 지원 라이브러리 사용

WRL에서 C++/WinRT로 이동

WRL COM 스마트 포인터 포팅(Microsoft: WRL::ComPtr)

WRL 모듈 포팅(Microsoft: WRL::Module)

Microsoft::WRL::Wrappers 래퍼 포팅

중요 API

피드백

피드백

추가 리소스

WRL에서 C++/WinRT로 이동

WRL COM 스마트 포인터 포팅(Microsoft: WRL::ComPtr)

WRL 모듈 포팅(Microsoft: WRL::Module)

Microsoft::WRL::Wrappers 래퍼 포팅

중요 API

관련 항목

피드백

피드백

추가 리소스