IDCompositionDevice::CreateRectangleClip method (dcomp.h)

Article
02/22/2024

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 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

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	dcomp.h
Library	Dcomp.lib
DLL	Dcomp.dll