IDCompositionTranslateTransform::SetOffsetY method

Animates the value of the OffsetY property of a 2D translation transform. The OffsetY property specifies the translation along the y-axis.

Syntax

HRESULT SetOffsetY(
  IDCompositionAnimation *animation
);

Parameters

animation

Type: IDCompositionAnimation*

An animation object that determines how the value of the OffsetY 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 OffsetY property unless this method is called again. If the OffsetY 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]
Target Platform Windows
Header dcomp.h
Library Dcomp.lib
DLL Dcomp.dll

See Also

IDCompositionTranslateTransform

IDCompositionTranslateTransform::SetOffsetX