Skip to content

Latest commit

 

History

History
90 lines (69 loc) · 2.68 KB

nf-dxgi-idxgisurface-map.md

File metadata and controls

90 lines (69 loc) · 2.68 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:dxgi.IDXGISurface.Map
IDXGISurface::Map (dxgi.h)
Get a pointer to the data contained in the surface, and deny GPU access to the surface.
2353661a-8e73-6878-2899-79d0afdc2901
IDXGISurface interface [DXGI]
Map method
IDXGISurface.Map
IDXGISurface::Map
Map
Map method [DXGI]
Map method [DXGI]
IDXGISurface interface
direct3ddxgi.idxgisurface_map
dxgi/IDXGISurface::Map
direct3ddxgi\idxgisurface_map.htm
direct3ddxgi
VS|directx_sdk|~\idxgisurface_map.htm
12/05/2018
2353661a-8e73-6878-2899-79d0afdc2901, IDXGISurface interface [DXGI],Map method, IDXGISurface.Map, IDXGISurface::Map, Map, Map method [DXGI], Map method [DXGI],IDXGISurface interface, direct3ddxgi.idxgisurface_map, dxgi/IDXGISurface::Map
dxgi.h
Windows
DXGI.lib
Windows
19H1
IDXGISurface::Map
dxgi/IDXGISurface::Map
c++
APIRef
kbSyntax
COM
DXGI.lib
DXGI.dll
IDXGISurface.Map

IDXGISurface::Map

-description

Get a pointer to the data contained in the surface, and deny GPU access to the surface.

-parameters

-param pLockedRect [out]

Type: DXGI_MAPPED_RECT*

A pointer to the surface data (see DXGI_MAPPED_RECT).

-param MapFlags

Type: UINT

CPU read-write flags. These flags can be combined with a logical OR.

  • DXGI_MAP_READ - Allow CPU read access.
  • DXGI_MAP_WRITE - Allow CPU write access.
  • DXGI_MAP_DISCARD - Discard the previous contents of a resource when it is mapped.

-returns

Type: HRESULT

Returns S_OK if successful; otherwise, returns one of the error codes that are described in the DXGI_ERROR topic.

-remarks

Use IDXGISurface::Map to access a surface from the CPU. To release a mapped surface (and allow GPU access) call IDXGISurface::Unmap.

-see-also

IDXGISurface