Edit

Share via

ICompositionDrawingSurfaceInterop::BeginDraw method (windows.ui.composition.interop.h)

  • Article

Initiates drawing on the surface.

Syntax

HRESULT BeginDraw(
  [in, optional] const RECT *updateRect,
  [in]           REFIID     iid,
  [out]          void       **updateObject,
  [out]          POINT      *updateOffset
);

Parameters

[in, optional] updateRect

Type: const RECT*

The section of the surface to update. The update rectangle must be within the boundaries of the surface. Specifying nullptr indicates the entire surface should be updated.

[in] iid

Type: REFIID

The identifier of the interface to retrieve.

[out] updateObject

Type: void**

Receives an interface pointer of the type specified in the iid parameter. This parameter must not be NULL.

[out] updateOffset

Type: POINT*

The offset into the surface where the application should draw updated content. This offset will reference the upper left corner of the update rectangle.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Requirement Value
Target Platform Windows
Header windows.ui.composition.interop.h

See also

ICompositionDrawingSurfaceInterop