IDCompositionDevice::CreateRectangleClip method

Creates a clip object that can be used to restrict the rendering of a visual subtree to a rectangular area.

Syntax


HRESULT CreateRectangleClip(
  [out]  IDCompositionRectangleClip **clip
);

Parameters

clip [out]

Type: IDCompositionRectangleClip**

The new clip object. This parameter must not be NULL.

Return value

Type: HRESULT

If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. See DirectComposition Error Codes for a list of error codes.

Remarks

A newly created clip object has a static value of –FLT_MAX for the left and top properties, and a static value of –FLT_MAX for the right and bottom properties, effectively making it a no-op clip object.

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Dcomp.h

Library

Dcomp.lib

DLL

Dcomp.dll

See also

IDCompositionDevice
IDCompositionVisual::SetClip

 

 

Community Additions

ADD
Show:
© 2014 Microsoft