NNS_G2dSetMCAnimationCurrentFrame

Syntax

#include <nnsys/g2d/g2d_MultiCellAnimation.h>


void NNS_G2dSetMCAnimationCurrentFrame
( 
    NNSG2dMultiCellAnimation*   pMultiCellAnim, 
    u16                         frameIndex 
);

Arguments

`pMultiCellAnim`	[OUT] Multicell animation
`frameIndex`	[IN] Animation frame number

Return Values

None.

Description

Sets the play animation frame of the multicell animation. No action will occur if an invalid index is specified.

Note: If a STOP-method animation sequence plays to the end, the animation controller is set to the Stop state.
Because of this, you will need to call the NNS_G2dStartAnimCtrl function for the animation controller of that multicell animation to update the animation again.
To get the animation controller of that multicell animation, use the NNS_G2dGetMCAnimAnimCtrl function.

The NNS_G2dStartMCCellAnimationAll function is available for calling the NNS_G2dStartAnimCtrl function for all of the cell animations that make up the multicell animation.

To restart the animation from the beginning, use the NNS_G2dRestartMCAnimation function.

Revision History

2006/05/29 Added a note.
2004/05/28 Initial version.