IDCompositionSurface::SuspendDraw method

Suspends the drawing on this Microsoft DirectComposition surface object.

Syntax

HRESULT SuspendDraw(

);

Parameters

This method has no parameters.

Return Value

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code, which can include DCOMPOSITION_ERROR_SURFACE_BEING_RENDERED and DCOMPOSITION_ERROR_SURFACE_NOT_BEING_RENDERED.

Remarks

Because only one surface can be open for drawing at a time, calling SuspendDraw allows the user to call IDCompositionSurface::BeginDraw on a different surface. Drawing to this surface can be resumed by calling IDCompositionSurface::ResumeDraw.

Requirements

   
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header dcomp.h
Library Dcomp.lib
DLL Dcomp.dll

See Also

IDCompositionSurface

IDCompositionSurface::ResumeDraw