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 /* */
37 /* FUNCTION RELEASE */
38 /* */
39 /* _gxe_canvas_drawing_complete PORTABLE C */
40 /* 6.1 */
41 /* AUTHOR */
42 /* */
43 /* Kenneth Maxwell, Microsoft Corporation */
44 /* */
45 /* DESCRIPTION */
46 /* */
47 /* This function checks for errors in the canvas drawing complete */
48 /* function call. */
49 /* */
50 /* INPUT */
51 /* */
52 /* canvas Canvas control block */
53 /* flush If GX_TRUE, the content of */
54 /* the canvas is flushed to */
55 /* the display */
56 /* */
57 /* OUTPUT */
58 /* */
59 /* status Completion status */
60 /* */
61 /* CALLS */
62 /* */
63 /* _gx_canvas_drawing_complete Actual canvas drawing */
64 /* complete call */
65 /* */
66 /* CALLED BY */
67 /* */
68 /* Application Code */
69 /* */
70 /* RELEASE HISTORY */
71 /* */
72 /* DATE NAME DESCRIPTION */
73 /* */
74 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
75 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
76 /* resulting in version 6.1 */
77 /* */
78 /**************************************************************************/
_gxe_canvas_drawing_complete(GX_CANVAS * canvas,GX_BOOL flush)79 UINT _gxe_canvas_drawing_complete(GX_CANVAS *canvas, GX_BOOL flush)
80 {
81 UINT status;
82
83 /* Check for appropriate caller. */
84 GX_INIT_AND_THREADS_CALLER_CHECKING
85
86 /* Checks for the invalid input pointers. */
87 if ((canvas == GX_NULL) ||
88 (canvas -> gx_canvas_display == GX_NULL) ||
89 (canvas -> gx_canvas_memory == GX_NULL))
90 {
91 return(GX_PTR_ERROR);
92 }
93
94 /* Call the actual canvas drawing complete function. */
95 status = _gx_canvas_drawing_complete(canvas, flush);
96
97 /* Return completion status. */
98 return status;
99 }
100
101
