Enabling Hardware Acceleration on RDP

Author: Kuldeep-MS

src/Microsoft.DotNet.Wpf/src/WpfGfx/core/common/d3dutils.cpp

@@ -232,10 +232,19 @@ GetMinimalTextureDesc(
         }
 
         // If format is ok, restore HR from width/height check
-        if (hr == S_OK)
+        if (::IsGraphicHWAccelerationForRDPEnabled())
         {
-            hr = hrWH;
+            if(SUCCEEDED(hr))
+            {
+                hr = hrWH;
+            }
+        } else {
+            if (hr == S_OK)
+            {
+                hr = hrWH;
+            }
         }
+        
     }
 
 #if DBG
@@ -316,7 +325,84 @@ GetSuperiorSurfaceFormat(
     return D3DFMT_UNKNOWN;
 }
 
+//+------------------------------------------------------------------------
+//
+//  Function:   IsGraphicHWAccelerationForRDPEnabled
+//
+//  Synopsis:
+//      Checks to see if user has enabled graphich hardware acceleration in remote connection.
+//      An app can opt-in to enable HW acceleration by setting a regkey in
+//          HKCU\Software\Microsoft\Avalon.Graphics\EnableRemoteHWAcceleration
+//      or
+//          HKLM\Software\Microsoft\Avalon.Graphics\EnableRemoteHWAcceleration
+//      whose name is the full path to the .exe that wants to opt-in, and whose DWORD value is 1.
+//
+//      The regkey is checked in the first call to this function, and the
+//      value is cached for all future calls in this process.
+//
+//-------------------------------------------------------------------------
+bool
+IsGraphicHWAccelerationForRDPEnabled()
+{
+    enum IsRemoteHWAccelerationEnabledState
+    {
+        HWAcceleration_Uninitialized,
+        HWAcceleration_False,
+        HWAcceleration_True,
+    };
+    static IsRemoteHWAccelerationEnabledState s_hwAccelerationFlag = IsRemoteHWAccelerationEnabledState::HWAcceleration_Uninitialized;
+    if (s_hwAccelerationFlag == IsRemoteHWAccelerationEnabledState::HWAcceleration_Uninitialized)
+    {
+        TCHAR szFullPath[MAX_PATH];
+        DWORD cFullPath = GetModuleFileName(NULL, szFullPath, sizeof(szFullPath) / sizeof(szFullPath[0]));
 
-
-
-
+        if (cFullPath > 0)
+        {
+            // First check for a value in HKCU (which should override any HKLM setting).
+            HKEY hKey = NULL;
+            LONG r = RegOpenKeyEx(
+                HKEY_CURRENT_USER,
+                _T("Software\\Microsoft\\Avalon.Graphics\\EnableRemoteHWAcceleration"),
+                0,
+                KEY_QUERY_VALUE,
+                &hKey
+            );
+            if (r == ERROR_SUCCESS)
+            {
+                DWORD dwValue = 0; // default to false (don't ignore errors)
+                if (RegGetDword(hKey, szFullPath, &dwValue))
+                {
+                    s_hwAccelerationFlag = (dwValue == 0) ? IsRemoteHWAccelerationEnabledState::HWAcceleration_False : IsRemoteHWAccelerationEnabledState::HWAcceleration_True;
+                }
+                RegCloseKey(hKey);
+            }
+            // If we didn't set a value from HKCU, try HKLM.
+            if (s_hwAccelerationFlag == IsRemoteHWAccelerationEnabledState::HWAcceleration_Uninitialized)
+            {
+                r = RegOpenKeyEx(
+                    HKEY_LOCAL_MACHINE,
+                    _T("Software\\Microsoft\\Avalon.Graphics\\EnableRemoteHWAcceleration"),
+                    0,
+                    KEY_QUERY_VALUE,
+                    &hKey
+                );
+                if (r == ERROR_SUCCESS)
+                {
+                    DWORD dwValue = 0; // default to false (don't ignore errors)
+                    if (RegGetDword(hKey, szFullPath, &dwValue))
+                    {
+                        s_hwAccelerationFlag = (dwValue == 0) ? IsRemoteHWAccelerationEnabledState::HWAcceleration_False : IsRemoteHWAccelerationEnabledState::HWAcceleration_True;
+                    }
+                    RegCloseKey(hKey);
+                }
+            }
+        }
+        // If we still haven't set a value, then no value was set in the registry.
+        // Default to false (disable HW acceleration in remote connection).
+        if (s_hwAccelerationFlag == IsRemoteHWAccelerationEnabledState::HWAcceleration_Uninitialized)
+        {
+            s_hwAccelerationFlag = IsRemoteHWAccelerationEnabledState::HWAcceleration_False;
+        }
+    }
+    return (s_hwAccelerationFlag == IsRemoteHWAccelerationEnabledState::HWAcceleration_True);
+}

src/Microsoft.DotNet.Wpf/src/WpfGfx/core/common/d3dutils.h

@@ -105,4 +105,4 @@ D3DFORMAT GetSuperiorSurfaceFormat(
     BOOL fPalUsesAlpha
     );
 
-
+bool IsGraphicHWAccelerationForRDPEnabled();

src/Microsoft.DotNet.Wpf/src/WpfGfx/core/common/display.cpp

@@ -2125,7 +2125,7 @@ CDisplaySet::GetGraphicsAccelerationCaps(
         *pulDisplayUniqueness = m_ulDisplayUniquenessLoader;
     }
 
-    if (m_rgpDisplays.GetCount() == 0 || m_fNonLocalDevicePresent)
+    if (m_rgpDisplays.GetCount() == 0 || (!::IsGraphicHWAccelerationForRDPEnabled() && m_fNonLocalDevicePresent))
     {
         //
         // No display - no acceleration

src/Microsoft.DotNet.Wpf/src/WpfGfx/core/hw/hwbitmapcolorsource.cpp

@@ -1421,7 +1421,20 @@ CHwBitmapColorSource::ComputeRealizationParameters(
             &uLevels
             );
 
-        Assert(pDevice->GetMinimalTextureDesc(
+        if(::IsGraphicHWAccelerationForRDPEnabled())
+        {
+            Assert(SUCCEEDED(pDevice->GetMinimalTextureDesc(
+            &d3dsdRequired,
+            TRUE,
+            (GMTD_CHECK_ALL |
+             (TextureAddressingAllowsConditionalNonPower2Usage(
+                 oRealizationParams.dlU.d3dta,
+                 oRealizationParams.dlV.d3dta) ?
+              GMTD_NONPOW2CONDITIONAL_OK : 0)
+            )
+            )));
+        } else {
+            Assert(pDevice->GetMinimalTextureDesc(
             &d3dsdRequired,
             TRUE,
             (GMTD_CHECK_ALL |
@@ -1431,6 +1444,8 @@ CHwBitmapColorSource::ComputeRealizationParameters(
               GMTD_NONPOW2CONDITIONAL_OK : 0)
             )
             ) == S_OK);
+        }
+        
     }
     #endif
 

src/Microsoft.DotNet.Wpf/src/WpfGfx/core/meta/desktoprt.cpp

@@ -27,6 +27,7 @@
 //------------------------------------------------------------------------------
 
 #include "precomp.hpp"
+#include "common/d3dutils.h"
 
 DeclareTag(tagMILRenderClearAfterPresent, "MIL", "Clear after present");
 DeclareTag(tagMILTraceDesktopState, "MIL", "Trace MILRender desktop state");
@@ -93,7 +94,7 @@ HRESULT CDesktopRenderTarget::Create(
     // check whether any adapters don't support Hw acceleration or D3D is not
     // available.
     //
-    if (   pDisplaySet->IsNonLocalDisplayPresent()
+    if (   (!(::IsGraphicHWAccelerationForRDPEnabled()) && pDisplaySet->IsNonLocalDisplayPresent())
         || !pDisplaySet->D3DObject())
     {
         // If possible, just revert to Sw.  This simply prevents trying Hw and