ID2D1RenderTarget::PushAxisAlignedClip method

Specifies a rectangle to which all subsequent drawing operations are clipped.

Overload list

Method Description
PushAxisAlignedClip(D2D1_RECT_F&,D2D1_ANTIALIAS_MODE) Specifies a rectangle to which all subsequent drawing operations are clipped.
PushAxisAlignedClip(D2D1_RECT_F*,D2D1_ANTIALIAS_MODE) Specifies a rectangle to which all subsequent drawing operations are clipped.

Syntax

void PushAxisAlignedClip(
  const D2D1_RECT_F   *clipRect,
  D2D1_ANTIALIAS_MODE antialiasMode
);

Parameters

clipRect

antialiasMode

Return Value

None

Remarks

A PushAxisAlignedClip and PopAxisAlignedClip pair can occur around or within a PushLayer and PopLayer, but cannot overlap. For example, the sequence of PushAxisAlignedClip, PushLayer, PopLayer, PopAxisAlignedClip is valid, but the sequence of PushAxisAlignedClip, PushLayer, PopAxisAlignedClip, PopLayer is invalid.

This method doesn't return an error code if it fails. To determine whether a drawing operation (such as PushAxisAlignedClip) failed, check the result returned by the ID2D1RenderTarget::EndDraw or ID2D1RenderTarget::Flush methods.

Examples

For an example, see the How to Clip with an Axis-Aligned Clip Rectangle.

Requirements

   
Target Platform Windows
Header d2d1.h (include D2d1.h)
Library D2d1.lib
DLL D2d1.dll

See Also

ID2D1RenderTarget