IDCompositionDevice::CreateRectangleClip method (dcomp.h)

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

[out] clip

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 value of -2^21 for the left and top properties, and a value of 2^21 for the right and bottom properties, effectively making it a no-op clip object.

Requirements

See also

IDCompositionDevice

IDCompositionVisual::SetClip