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_widget.h"
28 #include "gx_utility.h"
29 #include "gx_window.h"
30 #include "gx_canvas.h"
31 #include "gx_animation.h"
32
33
34 /**************************************************************************/
35 /* */
36 /* FUNCTION RELEASE */
37 /* */
38 /* _gx_animation_canvas_define PORTABLE C */
39 /* 6.1 */
40 /* AUTHOR */
41 /* */
42 /* Kenneth Maxwell, Microsoft Corporation */
43 /* */
44 /* DESCRIPTION */
45 /* */
46 /* This function defines canvas for animation manager to use. */
47 /* */
48 /* INPUT */
49 /* */
50 /* animation Animation control block */
51 /* canvas Memory canvas used to */
52 /* implement the translation */
53 /* animation */
54 /* */
55 /* OUTPUT */
56 /* */
57 /* status Completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* None */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* Application Code */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
72 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
73 /* resulting in version 6.1 */
74 /* */
75 /**************************************************************************/
_gx_animation_canvas_define(GX_ANIMATION * animation,GX_CANVAS * canvas)76 UINT _gx_animation_canvas_define(GX_ANIMATION *animation, GX_CANVAS *canvas)
77 {
78 if (animation -> gx_animation_status != GX_ANIMATION_IDLE)
79 {
80 return(GX_INVALID_STATUS);
81 }
82
83 animation -> gx_animation_canvas = canvas;
84
85 /* Return completion status code. */
86 return(GX_SUCCESS);
87 }
88
89