ID2D1RenderTarget::Flush method (Windows)

Switch View :
ScriptFree
ID2D1RenderTarget::Flush method

Applies to: desktop apps | Metro style apps

Executes all pending drawing commands.

Syntax

virtual HRESULT Flush(
  [out, optional]  D2D1_TAG *tag1 = NULL,
  [out, optional]  D2D1_TAG *tag2 = NULL
) = 0;

Parameters

tag1 [out, optional]

Type: D2D1_TAG*

When this method returns, contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized.

tag2 [out, optional]

Type: D2D1_TAG*

When this method returns, contains the tag for drawing operations that caused errors or 0 if there were no errors. This parameter is passed uninitialized.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code and sets tag1 and tag2 to the tags that were active when the error occurred. If no error occurred, this method sets the error tag state to be (0,0).

Remarks

This command does not flush the device that is associated with the render target.

Calling this method resets the error state of the render target.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008

Header

D2d1.h

Library

D2d1.lib

DLL

D2d1.dll

See also

ID2D1RenderTarget

 

 

Send comments about this topic to Microsoft

Build date: 3/7/2012