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 /** Canvas Management (Canvas) */
19 /** */
20 /**************************************************************************/
21
22 #define GX_SOURCE_CODE
23
24
25 /* Include necessary system files. */
26
27 #include "gx_api.h"
28 #include "gx_canvas.h"
29
30
31 /* Bring in externs for caller checking code. */
32 GX_CALLER_CHECKING_EXTERNS
33
34 /**************************************************************************/
35 /* */
36 /* FUNCTION RELEASE */
37 /* */
38 /* _gxe_canvas_drawing_initiate PORTABLE C */
39 /* 6.1 */
40 /* AUTHOR */
41 /* */
42 /* Kenneth Maxwell, Microsoft Corporation */
43 /* */
44 /* DESCRIPTION */
45 /* */
46 /* This function checks for errors in the canvas drawing initiate */
47 /* function call. */
48 /* */
49 /* INPUT */
50 /* */
51 /* canvas Canvas control block */
52 /* who Widget control block pointer */
53 /* dirty_area Area to draw on */
54 /* */
55 /* OUTPUT */
56 /* */
57 /* status Completion status */
58 /* */
59 /* CALLS */
60 /* */
61 /* _gx_canvas_drawing_initiate Actual canvas drawing */
62 /* initiate call */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* Application Code */
67 /* */
68 /* RELEASE HISTORY */
69 /* */
70 /* DATE NAME DESCRIPTION */
71 /* */
72 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
73 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
74 /* resulting in version 6.1 */
75 /* */
76 /**************************************************************************/
_gxe_canvas_drawing_initiate(GX_CANVAS * canvas,GX_WIDGET * who,GX_RECTANGLE * dirty_area)77 UINT _gxe_canvas_drawing_initiate(GX_CANVAS *canvas, GX_WIDGET *who, GX_RECTANGLE *dirty_area)
78 {
79 UINT status;
80
81 /* Check for appropriate caller. */
82 GX_INIT_AND_THREADS_CALLER_CHECKING
83
84 /* Check for the invalid input pointers. */
85 if ((canvas == GX_NULL) ||
86 (dirty_area == GX_NULL))
87 {
88 return(GX_PTR_ERROR);
89 }
90
91 if (canvas -> gx_canvas_id != GX_CANVAS_ID)
92 {
93 return(GX_INVALID_CANVAS);
94 }
95
96 /* Call the actual canvas drawing initiate function. */
97 status = _gx_canvas_drawing_initiate(canvas, who, dirty_area);
98
99 /* Return completion status. */
100 return status;
101 }
102
103
