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