ID2D1CommandSink::PushAxisAlignedClip method

Pushes a clipping rectangle onto the clip and layer stack.

Syntax


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

Parameters

clipRect [in]

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

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1_1.h

DLL

D2d1.dll

See also

ID2D1CommandSink
ID2D1CommandList::Stream
ID2D1RenderTarget::PushAxisAlignedClip

 

 

Community Additions

ADD
Show:
© 2014 Microsoft