IDCompositionRectangleClip::SetBottom(float) method (dcomp.h)

Article
02/22/2024

Changes the value of the Bottom property of a clip object. The Bottom property specifies the y-coordinate of the lower-right corner of the clip rectangle.

Syntax

HRESULT SetBottom(
  [in] float bottom
);

Parameters

[in] bottom

Type: float

The new value of the Bottom 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 bottom parameter is NaN, positive infinity, or negative infinity.

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

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