Skip to content

Latest commit

 

History

History
115 lines (79 loc) · 4.88 KB

nf-dcomp-idcompositionsurfacefactory-createvirtualsurface.md

File metadata and controls

115 lines (79 loc) · 4.88 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:dcomp.IDCompositionSurfaceFactory.CreateVirtualSurface
IDCompositionSurfaceFactory::CreateVirtualSurface (dcomp.h)
Creates a sparsely populated surface that can be associated with one or more visuals for composition. (IDCompositionSurfaceFactory.CreateVirtualSurface)
CreateVirtualSurface
CreateVirtualSurface method [DirectComposition]
CreateVirtualSurface method [DirectComposition]
IDCompositionSurfaceFactory interface
IDCompositionSurfaceFactory interface [DirectComposition]
CreateVirtualSurface method
IDCompositionSurfaceFactory.CreateVirtualSurface
IDCompositionSurfaceFactory::CreateVirtualSurface
dcomp/IDCompositionSurfaceFactory::CreateVirtualSurface
directcomp.idcompositionsurfacefactory_createvirtualsurface
directcomp\idcompositionsurfacefactory_createvirtualsurface.htm
directcomp
0C74CDA5-4491-4D16-B972-C9C54007A2FB
12/05/2018
CreateVirtualSurface, CreateVirtualSurface method [DirectComposition], CreateVirtualSurface method [DirectComposition],IDCompositionSurfaceFactory interface, IDCompositionSurfaceFactory interface [DirectComposition],CreateVirtualSurface method, IDCompositionSurfaceFactory.CreateVirtualSurface, IDCompositionSurfaceFactory::CreateVirtualSurface, dcomp/IDCompositionSurfaceFactory::CreateVirtualSurface, directcomp.idcompositionsurfacefactory_createvirtualsurface
dcomp.h
Windows
Windows 8.1 [desktop apps only]
Windows Server 2012 R2 [desktop apps only]
Dcomp.lib
Dcomp.dll
Windows
19H1
IDCompositionSurfaceFactory::CreateVirtualSurface
dcomp/IDCompositionSurfaceFactory::CreateVirtualSurface
c++
APIRef
kbSyntax
COM
Dcomp.dll
IDCompositionSurfaceFactory.CreateVirtualSurface

IDCompositionSurfaceFactory::CreateVirtualSurface

-description

Creates a sparsely populated surface that can be associated with one or more visuals for composition.

-parameters

-param initialWidth [in]

The width of the surface, in pixels. The maximum width is 16,777,216 pixels.

-param initialHeight [in]

The height of the surface, in pixels. The maximum height is 16,777,216 pixels.

-param pixelFormat [in]

The pixel format of the surface.

-param alphaMode [in]

The format of the alpha channel, if an alpha channel is included in the pixel format. This can be one of DXGI_ALPHA_MODE_PREMULTIPLIED or DXGI_ALPHA_MODE_IGNORE. It can also be DXGI_ALPHA_MODE_UNSPECIFIED, which is interpreted as DXGI_ALPHA_MODE_IGNORE.

-param virtualSurface [out]

The newly created virtual surface object. This parameter must not be NULL.

-returns

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

-remarks

A newly created virtual surface object is in an uninitialized state. While it is uninitialized, the surface has no effect on the composition of the visual tree. It behaves exactly like a surface that is initialized with 100% transparent pixels.

To initialize the surface with pixel data, use the IDCompositionSurface::BeginDraw method. This method not only provides pixels for the surface, but it also allocates actual storage space for those pixels. The memory allocation persists until the application returns some of the memory to the system. The application can free part or all of the allocated memory by calling the IDCompositionVirtualSurface::Trim or IDCompositionVirtualSurface::Resize method.

Microsoft DirectComposition surfaces support the following pixel formats:

  • DXGI_FORMAT_B8G8R8A8_UNORM
  • DXGI_FORMAT_R8G8B8A8_UNORM
  • DXGI_FORMAT_R16G16B16A16_FLOAT

-see-also

IDCompositionDevice2::CreateSurface

IDCompositionDevice2::CreateVirtualSurface

IDCompositionSurfaceFactory

IDCompositionSurfaceFactory::CreateVirtualSurface