IDCompositionRotateTransform3D::SetAxisX(IDCompositionAnimation*) method

Animates the value of the AxisX property of a 3D rotation transform. The AxisX property specifies the x-coordinate for the axis vector of rotation. The default value is zero.

Syntax


HRESULT SetAxisX(
  [in]  IDCompositionAnimation *animation
);

Parameters

animation [in]

Type: IDCompositionAnimation*

An animation object that determines how the value of the AxisX 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

When setting the axis to a non-default value, you should always set all three axis properties (AxisX, AxisY, and AxisZ).

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 AxisX property unless this method is called again. If the AxisX 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 3D transform. 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

IDCompositionRotateTransform3D
IDCompositionRotateTransform3D::SetAxisY
IDCompositionRotateTransform3D::SetAxisZ

 

 

Community Additions

ADD
Show:
© 2014 Microsoft