IDCompositionSurface::EndDraw method

Marks the end of drawing on this Microsoft DirectComposition surface object.

Syntax

HRESULT EndDraw(

);

Parameters

This method has no parameters.

Return Value

Type: HRESULT

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

Remarks

This method completes an update that was begun by a previous call to the IDCompositionSurface::BeginDraw method. After this method returns, the application can start another update on the same surface object or on a different one.

If the application calls IDCompositionDevice2::Commit before calling IDCompositionSurface::EndDraw for a surface with a pending update, that update is not processed by that Commit call. The update only takes effect on screen after the application calls IDCompositionSurface::EndDraw followed by the IDCompositionDevice2::Commit method.

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::BeginDraw

IDCompositionSurface::EndDraw