IDCompositionRectangleClip::SetLeft(IDCompositionAnimation*) method

Animates the value of the Left property of a clip rectangle. The Left property specifies the x-coordinate of the upper-left corner of the clip rectangle.

Syntax


HRESULT SetLeft (
  [in]  IDCompositionAnimation *animation
);

Parameters

animation [in]

Type: IDCompositionAnimation*

An animation object that determines how the value of the Left property 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 Left property unless this method is called again. If the Left property 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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Dcomp.h

Library

Dcomp.lib

DLL

Dcomp.dll

See also

IDCompositionRectangleClip

 

 

Community Additions

ADD
Show:
© 2014 Microsoft