Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 4.56 KB

nf-dxgi1_2-idxgioutput1-getdisplaysurfacedata1.md

File metadata and controls

80 lines (63 loc) · 4.56 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:dxgi1_2.IDXGIOutput1.GetDisplaySurfaceData1
IDXGIOutput1::GetDisplaySurfaceData1 (dxgi1_2.h)
Copies the display surface (front buffer) to a user-provided resource.
GetDisplaySurfaceData1
GetDisplaySurfaceData1 method [DXGI]
GetDisplaySurfaceData1 method [DXGI]
IDXGIOutput1 interface
IDXGIOutput1 interface [DXGI]
GetDisplaySurfaceData1 method
IDXGIOutput1.GetDisplaySurfaceData1
IDXGIOutput1::GetDisplaySurfaceData1
direct3ddxgi.idxgioutput1_getdisplaysurfacedata1
dxgi1_2/IDXGIOutput1::GetDisplaySurfaceData1
direct3ddxgi\idxgioutput1_getdisplaysurfacedata1.htm
direct3ddxgi
120BC7CD-A4B2-4688-9A11-0BD59761B5F1
12/05/2018
GetDisplaySurfaceData1, GetDisplaySurfaceData1 method [DXGI], GetDisplaySurfaceData1 method [DXGI],IDXGIOutput1 interface, IDXGIOutput1 interface [DXGI],GetDisplaySurfaceData1 method, IDXGIOutput1.GetDisplaySurfaceData1, IDXGIOutput1::GetDisplaySurfaceData1, direct3ddxgi.idxgioutput1_getdisplaysurfacedata1, dxgi1_2/IDXGIOutput1::GetDisplaySurfaceData1
dxgi1_2.h
Windows
Windows 8 and Platform Update for Windows 7 [desktop apps \| UWP apps]
Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps \| UWP apps]
DXGI.lib
Windows
19H1
IDXGIOutput1::GetDisplaySurfaceData1
dxgi1_2/IDXGIOutput1::GetDisplaySurfaceData1
c++
APIRef
kbSyntax
COM
DXGI.lib
DXGI.dll
IDXGIOutput1.GetDisplaySurfaceData1

IDXGIOutput1::GetDisplaySurfaceData1

-description

Copies the display surface (front buffer) to a user-provided resource.

-parameters

-param pDestination [in]

A pointer to a resource interface that represents the resource to which GetDisplaySurfaceData1 copies the display surface.

-returns

Returns one of the error codes described in the DXGI_ERROR topic.

-remarks

GetDisplaySurfaceData1 is similar to IDXGIOutput::GetDisplaySurfaceData except GetDisplaySurfaceData1 takes an IDXGIResource and IDXGIOutput::GetDisplaySurfaceData takes an IDXGISurface.

GetDisplaySurfaceData1 returns an error if the input resource is not a 2D texture (represented by the ID3D11Texture2D interface) with an array size (ArraySize member of the D3D11_TEXTURE2D_DESC structure) that is equal to the swap chain buffers.

The original IDXGIOutput::GetDisplaySurfaceData and the updated GetDisplaySurfaceData1 behave exactly the same. GetDisplaySurfaceData1 was required because textures with an array size equal to 2 (ArraySize = 2) do not implement IDXGISurface.

You can call GetDisplaySurfaceData1 only when an output is in full-screen mode. If GetDisplaySurfaceData1 succeeds, it fills the destination resource.

Use IDXGIOutput::GetDesc to determine the size (width and height) of the output when you want to allocate space for the destination resource. This is true regardless of target monitor rotation. A destination resource created by a graphics component (such as Direct3D 11) must be created with CPU write permission (see D3D11_CPU_ACCESS_WRITE). Other surfaces can be created with CPU read-write permission (D3D11_CPU_ACCESS_READ | D3D11_CPU_ACCESS_WRITE). GetDisplaySurfaceData1 modifies the surface data to fit the destination resource (stretch, shrink, convert format, rotate). GetDisplaySurfaceData1 performs the stretch and shrink with point sampling.

-see-also

IDXGIOutput1