IDCompositionRectangleClip::SetTop method

Changes the value of the Top property of a clip rectangle. The Top property specifies the y-coordinate of the upper-left corner of the clip rectangle.

Syntax

HRESULT SetTop(
  float top
);

Parameters

top

Type: float

The new value of the Top property, in pixels. This parameter has a numerical limit of -2^21 to 2^21. The API accepts numbers outside of this range, but they are always clamped to this range.

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

This method fails if the top parameter is NaN, positive infinity, or negative infinity.

If the Top property was previously animated, this method removes the animation and sets the Top property to the specified static value.

Requirements

   
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

See Also

IDCompositionRectangleClip