ID2D1CommandSink::PushAxisAlignedClip method (d2d1_1.h)

Pushes a clipping rectangle onto the clip and layer stack.

Syntax

HRESULT PushAxisAlignedClip(
  [in] const D2D1_RECT_F   *clipRect,
       D2D1_ANTIALIAS_MODE antialiasMode
);

Parameters

[in] clipRect

Type: const D2D1_RECT_F*

The rectangle that defines the clip.

antialiasMode

Type: D2D1_ANTIALIAS_MODE

The antialias mode for the clip.

Return value

Type: HRESULT

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

If the current world transform is not preserving the axis, clipRectangle is transformed and the bounds of the transformed rectangle are used instead.

Requirements

See also

ID2D1CommandList::Stream

ID2D1CommandSink

ID2D1RenderTarget::PushAxisAlignedClip