IDCompositionRectangleClip::SetTopLeftRadiusY(IDCompositionAnimation*) method (dcomp.h)

Animates the value of the TopLeftRadiusY property of this clip. The TopLeftRadiusY property specifies the y radius of the ellipse that rounds the top-left corner of the clip.

Syntax

HRESULT SetTopLeftRadiusY(
  [in] IDCompositionAnimation *animation
);

Parameters

[in] animation

Type: IDCompositionAnimation*

An animation object that determines how the value of the y radius changes over time. 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

This method makes a copy of the specified animation. If the object referenced by the animation parameter is changed after calling this method, the change does not affect the y radius unless this method is called again. If the y radius was previously animated, calling this method replaces the previous animation with the new animation.

This method fails if animation is an invalid pointer or if it was not created by the same IDCompositionDevice interface as the affected visual. The interface cannot be a custom implementation; only interfaces created by Microsoft DirectComposition can be used with this method.

Requirements

See also

IDCompositionRectangleClip