Edit

Share via

ID2D1Bitmap::CopyFromRenderTarget method (d2d1.h)

  • Article

Copies the specified region from the specified render target into the current bitmap.

Syntax

HRESULT CopyFromRenderTarget(
  [in, optional] const D2D1_POINT_2U *destPoint,
  [in]           ID2D1RenderTarget   *renderTarget,
  [in, optional] const D2D1_RECT_U   *srcRect
);

Parameters

[in, optional] destPoint

Type: const D2D1_POINT_2U*

In the current bitmap, the upper-left corner of the area to which the region specified by srcRect is copied.

[in] renderTarget

Type: ID2D1RenderTarget*

The render target that contains the region to copy.

[in, optional] srcRect

Type: const D2D1_RECT_U*

The area of renderTarget to copy.

Return value

Type: HRESULT

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

Remarks

This method does not update the size of the current bitmap. If the contents of the source bitmap do not fit in the current bitmap, this method fails. Also, note that this method does not perform format conversion, and will fail if the bitmap formats do not match.

Calling this method may cause the current batch to flush if the bitmap is active in the batch. If the batch that was flushed does not complete successfully, this method fails. However, this method does not clear the error state of the render target on which the batch was flushed. The failing HRESULT and tag state will be returned at the next call to EndDraw or Flush.

All clips and layers must be popped off of the render target before calling this method. The method returns D2DERR_RENDER_TARGET_HAS_LAYER_OR_CLIPRECT if any clips or layers are currently applied to the render target.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header d2d1.h
Library D2d1.lib
DLL D2d1.dll

See also

ID2D1Bitmap