ISurfaceImageSourceNativeWithD2D::BeginDraw method (windows.ui.xaml.media.dxinterop.h)

Initiates an update to the associated SurfaceImageSource or VirtualSurfaceImageSource.

Syntax

HRESULT BeginDraw(
  [in]  REFRECT updateRect,
  [in]  REFIID  iid,
  [out] void    **updateObject,
  [out] POINT   *offset
);

Parameters

[in] updateRect

The region of the surface that will be drawn into.

[in] iid

IID used to lookup the object for drawing.

[out] updateObject

Receives a COM pointer to the drawing object. Based on iid, this may be either an IDXGISurface, when not using batched drawing, or a shared ID2D1DeviceContext, when using batched Direct2D drawing to improve performance when updating Direct2D content across multiple surfaces.

[out] offset

Receives the point (x,y) offset of the surface that will be drawn into.

Return value

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

Requirements

Requirement	Value
Minimum supported client	Windows 8.1 [desktop apps | UWP apps]
Minimum supported server	Windows Server 2012 R2 [desktop apps | UWP apps]
Target Platform	Windows
Header	windows.ui.xaml.media.dxinterop.h
DLL	Windows.UI.Xaml.dll

See also

DirectX and XAML interop

ISurfaceImageSourceNativeWithD2D

SurfaceImageSource

VirtualSurfaceImageSource