1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** GUIX Component */
17 /** */
18 /** Animation Management (Animation) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_animation.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _gxe_animation_landing_speed_set PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Kenneth Maxwell, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function checks for error in animation landing speed set call. */
44 /* */
45 /* */
46 /* INPUT */
47 /* */
48 /* animation Pointer to animation control */
49 /* block */
50 /* shift_per_step Shift distance for each step */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* status Completion status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _gx_animation_landing_speed_set Actual animation landing */
59 /* speed set call. */
60 /* */
61 /* CALLED BY */
62 /* */
63 /* Application Code */
64 /* */
65 /* RELEASE HISTORY */
66 /* */
67 /* DATE NAME DESCRIPTION */
68 /* */
69 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
70 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
71 /* resulting in version 6.1 */
72 /* */
73 /**************************************************************************/
_gxe_animation_landing_speed_set(GX_ANIMATION * animation,USHORT shift_per_step)74 UINT _gxe_animation_landing_speed_set(GX_ANIMATION *animation, USHORT shift_per_step)
75 {
76 /* Check for invalid input pointers. */
77 if (animation == GX_NULL)
78 {
79 return(GX_PTR_ERROR);
80 }
81
82 if (shift_per_step == 0)
83 {
84 return GX_INVALID_VALUE;
85 }
86
87 return _gx_animation_landing_speed_set(animation, shift_per_step);
88 }
89
90
