Module native_animate

Available on crate feature api-12 only.

Structs

• ArkUI_AnimateCompleteCallback
  Defines the callback type for when the animation playback is complete.
• ArkUI_AnimateOption
• ArkUI_Animator
• ArkUI_AnimatorEvent
• ArkUI_AnimatorOnFrameEvent
• ArkUI_AnimatorOption
• ArkUI_Curve
• ArkUI_ExpectedFrameRateRange
  Defines the expected frame rate range of the animation.
• ArkUI_KeyframeAnimateOption
• ArkUI_NativeAnimateAPI_1
  Implements the native animation APIs provided by ArkUI.
• ArkUI_TransitionEffect

Functions

• OH_ArkUI_AnimateOption_Create^⚠
  Creates an animation configuration.
• OH_ArkUI_AnimateOption_Dispose^⚠
  Disposes of an animation configuration.
• OH_ArkUI_AnimateOption_GetCurve^⚠
  Obtains the animation curve.
• OH_ArkUI_AnimateOption_GetDelay^⚠
  Obtains the animation delay, in milliseconds.
• OH_ArkUI_AnimateOption_GetDuration^⚠
  Obtains the animation duration, in milliseconds.
• OH_ArkUI_AnimateOption_GetExpectedFrameRateRange^⚠
  Obtains the expected frame rate range of an animation.
• OH_ArkUI_AnimateOption_GetICurve^⚠
  Obtains the animation curve of the animation of an animator.
• OH_ArkUI_AnimateOption_GetIterations^⚠
  Obtains the number of times that an animation is played.
• OH_ArkUI_AnimateOption_GetPlayMode^⚠
  Obtains the animation playback mode.
• OH_ArkUI_AnimateOption_GetTempo^⚠
  Obtains the animation playback speed.
• OH_ArkUI_AnimateOption_SetCurve^⚠
  Sets the animation curve.
• OH_ArkUI_AnimateOption_SetDelay^⚠
  Sets the animation delay.
• OH_ArkUI_AnimateOption_SetDuration^⚠
  Sets the animation duration.
• OH_ArkUI_AnimateOption_SetExpectedFrameRateRange^⚠
  Sets the expected frame rate range of an animation.
• OH_ArkUI_AnimateOption_SetICurve^⚠
  Sets the animation curve for the animation of an animator.
• OH_ArkUI_AnimateOption_SetIterations^⚠
  Sets the number of times that an animation is played.
• OH_ArkUI_AnimateOption_SetPlayMode^⚠
  Sets the animation playback mode.
• OH_ArkUI_AnimateOption_SetTempo^⚠
  Sets the animation playback speed.
• OH_ArkUI_AnimatorEvent_GetUserData^⚠
  Obtains the custom object in an animation event object.
• OH_ArkUI_AnimatorOnFrameEvent_GetUserData^⚠
  Obtains the custom object in an animation event object.
• OH_ArkUI_AnimatorOnFrameEvent_GetValue^⚠
  Obtains the current progress in an animation event object.
• OH_ArkUI_AnimatorOption_Create^⚠
  Creates an animator parameter object.
• OH_ArkUI_AnimatorOption_Dispose^⚠
  Disposes of an animator parameter object.
• OH_ArkUI_AnimatorOption_GetBegin^⚠
  Obtains the interpolation start point of an animation.
• OH_ArkUI_AnimatorOption_GetCurve^⚠
  Obtains the interpolation curve of the animation of an animator.
• OH_ArkUI_AnimatorOption_GetDelay^⚠
  Obtains the delay for playing the animation of an animator.
• OH_ArkUI_AnimatorOption_GetDirection^⚠
  Obtains the playback direction of an animation.
• OH_ArkUI_AnimatorOption_GetDuration^⚠
  Obtains the duration for playing an animation.
• OH_ArkUI_AnimatorOption_GetEnd^⚠
  Obtains the interpolation end point of an animation.
• OH_ArkUI_AnimatorOption_GetExpectedFrameRateRange^⚠
  Obtains the expected frame rate range of an animation.
• OH_ArkUI_AnimatorOption_GetFill^⚠
  Obtains whether the animator animation is restored to the initial state after being executed.
• OH_ArkUI_AnimatorOption_GetIterations^⚠
  Obtains the number of times that an animation is played.
• OH_ArkUI_AnimatorOption_GetKeyframeCurve^⚠
  Obtains the interpolation curve for a keyframe in the animation of an animator.
• OH_ArkUI_AnimatorOption_GetKeyframeTime^⚠
  Obtains the keyframe time of an animation.
• OH_ArkUI_AnimatorOption_GetKeyframeValue^⚠
  Obtains the keyframe value of an animation.
• OH_ArkUI_AnimatorOption_RegisterOnCancelCallback^⚠
  Sets the callback invoked when the animation playback is canceled.
• OH_ArkUI_AnimatorOption_RegisterOnFinishCallback^⚠
  Sets the callback invoked when the animation playback is complete.
• OH_ArkUI_AnimatorOption_RegisterOnFrameCallback^⚠
  Sets the callback invoked when the animator receives a frame.
• OH_ArkUI_AnimatorOption_RegisterOnRepeatCallback^⚠
  Sets the callback invoked when the animation playback is repeated.
• OH_ArkUI_AnimatorOption_SetBegin^⚠
  Sets the interpolation start point for the animation of an animator.
• OH_ArkUI_AnimatorOption_SetCurve^⚠
  Sets the interpolation curve for the animation of an animator.
• OH_ArkUI_AnimatorOption_SetDelay^⚠
  Sets the delay for playing the animation of an animator, in milliseconds.
• OH_ArkUI_AnimatorOption_SetDirection^⚠
  Sets the playback direction for the animation of an animator.
• OH_ArkUI_AnimatorOption_SetDuration^⚠
  Sets the duration for thea nimation of an animator, in milliseconds.
• OH_ArkUI_AnimatorOption_SetEnd^⚠
  Sets the interpolation end point for the animation of an animator.
• OH_ArkUI_AnimatorOption_SetExpectedFrameRateRange^⚠
  Sets the expected frame rate range for the animation of an animator.
• OH_ArkUI_AnimatorOption_SetFill^⚠
  Sets whether the animation of an animator is restored to the initial state after being executed.
• OH_ArkUI_AnimatorOption_SetIterations^⚠
  Sets the number of times that the animation of an animator is played. The value 0 means not to play the animation, and -1 means to play the animation for an unlimited number of times.
• OH_ArkUI_AnimatorOption_SetKeyframe^⚠
  Sets the keyframe parameters for the animation of an animator.
• OH_ArkUI_AnimatorOption_SetKeyframeCurve^⚠
  Sets the keyframe curve type for the animation of an animator.
• OH_ArkUI_Animator_Cancel^⚠
  Cancels the animation of an animator.
• OH_ArkUI_Animator_Finish^⚠
  Ends the animation of an animator.
• OH_ArkUI_Animator_Pause^⚠
  Pauses the animation of an animator.
• OH_ArkUI_Animator_Play^⚠
  Starts the animation of an animator.
• OH_ArkUI_Animator_ResetAnimatorOption^⚠
  Resets the animation of an animator.
• OH_ArkUI_Animator_Reverse^⚠
  Plays the animation of an animator in reverse order.
• OH_ArkUI_CreateAsymmetricTransitionEffect^⚠
  Creates an asymmetric transition effect.
• OH_ArkUI_CreateMovementTransitionEffect^⚠
  Creates a movement object for component transition.
• OH_ArkUI_CreateOpacityTransitionEffect^⚠
  Creates an opacity object for component transition.
• OH_ArkUI_CreateRotationTransitionEffect^⚠
  Creates a rotation object for component transition.
• OH_ArkUI_CreateScaleTransitionEffect^⚠
  Creates a scaling object for component transition.
• OH_ArkUI_CreateTranslationTransitionEffect^⚠
  Creates a translation object for component transition.
• OH_ArkUI_Curve_CreateCubicBezierCurve^⚠
  Creates a cubic Bezier curve.
• OH_ArkUI_Curve_CreateCurveByType^⚠
  Implements initialization for the interpolation curve, which is used to create an interpolation curve based on the input parameter.
• OH_ArkUI_Curve_CreateCustomCurve^⚠
  Creates a custom curve.
• OH_ArkUI_Curve_CreateInterpolatingSpring^⚠
  Creates an interpolating spring curve animated from 0 to 1. The actual animation value is calculated based on the curve.
• OH_ArkUI_Curve_CreateResponsiveSpringMotion^⚠
  Creates a responsive spring animation curve. It is a special case of springMotion, with the only difference in the default values. It can be used together with springMotion.
• OH_ArkUI_Curve_CreateSpringCurve^⚠
  Creates a spring curve. The curve shape is subject to the spring parameters, and the animation duration is subject to the duration parameter in animation and animateTo.
• OH_ArkUI_Curve_CreateSpringMotion^⚠
  Creates a spring animation curve. If multiple spring animations are applied to the same attribute of an object, each animation replaces their predecessor and inherits the velocity.
• OH_ArkUI_Curve_CreateStepsCurve^⚠
  Creates a step curve.
• OH_ArkUI_Curve_DisposeCurve^⚠
  Disposes of a custom curve.
• OH_ArkUI_KeyframeAnimateOption_Create^⚠
  Obtains the keyframe animation parameters.
• OH_ArkUI_KeyframeAnimateOption_Dispose^⚠
  Disposes of the keyframe animation parameter object.
• OH_ArkUI_KeyframeAnimateOption_GetCurve^⚠
  Obtains the animation curve of a specific state in a keyframe animation.
• OH_ArkUI_KeyframeAnimateOption_GetDelay^⚠
  Obtains the overall delay of a keyframe animation
• OH_ArkUI_KeyframeAnimateOption_GetDuration^⚠
  Obtains the duration of a specific state in a keyframe animation.
• OH_ArkUI_KeyframeAnimateOption_GetIterations^⚠
  Obtains the number of times that a keyframe animation is played.
• OH_ArkUI_KeyframeAnimateOption_RegisterOnEventCallback^⚠
  Sets the closure function of the state at the time of the keyframe, that is, the state to be reached at the time of the keyframe.
• OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback^⚠
  Sets the callback invoked when the keyframe animation playback is complete. This API is called after the keyframe animation has played for the specified number of times.
• OH_ArkUI_KeyframeAnimateOption_SetCurve^⚠
  Sets the animation curve for a specific keyframe in a keyframe animation.
• OH_ArkUI_KeyframeAnimateOption_SetDelay^⚠
  Sets the overall delay of a keyframe animation, in milliseconds. By default, the keyframe animation is played without delay.
• OH_ArkUI_KeyframeAnimateOption_SetDuration^⚠
  Sets the duration of a keyframe animation, in milliseconds.
• OH_ArkUI_KeyframeAnimateOption_SetIterations^⚠
  Sets the number of times that the keyframe animation is played. By default, the animation is played once. The value -1 indicates that the animation is played for an unlimited number of times. The value 0 indicates that there is no animation.
• OH_ArkUI_TransitionEffect_Combine^⚠
  Sets a combination of transition effects.
• OH_ArkUI_TransitionEffect_Dispose^⚠
  Disposes of a transition effect.
• OH_ArkUI_TransitionEffect_SetAnimation^⚠
  Sets transition effect animation settings.

Type Aliases

• ArkUI_AnimatorHandle
  Defines the pointer to an animator object.
• ArkUI_CurveHandle
  Defines the pointer to an interpolation curve.