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 /*    _gxe_animation_canvas_define                        PORTABLE C      */
39 /*                                                           6.1          */
40 /*  AUTHOR                                                                */
41 /*                                                                        */
42 /*    Kenneth Maxwell, Microsoft Corporation                              */
43 /*                                                                        */
44 /*  DESCRIPTION                                                           */
45 /*                                                                        */
46 /*    This function checks error in animation canvas define function.     */
47 /*                                                                        */
48 /*  INPUT                                                                 */
49 /*                                                                        */
50 /*    animation                             Animation control block       */
51 /*    canvas                                Pointer to animation canvas   */
52 /*                                                                        */
53 /*  OUTPUT                                                                */
54 /*                                                                        */
55 /*    status                                Completion status             */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _gx_animation_canvas_define           The actual animation canvas   */
60 /*                                            define function             */
61 /*                                                                        */
62 /*  CALLED BY                                                             */
63 /*                                                                        */
64 /*    Application Code                                                    */
65 /*                                                                        */
66 /*  RELEASE HISTORY                                                       */
67 /*                                                                        */
68 /*    DATE              NAME                      DESCRIPTION             */
69 /*                                                                        */
70 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
71 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
72 /*                                            resulting in version 6.1    */
73 /*                                                                        */
74 /**************************************************************************/
_gxe_animation_canvas_define(GX_ANIMATION * animation,GX_CANVAS * canvas)75 UINT  _gxe_animation_canvas_define(GX_ANIMATION *animation, GX_CANVAS *canvas)
76 {
77 UINT  status = GX_SUCCESS;
78 GX_DISPLAY *display;
79 ULONG required_size;
80 
81     if (animation == GX_NULL ||
82         canvas == GX_NULL)
83     {
84         return GX_PTR_ERROR;
85     }
86 
87     display = canvas -> gx_canvas_display;
88     if (display == GX_NULL)
89     {
90         return GX_PTR_ERROR;
91     }
92 
93     required_size = (ULONG)(display -> gx_display_driver_row_pitch_get((USHORT) canvas->gx_canvas_x_resolution));
94     required_size = required_size * (ULONG) canvas->gx_canvas_y_resolution;
95 
96     if (canvas ->gx_canvas_memory_size < required_size)
97     {
98         return GX_INVALID_MEMORY_SIZE;
99     }
100 
101     status = _gx_animation_canvas_define(animation, canvas);
102 
103     /* Return completion status code. */
104     return(status);
105 }
106 
107