DwmDxGetWindowSharedSurface function

Article
01/07/2021

Retrieves the DirectX shared surface backing a given window. This surface can be written to in order to update the contents of the window.

Syntax

HRESULT WINAPI DwmDxGetWindowSharedSurface(
  _In_     HWND        hwnd,
  _In_     LUID        luidAdapter,
  _In_opt_ HMONITOR    hmonitorAssociation,
  _In_     DWORD       dwFlags,
  _Inout_  DXGI_FORMAT *pfmtWindow,
  _Out_    HANDLE      *phDxSurface,
  _Out_    UINT64      *puiUpdateId
);

Parameters

hwnd

An HWND specifying the window to be updated.

luidAdapter

The LUID of the adapter where the surface should be located.

hmonitorAssociation

Reserved.

dwFlags

This parameter can be one of the following values, or a bitwise OR combination of multiple values where appropriate.

Value	Meaning
DWM_REDIRECTION_FLAG_WAIT 0	Causes the function to block until a vertical synchronization (VSync) has passed since the last time the function was called successfully.
DWM_REDIRECTION_FLAG_SUPPORT_PRESENT_TO_GDI_SURFACE 0x10	Indicates that the calling application is capable of presenting to a GDI shared surface.

pfmtWindow

On input, the desired format of the surface. On output, the actual format of the returned surface.

phDxSurface

On output, the shared handle to the surface.

puiUpdateId

On output, the ID of the update.

Return value

This function can return one of these values.

Return code	Description
S_OK	The call succeeded, and you should update the surface, being sure to pass the update ID to D3DKMTRender (in the PresentHistoryToken member of the D3DKMT_RENDER structure when the update is submitted, and then DwmDxUpdateWindowSharedSurface should be called with the same update ID. Note that DwmDxUpdateWindowSharedSurface should be called regardless of whether the surface was actually updated or not.
DWM_S_GDI_REDIRECTION_SURFACE	The call succeeded, and you should update the surface by calling D3DKMTPresent, and setting PresentHistoryToken member's Model to D3DKMT_PM_REDIRECTED_BLT, and providing the update ID in the Blt member of the union. This value is only returned if DWM_REDIRECTION_FLAG_SUPPORT_PRESENT_TO_GDI_SURFACE was specified in dwFlags.
DWM_E_ADAPTER_NOT_FOUND	The value of luidAdapter is not valid.
DWM_E_COMPOSITIONDISABLED	DWM is not currently enabled, and the application will need to present another way.

Remarks

This API is intended for implementing a graphics driver or runtime. An application may not call this method. This documentation is only valid for Windows 7, and this API is not guaranteed to exist nor behave in a similar manner on other versions of Windows. This function is not present in any header or static-link library, and it is located at ordinal 100 in dwmapi.dll.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	None supported
End of client support	Windows 7
Header	N/A
DLL	Dwmapi.dll

Share via